A TransferReader performs, manages, handles results of, transfers done when reading a file (i.e. from entities of an InterfaceModel, to objects for Imagine) More...

#include <XSControl_TransferReader.hxx>

Inheritance diagram for XSControl_TransferReader:

[legend]

Public Member Functions
	XSControl_TransferReader ()=default
	Creates a TransferReader, empty.

void	SetController (const occ::handle< XSControl_Controller > &theControl)
	Sets a Controller. It is required to generate the Actor. Elsewhere, the Actor must be provided directly.

void	SetActor (const occ::handle< Transfer_ActorOfTransientProcess > &theActor)
	Sets the Actor directly : this value will be used if the Controller is not set.

occ::handle< Transfer_ActorOfTransientProcess >	Actor ()
	Returns the Actor, determined by the Controller, or if this one is unknown, directly set. Once it has been defined, it can then be edited.

void	SetModel (const occ::handle< Interface_InterfaceModel > &theModel)
	Sets an InterfaceModel. This causes former results, computed from another one, to be lost (see also Clear)

void	SetGraph (const occ::handle< Interface_HGraph > &theGraph)
	Sets a Graph and its InterfaceModel (calls SetModel)

const occ::handle< Interface_InterfaceModel > &	Model () const
	Returns the currently set InterfaceModel.

void	SetContext (const char *const theName, const occ::handle< Standard_Transient > &theCtx)
	Sets a Context : according to receiving appli, to be interpreted by the Actor.

bool	GetContext (const char *const theName, const occ::handle< Standard_Type > &theType, occ::handle< Standard_Transient > &theCtx) const
	Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context.

NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > &	Context ()
	Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once)

void	SetFileName (const char *const theName)
	Sets a new value for (loaded) file name.

const char *	FileName () const
	Returns actual value of file name.

void	Clear (const int theMode)
	Clears data, according mode : -1 all 0 nothing done +1 final results +2 working data (model, context, transfer process)

const occ::handle< Transfer_TransientProcess > &	TransientProcess () const
	Returns the currently used TransientProcess It is computed from the model by TransferReadRoots, or by BeginTransferRead.

void	SetTransientProcess (const occ::handle< Transfer_TransientProcess > &theTP)
	Forces the TransientProcess Remark : it also changes the Model and the Actor, from those recorded in the new TransientProcess.

bool	RecordResult (const occ::handle< Standard_Transient > &theEnt)
	Records a final result of transferring an entity This result is recorded as a ResultFromModel, taken from the TransientProcess Returns True if a result is available, False else.

bool	IsRecorded (const occ::handle< Standard_Transient > &theEnt) const
	Returns True if a final result is recorded for an entity Remark that it can bring no effective result if transfer has completely failed (FinalResult brings only fail messages ...)

bool	HasResult (const occ::handle< Standard_Transient > &theEnt) const
	Returns True if a final result is recorded AND BRINGS AN EFFECTIVE RESULT (else, it brings only fail messages)

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	RecordedList () const
	Returns the list of entities to which a final result is attached (i.e. processed by RecordResult)

bool	Skip (const occ::handle< Standard_Transient > &theEnt)
	Note that an entity has been required for transfer but no result at all is available (typically : case not implemented) It is not an error, but it gives a specific status : Skipped Returns True if done, False if <ent> is not in starting model.

bool	IsSkipped (const occ::handle< Standard_Transient > &theEnt) const
	Returns True if an entity is noted as skipped.

bool	IsMarked (const occ::handle< Standard_Transient > &theEnt) const
	Returns True if an entity has been asked for transfert, hence it is marked, as : Recorded (a computation has ran, with or without an effective result), or Skipped (case ignored)

occ::handle< Transfer_ResultFromModel >	FinalResult (const occ::handle< Standard_Transient > &theEnt) const
	Returns the final result recorded for an entity, as such.

const char *	FinalEntityLabel (const occ::handle< Standard_Transient > &theEnt) const
	Returns the label attached to an entity recorded for final, or an empty string if not recorded.

int	FinalEntityNumber (const occ::handle< Standard_Transient > &theEnt) const
	Returns the number attached to the entity recorded for final, or zero if not recorded (looks in the ResultFromModel)

occ::handle< Transfer_ResultFromModel >	ResultFromNumber (const int theNum) const
	Returns the final result recorded for a NUMBER of entity (internal use). Null if out of range.

occ::handle< Standard_Transient >	TransientResult (const occ::handle< Standard_Transient > &theEnt) const
	Returns the resulting object as a Transient Null Handle if no result or result not transient.

TopoDS_Shape	ShapeResult (const occ::handle< Standard_Transient > &theEnt) const
	Returns the resulting object as a Shape Null Shape if no result or result not a shape.

bool	ClearResult (const occ::handle< Standard_Transient > &theEnt, const int theMode)
	Clears recorded result for an entity, according mode <mode> = -1 : true, complete, clearing (erasing result) <mode> >= 0 : simple "stripping", see ResultFromModel, in particular, 0 for simple internal strip, 10 for all but final result, 11 for all : just label, status and filename are kept Returns True when done, False if nothing was to clear.

occ::handle< Standard_Transient >	EntityFromResult (const occ::handle< Standard_Transient > &theRes, const int theMode=0) const
	Returns an entity from which a given result was produced. If <mode> = 0 (D), searches in last root transfers If <mode> = 1, searches in last (root & sub) transfers If <mode> = 2, searches in root recorded results If <mode> = 3, searches in all (root & sub) recordeds <res> can be, either a transient object (result itself) or a binder. For a binder of shape, calls EntityFromShapeResult Returns a Null Handle if <res> not recorded.

occ::handle< Standard_Transient >	EntityFromShapeResult (const TopoDS_Shape &theRes, const int theMode=0) const
	Returns an entity from which a given shape result was produced Returns a Null Handle if <res> not recorded or not a Shape.

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	EntitiesFromShapeList (const occ::handle< NCollection_HSequence< TopoDS_Shape > > &theRes, const int theMode=0) const
	Returns the list of entities from which some shapes were produced : it corresponds to a loop on EntityFromShapeResult, but is optimised.

Interface_CheckIterator	CheckList (const occ::handle< Standard_Transient > &theEnt, const int theLevel=0) const
	Returns the CheckList resulting from transferring <ent>, i.e. stored in its recorded form ResultFromModel (empty if transfer successful or not recorded ...)

bool	HasChecks (const occ::handle< Standard_Transient > &theEnt, const bool FailsOnly) const
	Returns True if an entity (with a final result) has checks :

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	CheckedList (const occ::handle< Standard_Transient > &theEnt, const Interface_CheckStatus WithCheck=Interface_CheckAny, const bool theResult=true) const
	Returns the list of starting entities to which a given check status is attached, IN FINAL RESULTS <ent> can be an entity, or the model to query all entities Below, "entities" are, either <ent> plus its sub-transferred, or all the entities of the model.

bool	BeginTransfer ()
	Defines a new TransferProcess for reading transfer Returns True if done, False if data are not properly defined (the Model, the Actor for Read)

bool	Recognize (const occ::handle< Standard_Transient > &theEnt)
	Tells if an entity is recognized as a valid candidate for Transfer. Calls method Recognize from the Actor (if known)

int	TransferOne (const occ::handle< Standard_Transient > &theEnt, const bool theRec=true, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Commands the transfer on reading for an entity to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the result is recorded by RecordResult.

int	TransferList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &theList, const bool theRec=true, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Commands the transfer on reading for a list of entities to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the results are recorded by RecordResult.

int	TransferRoots (const Interface_Graph &theGraph, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers the content of the current Interface Model to data handled by Imagine, starting from its Roots (determined by the Graph <G>), using the selected Actor for Read Returns the count of performed root transfers (i.e. 0 if none) or -1 if no actor is defined.

void	TransferClear (const occ::handle< Standard_Transient > &theEnt, const int theLevel=0)
	Clears the results attached to an entity if <ents> equates the starting model, clears all results.

void	PrintStats (Standard_OStream &theStream, const int theWhat, const int theMode=0) const
	Prints statistics on current Trace File, according <what> and <mode>. See PrintStatsProcess for details.

Interface_CheckIterator	LastCheckList () const
	Returns the CheckList resulting from last TransferRead i.e. from TransientProcess itself, recorded from last Clear.

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	LastTransferList (const bool theRoots) const
	Returns the list of entities recorded as lastly transferred i.e. from TransientProcess itself, recorded from last Clear If <roots> is True , considers only roots of transfer If <roots> is False, considers all entities bound with result.

const occ::handle< NCollection_HSequence< TopoDS_Shape > > &	ShapeResultList (const bool theRec)
	Returns a list of result Shapes If <rec> is True , sees RecordedList If <rec> is False, sees LastTransferList (last ROOT transfers) For each one, if it is a Shape, it is cumulated to the list If no Shape is found, returns an empty Sequence.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static void	PrintStatsProcess (const occ::handle< Transfer_TransientProcess > &theTP, const int theWhat, const int theMode=0)
	This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file <what> defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages.

static void	PrintStatsOnList (const occ::handle< Transfer_TransientProcess > &theTP, const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &theList, const int theWhat, const int theMode=0)
	Works as PrintStatsProcess, but displays data only on the entities which are in filter)

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

A TransferReader performs, manages, handles results of, transfers done when reading a file (i.e. from entities of an InterfaceModel, to objects for Imagine)

Running is organised around basic tools : TransientProcess and its Actor, results are Binders and CheckIterators. It implies control by a Controller (which prepares the Actor as required)

Getting results can be done directly on TransientProcess, but these are immediate "last produced" results. Each transfer of an entity gives a final result, but also possible intermediate data, and checks, which can be attached to sub-entities.

Hence, final results (which intermediates and checks) are recorded as ResultFromModel and can be queried individually.

Some more direct access are given for results which are Transient or Shapes

Constructor & Destructor Documentation

◆ XSControl_TransferReader()

XSControl_TransferReader::XSControl_TransferReader ( )

default

Creates a TransferReader, empty.

Member Function Documentation

◆ Actor()

occ::handle< Transfer_ActorOfTransientProcess > XSControl_TransferReader::Actor ( )

Returns the Actor, determined by the Controller, or if this one is unknown, directly set. Once it has been defined, it can then be edited.

◆ BeginTransfer()

bool XSControl_TransferReader::BeginTransfer ( )

Defines a new TransferProcess for reading transfer Returns True if done, False if data are not properly defined (the Model, the Actor for Read)

◆ CheckedList()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > XSControl_TransferReader::CheckedList	(	const occ::handle< Standard_Transient > &	theEnt,
		const Interface_CheckStatus	WithCheck = Interface_CheckAny,
		const bool	theResult = true ) const

Returns the list of starting entities to which a given check status is attached, IN FINAL RESULTS <ent> can be an entity, or the model to query all entities Below, "entities" are, either <ent> plus its sub-transferred, or all the entities of the model.

<check> = -2 , all entities whatever the check (see result) <check> = -1 , entities with no fail (warning allowed) <check> = 0 , entities with no check at all <check> = 1 , entities with warning but no fail <check> = 2 , entities with fail <result> : if True, only entities with an attached result Remark : result True and check=0 will give an empty list

◆ CheckList()

Interface_CheckIterator XSControl_TransferReader::CheckList	(	const occ::handle< Standard_Transient > &	theEnt,
		const int	theLevel = 0 ) const

Returns the CheckList resulting from transferring <ent>, i.e. stored in its recorded form ResultFromModel (empty if transfer successful or not recorded ...)

If <ent> is the Model, returns the complete cumulated check-list, <level> is ignored

If <ent> is an entity of the Model, <level> applies as follows <level> : -1 for <ent> only, LAST transfer (TransientProcess) <level> : 0 for <ent> only (D) 1 for <ent> and its immediate subtransfers, if any 2 for <ent> and subtransferts at all levels

◆ Clear()

void XSControl_TransferReader::Clear ( const int theMode )

Clears data, according mode : -1 all 0 nothing done +1 final results +2 working data (model, context, transfer process)

◆ ClearResult()

bool XSControl_TransferReader::ClearResult	(	const occ::handle< Standard_Transient > &	theEnt,
		const int	theMode )

Clears recorded result for an entity, according mode <mode> = -1 : true, complete, clearing (erasing result) <mode> >= 0 : simple "stripping", see ResultFromModel, in particular, 0 for simple internal strip, 10 for all but final result, 11 for all : just label, status and filename are kept Returns True when done, False if nothing was to clear.

◆ Context()

NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > & XSControl_TransferReader::Context ( )

inline

Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once)

◆ EntitiesFromShapeList()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > XSControl_TransferReader::EntitiesFromShapeList	(	const occ::handle< NCollection_HSequence< TopoDS_Shape > > &	theRes,
		const int	theMode = 0 ) const

Returns the list of entities from which some shapes were produced : it corresponds to a loop on EntityFromShapeResult, but is optimised.

◆ EntityFromResult()

occ::handle< Standard_Transient > XSControl_TransferReader::EntityFromResult	(	const occ::handle< Standard_Transient > &	theRes,
		const int	theMode = 0 ) const

Returns an entity from which a given result was produced. If <mode> = 0 (D), searches in last root transfers If <mode> = 1, searches in last (root & sub) transfers If <mode> = 2, searches in root recorded results If <mode> = 3, searches in all (root & sub) recordeds <res> can be, either a transient object (result itself) or a binder. For a binder of shape, calls EntityFromShapeResult Returns a Null Handle if <res> not recorded.

◆ EntityFromShapeResult()

occ::handle< Standard_Transient > XSControl_TransferReader::EntityFromShapeResult	(	const TopoDS_Shape &	theRes,
		const int	theMode = 0 ) const

Returns an entity from which a given shape result was produced Returns a Null Handle if <res> not recorded or not a Shape.

◆ FileName()

const char * XSControl_TransferReader::FileName ( ) const

inline

Returns actual value of file name.

◆ FinalEntityLabel()

const char * XSControl_TransferReader::FinalEntityLabel ( const occ::handle< Standard_Transient > & theEnt ) const

Returns the label attached to an entity recorded for final, or an empty string if not recorded.

◆ FinalEntityNumber()

int XSControl_TransferReader::FinalEntityNumber ( const occ::handle< Standard_Transient > & theEnt ) const

Returns the number attached to the entity recorded for final, or zero if not recorded (looks in the ResultFromModel)

◆ FinalResult()

occ::handle< Transfer_ResultFromModel > XSControl_TransferReader::FinalResult ( const occ::handle< Standard_Transient > & theEnt ) const

Returns the final result recorded for an entity, as such.

◆ GetContext()

bool XSControl_TransferReader::GetContext	(	const char *const	theName,
		const occ::handle< Standard_Type > &	theType,
		occ::handle< Standard_Transient > &	theCtx ) const

Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context.

◆ HasChecks()

bool XSControl_TransferReader::HasChecks	(	const occ::handle< Standard_Transient > &	theEnt,
		const bool	FailsOnly ) const

Returns True if an entity (with a final result) has checks :

failsonly = False : any kind of check message
failsonly = True : fails only Returns False if <ent> is not recorded

◆ HasResult()

bool XSControl_TransferReader::HasResult ( const occ::handle< Standard_Transient > & theEnt ) const

Returns True if a final result is recorded AND BRINGS AN EFFECTIVE RESULT (else, it brings only fail messages)

◆ IsMarked()

bool XSControl_TransferReader::IsMarked ( const occ::handle< Standard_Transient > & theEnt ) const

Returns True if an entity has been asked for transfert, hence it is marked, as : Recorded (a computation has ran, with or without an effective result), or Skipped (case ignored)

◆ IsRecorded()

bool XSControl_TransferReader::IsRecorded ( const occ::handle< Standard_Transient > & theEnt ) const

Returns True if a final result is recorded for an entity Remark that it can bring no effective result if transfer has completely failed (FinalResult brings only fail messages ...)

◆ IsSkipped()

bool XSControl_TransferReader::IsSkipped ( const occ::handle< Standard_Transient > & theEnt ) const

Returns True if an entity is noted as skipped.

◆ LastCheckList()

Interface_CheckIterator XSControl_TransferReader::LastCheckList ( ) const

Returns the CheckList resulting from last TransferRead i.e. from TransientProcess itself, recorded from last Clear.

◆ LastTransferList()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > XSControl_TransferReader::LastTransferList ( const bool theRoots ) const

Returns the list of entities recorded as lastly transferred i.e. from TransientProcess itself, recorded from last Clear If <roots> is True , considers only roots of transfer If <roots> is False, considers all entities bound with result.

◆ Model()

const occ::handle< Interface_InterfaceModel > & XSControl_TransferReader::Model ( ) const

inline

Returns the currently set InterfaceModel.

◆ PrintStats()

void XSControl_TransferReader::PrintStats	(	Standard_OStream &	theStream,
		const int	theWhat,
		const int	theMode = 0 ) const

Prints statistics on current Trace File, according <what> and <mode>. See PrintStatsProcess for details.

◆ PrintStatsOnList()

static void XSControl_TransferReader::PrintStatsOnList	(	const occ::handle< Transfer_TransientProcess > &	theTP,
		const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &	theList,
		const int	theWhat,
		const int	theMode = 0 )

static

Works as PrintStatsProcess, but displays data only on the entities which are in

filter)

◆ PrintStatsProcess()

static void XSControl_TransferReader::PrintStatsProcess	(	const occ::handle< Transfer_TransientProcess > &	theTP,
		const int	theWhat,
		const int	theMode = 0 )

static

This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file <what> defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages.

<mode> is used according <what> : <what> = 0 : <mode> is ignored <what> = 1,2,3 : <mode> as follows : 0 (D) : just lists numbers of concerned entities in the model 1 : for each entity, gives number,label, type and result type and/or status (fail/warning...) 2 : for each entity, gives maximal information (i.e. checks) 3 : counts per type of starting entity (class type) 4 : counts per result type and/or status 5 : counts per couple (starting type / result type/status) 6 : idem plus gives for each item, the list of numbers of entities in the starting model

<what> = 4,5 : modes relays on an enum PrintCount : 0 (D) : ItemsByEntity (sequential list by entity) 1 : CountByItem 2 : ShortByItem (count + 5 first numbers) 3 : ListByItem (count + entity numbers) 4 : EntitiesByItem (count + entity numbers and labels)

◆ Recognize()

bool XSControl_TransferReader::Recognize ( const occ::handle< Standard_Transient > & theEnt )

Tells if an entity is recognized as a valid candidate for Transfer. Calls method Recognize from the Actor (if known)

◆ RecordedList()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > XSControl_TransferReader::RecordedList ( ) const

Returns the list of entities to which a final result is attached (i.e. processed by RecordResult)

◆ RecordResult()

bool XSControl_TransferReader::RecordResult ( const occ::handle< Standard_Transient > & theEnt )

Records a final result of transferring an entity This result is recorded as a ResultFromModel, taken from the TransientProcess Returns True if a result is available, False else.

◆ ResultFromNumber()

occ::handle< Transfer_ResultFromModel > XSControl_TransferReader::ResultFromNumber ( const int theNum ) const

Returns the final result recorded for a NUMBER of entity (internal use). Null if out of range.

◆ SetActor()

void XSControl_TransferReader::SetActor ( const occ::handle< Transfer_ActorOfTransientProcess > & theActor )

inline

Sets the Actor directly : this value will be used if the Controller is not set.

◆ SetContext()

void XSControl_TransferReader::SetContext	(	const char *const	theName,
		const occ::handle< Standard_Transient > &	theCtx )

Sets a Context : according to receiving appli, to be interpreted by the Actor.

◆ SetController()

void XSControl_TransferReader::SetController ( const occ::handle< XSControl_Controller > & theControl )

Sets a Controller. It is required to generate the Actor. Elsewhere, the Actor must be provided directly.

◆ SetFileName()

void XSControl_TransferReader::SetFileName ( const char *const theName )

inline

Sets a new value for (loaded) file name.

◆ SetGraph()

void XSControl_TransferReader::SetGraph ( const occ::handle< Interface_HGraph > & theGraph )

Sets a Graph and its InterfaceModel (calls SetModel)

◆ SetModel()

void XSControl_TransferReader::SetModel ( const occ::handle< Interface_InterfaceModel > & theModel )

Sets an InterfaceModel. This causes former results, computed from another one, to be lost (see also Clear)

◆ SetTransientProcess()

void XSControl_TransferReader::SetTransientProcess ( const occ::handle< Transfer_TransientProcess > & theTP )

inline

Forces the TransientProcess Remark : it also changes the Model and the Actor, from those recorded in the new TransientProcess.

◆ ShapeResult()

TopoDS_Shape XSControl_TransferReader::ShapeResult ( const occ::handle< Standard_Transient > & theEnt ) const

Returns the resulting object as a Shape Null Shape if no result or result not a shape.

◆ ShapeResultList()

const occ::handle< NCollection_HSequence< TopoDS_Shape > > & XSControl_TransferReader::ShapeResultList ( const bool theRec )

Returns a list of result Shapes If <rec> is True , sees RecordedList If <rec> is False, sees LastTransferList (last ROOT transfers) For each one, if it is a Shape, it is cumulated to the list If no Shape is found, returns an empty Sequence.

◆ Skip()

bool XSControl_TransferReader::Skip ( const occ::handle< Standard_Transient > & theEnt )

Note that an entity has been required for transfer but no result at all is available (typically : case not implemented) It is not an error, but it gives a specific status : Skipped Returns True if done, False if <ent> is not in starting model.

◆ TransferClear()

void XSControl_TransferReader::TransferClear	(	const occ::handle< Standard_Transient > &	theEnt,
		const int	theLevel = 0 )

Clears the results attached to an entity if <ents> equates the starting model, clears all results.

◆ TransferList()

int XSControl_TransferReader::TransferList	(	const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &	theList,
		const bool	theRec = true,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Commands the transfer on reading for a list of entities to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the results are recorded by RecordResult.

◆ TransferOne()

int XSControl_TransferReader::TransferOne	(	const occ::handle< Standard_Transient > &	theEnt,
		const bool	theRec = true,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Commands the transfer on reading for an entity to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the result is recorded by RecordResult.

◆ TransferRoots()

int XSControl_TransferReader::TransferRoots	(	const Interface_Graph &	theGraph,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfers the content of the current Interface Model to data handled by Imagine, starting from its Roots (determined by the Graph <G>), using the selected Actor for Read Returns the count of performed root transfers (i.e. 0 if none) or -1 if no actor is defined.

◆ TransientProcess()

const occ::handle< Transfer_TransientProcess > & XSControl_TransferReader::TransientProcess ( ) const

inline

Returns the currently used TransientProcess It is computed from the model by TransferReadRoots, or by BeginTransferRead.

◆ TransientResult()

occ::handle< Standard_Transient > XSControl_TransferReader::TransientResult ( const occ::handle< Standard_Transient > & theEnt ) const

Returns the resulting object as a Transient Null Handle if no result or result not transient.

The documentation for this class was generated from the following file:

XSControl_TransferReader.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XSControl_TransferReader()

Member Function Documentation

◆ Actor()

◆ BeginTransfer()

◆ CheckedList()

◆ CheckList()

◆ Clear()

◆ ClearResult()

◆ Context()

◆ EntitiesFromShapeList()

◆ EntityFromResult()

◆ EntityFromShapeResult()

◆ FileName()

◆ FinalEntityLabel()

◆ FinalEntityNumber()

◆ FinalResult()

◆ GetContext()

◆ HasChecks()

◆ HasResult()

◆ IsMarked()

◆ IsRecorded()

◆ IsSkipped()

◆ LastCheckList()

◆ LastTransferList()

◆ Model()

◆ PrintStats()

◆ PrintStatsOnList()

◆ PrintStatsProcess()

◆ Recognize()

◆ RecordedList()

◆ RecordResult()

◆ ResultFromNumber()

◆ SetActor()

◆ SetContext()

◆ SetController()

◆ SetFileName()

◆ SetGraph()

◆ SetModel()

◆ SetTransientProcess()

◆ ShapeResult()

◆ ShapeResultList()

◆ Skip()

◆ TransferClear()

◆ TransferList()

◆ TransferOne()

◆ TransferRoots()

◆ TransientProcess()

◆ TransientResult()