Adds specific features to the generic definition : PrintTrace is adapted. More...

#include <Transfer_FinderProcess.hxx>

Inheritance diagram for Transfer_FinderProcess:

[legend]

Public Member Functions
	Transfer_FinderProcess (const int nb=10000)
	Sets FinderProcess at initial state, with an initial size.
void	SetModel (const occ::handle< Interface_InterfaceModel > &model)
	Sets an InterfaceModel, which can be used during transfer for instance if a context must be managed, it is in the Model.
occ::handle< Interface_InterfaceModel >	Model () const
	Returns the Model which can be used for context.
int	NextMappedWithAttribute (const char *const namename, const int num0) const
	In the list of mapped items (between 1 and NbMapped), searches for the first mapped item which follows <num0> (not included) and which has an attribute named <name> The considered Attributes are those brought by Finders,i.e. by Input data. While NextItemWithAttribute works on Result data (Binders).
occ::handle< Transfer_TransientMapper >	TransientMapper (const occ::handle< Standard_Transient > &objobj) const
	Returns a TransientMapper for a given Transient Object Either <obj> is already mapped, then its Mapper is returned Or it is not, then a new one is created then returned, BUT it is not mapped here (use Bind or FindElseBind to do this).
void	PrintTrace (const occ::handle< Transfer_Finder > &startstart, Standard_OStream &S) const override
	Specific printing to trace a Finder (by its method ValueType).
void	PrintStats (const int modemode, Standard_OStream &S) const
	Prints statistics on a given output, according mode.
Public Member Functions inherited from Transfer_ProcessForFinder
	Transfer_ProcessForFinder (const int nb=10000)
	Sets TransferProcess at initial state. Gives an Initial size (indicative) for the Map when known (default is 10000). Sets default trace file as a printer and default trace level (see Message_TraceFile).
	Transfer_ProcessForFinder (const occ::handle< Message_Messenger > &printer, const int nb=10000)
	Sets TransferProcess at initial state. Gives an Initial size (indicative) for the Map when known (default is 10000). Sets a specified printer.
void	Clear ()
	Resets a TransferProcess as ready for a completely new work. Clears general data (roots) and the Map.
void	Clean ()
	Rebuilds the Map and the roots to really remove Unbound items Because Unbind keeps the entity in place, even if not bound Hence, working by checking new items is meaningless if a formerly unbound item is rebound.
void	Resize (const int nb)
	Resizes the Map as required (if a new reliable value has been determined). Acts only if <nb> is greater than actual NbMapped.
void	SetActor (const occ::handle< Transfer_ActorOfProcessForFinder > &actor)
	Defines an Actor, which is used for automatic Transfer If already defined, the new Actor is cumulated (see SetNext from Actor).
occ::handle< Transfer_ActorOfProcessForFinder >	Actor () const
	Returns the defined Actor. Returns a Null Handle if not set.
occ::handle< Transfer_Binder >	Find (const occ::handle< Transfer_Finder > &startstart) const
	Returns the Binder which is linked with a starting Object It can either bring a Result (Transfer done) or none (for a pre-binding). If no Binder is linked with <start>, returns a Null Handle Considers a category number, by default 0.
bool	IsBound (const occ::handle< Transfer_Finder > &startstart) const
	Returns True if a Result (whatever its form) is Bound with a starting Object. I.e., if a Binder with a Result set, is linked with it Considers a category number, by default 0.
bool	IsAlreadyUsed (const occ::handle< Transfer_Finder > &startstart) const
	Returns True if the result of the transfer of an object is already used in other ones. If it is, Rebind cannot change it. Considers a category number, by default 0.
void	Bind (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Transfer_Binder > &binder)
	Creates a Link a starting Object with a Binder. This Binder can either bring a Result (effective Binding) or none (it can be set later : pre-binding). Considers a category number, by default 0.
void	Rebind (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Transfer_Binder > &binder)
	Changes the Binder linked with a starting Object for its unitary transfer. This it can be useful when the exact form of the result is known once the transfer is widely engaged. This can be done only on first transfer. Considers a category number, by default 0.
bool	Unbind (const occ::handle< Transfer_Finder > &startstart)
	Removes the Binder linked with a starting object If this Binder brings a non-empty Check, it is replaced by a VoidBinder. Also removes from the list of Roots as required. Returns True if done, False if <start> was not bound Considers a category number, by default 0.
occ::handle< Transfer_Binder >	FindElseBind (const occ::handle< Transfer_Finder > &startstart)
	Returns a Binder for a starting entity, as follows : Tries to Find the already bound one If none found, creates a VoidBinder and Binds it.
void	SetMessenger (const occ::handle< Message_Messenger > &messenger)
	Sets Messenger used for outputting messages.
occ::handle< Message_Messenger >	Messenger () const
	Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().
void	SetTraceLevel (const int tracelev)
	Sets trace level used for outputting messages: <trace> = 0 : no trace at all <trace> = 1 : handled exceptions and calls to AddError <trace> = 2 : also calls to AddWarning <trace> = 3 : also traces new Roots (uses method ErrorTrace). Default is 1 : Errors traced.
int	TraceLevel () const
	Returns trace level used for outputting messages.
void	SendFail (const occ::handle< Transfer_Finder > &startstart, const Message_Msg &amsg)
	New name for AddFail (Msg).
void	SendWarning (const occ::handle< Transfer_Finder > &startstart, const Message_Msg &amsg)
	New name for AddWarning (Msg).
void	SendMsg (const occ::handle< Transfer_Finder > &startstart, const Message_Msg &amsg)
	Adds an information message Trace is filled if trace level is at least 3.
void	AddFail (const occ::handle< Transfer_Finder > &startstart, const char const mess, const char const orig="")
	Adds an Error message to a starting entity (to the check of its Binder of category 0, as a Fail).
void	AddError (const occ::handle< Transfer_Finder > &startstart, const char const mess, const char const orig="")
	(other name of AddFail, maintained for compatibility)
void	AddFail (const occ::handle< Transfer_Finder > &startstart, const Message_Msg &amsg)
	Adds an Error Message to a starting entity from the definition of a Msg (Original+Value).
void	AddWarning (const occ::handle< Transfer_Finder > &startstart, const char const mess, const char const orig="")
	Adds a Warning message to a starting entity (to the check of its Binder of category 0).
void	AddWarning (const occ::handle< Transfer_Finder > &startstart, const Message_Msg &amsg)
	Adds a Warning Message to a starting entity from the definition of a Msg (Original+Value).
void	Mend (const occ::handle< Transfer_Finder > &startstart, const char *const pref="")
occ::handle< Interface_Check >	Check (const occ::handle< Transfer_Finder > &startstart) const
	Returns the Check attached to a starting entity. If <start> is unknown, returns an empty Check Adds a case name to a starting entity Adds a case value to a starting entity Returns the complete case list for an entity. Null Handle if empty In the list of mapped items (between 1 and NbMapped), searches for the first item which follows <num0>(not included) and which has an attribute named <name> Attributes are brought by Binders Hence, allows such an iteration.
void	BindTransient (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Standard_Transient > &resres)
	Binds a starting object with a Transient Result. Uses a SimpleBinderOfTransient to work. If there is already one but with no Result set, sets its Result. Considers a category number, by default 0.
const occ::handle< Standard_Transient > &	FindTransient (const occ::handle< Transfer_Finder > &startstart) const
	Returns the Result of the Transfer of an object <start> as a Transient Result. Returns a Null Handle if there is no Transient Result Considers a category number, by default 0 Warning : Supposes that Binding is done with a SimpleBinderOfTransient.
void	BindMultiple (const occ::handle< Transfer_Finder > &startstart)
	Prepares an object <start> to be bound with several results. If no Binder is yet attached to <obj>, a MultipleBinder is created, empty. If a Binder is already set, it must accept Multiple Binding. Considers a category number, by default 0.
void	AddMultiple (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Standard_Transient > &resres)
	Adds an item to a list of results bound to a starting object. Considers a category number, by default 0, for all results.
bool	FindTypedTransient (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Standard_Type > &atype, occ::handle< Standard_Transient > &valval) const
	Searches for a transient result attached to a starting object, according to its type, by criterium IsKind(atype).
template<class T>
bool	FindTypedTransient (const occ::handle< Transfer_Finder > &startstart, const occ::handle< Standard_Type > &atype, occ::handle< T > &valval) const
	Safe variant for arbitrary type of argument.
bool	GetTypedTransient (const occ::handle< Transfer_Binder > &binder, const occ::handle< Standard_Type > &atype, occ::handle< Standard_Transient > &valval) const
	Searches for a transient result recorded in a Binder, whatever this Binder is recorded or not in <me>.
template<class T>
bool	GetTypedTransient (const occ::handle< Transfer_Binder > &startstart, const occ::handle< Standard_Type > &atype, occ::handle< T > &valval) const
	Safe variant for arbitrary type of argument.
int	NbMapped () const
	Returns the maximum possible value for Map Index (no result can be bound with a value greater than it).
const occ::handle< Transfer_Finder > &	Mapped (const int numnum) const
	Returns the Starting Object bound to an Index,.
int	MapIndex (const occ::handle< Transfer_Finder > &startstart) const
	Returns the Index value bound to a Starting Object, 0 if none.
occ::handle< Transfer_Binder >	MapItem (const int numnum) const
	Returns the Binder bound to an Index Considers a category number, by default 0.
void	SetRoot (const occ::handle< Transfer_Finder > &startstart)
	Declares <obj> (and its Result) as Root. This status will be later exploited by RootResult, see below (Result can be produced at any time).
void	SetRootManagement (const bool stat)
	Enable (if <stat> True) or Disables (if <stat> False) Root Management. If it is set, Transfers are considered as stacked (a first Transfer commands other Transfers, and so on) and the Transfers commanded by an external caller are "Root". Remark : SetRoot can be called whatever this status, on every object. Default is set to True.
int	NbRoots () const
	Returns the count of recorded Roots.
const occ::handle< Transfer_Finder > &	Root (const int numnum) const
	Returns a Root Entity given its number in the list (1-NbRoots).
occ::handle< Transfer_Binder >	RootItem (const int numnum) const
	Returns the Binder bound with a Root Entity given its number Considers a category number, by default 0.
int	RootIndex (const occ::handle< Transfer_Finder > &startstart) const
	Returns the index in the list of roots for a starting item, or 0 if it is not recorded as a root.
int	NestingLevel () const
	Returns Nesting Level of Transfers (managed by methods TranscriptWith & Co). Starts to zero. If no automatic Transfer is used, it remains to zero. Zero means Root Level.
void	ResetNestingLevel ()
	Resets Nesting Level of Transfers to Zero (Root Level), whatever its current value.
bool	Recognize (const occ::handle< Transfer_Finder > &startstart) const
	Tells if <start> has been recognized as good candidate for Transfer. i.e. queries the Actor and its Nexts.
occ::handle< Transfer_Binder >	Transferring (const occ::handle< Transfer_Finder > &startstart, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Performs the Transfer of a Starting Object, by calling the method TransferProduct (see below). Mapping and Roots are managed : nothing is done if a Result is already Bound, an exception is raised in case of error.
bool	Transfer (const occ::handle< Transfer_Finder > &startstart, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Same as Transferring but does not return the Binder. Simply returns True in case of success (for user call).
void	SetErrorHandle (const bool err)
	Allows controls if exceptions will be handled Transfer Operations <err> False : they are not handled with try {} catch {} <err> True : they are Default is False: no handling performed.
bool	ErrorHandle () const
	Returns error handling flag.
void	StartTrace (const occ::handle< Transfer_Binder > &binder, const occ::handle< Transfer_Finder > &startstart, const int levellevel, const int modemode) const
	Method called when trace is asked Calls PrintTrace to display information relevant for starting objects (which can be redefined) <level> is Nesting Level of Transfer (0 = root) <mode> controls the way the trace is done : 0 neutral, 1 for Error, 2 for Warning message, 3 for new Root.
bool	IsLooping (const int alevel) const
	Returns True if we are surely in a DeadLoop. Evaluation is not exact, it is a "majorant" which must be computed fast. This "majorant" is : <alevel> greater than NbMapped.
Transfer_IteratorOfProcessForFinder	RootResult (const bool withstart=false) const
	Returns, as an iterator, the log of root transfer, i.e. the created objects and Binders bound to starting roots If withstart is given True, Starting Objects are also returned.
Transfer_IteratorOfProcessForFinder	CompleteResult (const bool withstart=false) const
	Returns, as an Iterator, the entire log of transfer (list of created objects and Binders which can bring errors) If withstart is given True, Starting Objects are also returned.
Transfer_IteratorOfProcessForFinder	AbnormalResult () const
	Returns Binders which are neither "Done" nor "Initial", that is Error,Loop or Run (abnormal states at end of Transfer) Starting Objects are given in correspondence in the iterator.
Interface_CheckIterator	CheckList (const bool erronly) const
	Returns a CheckList as a list of Check : each one is for a starting entity which have either check (warning or fail) messages are attached, or are in abnormal state : that case gives a specific message If <erronly> is True, checks with Warnings only are ignored.
Transfer_IteratorOfProcessForFinder	ResultOne (const occ::handle< Transfer_Finder > &startstart, const int levellevel, const bool withstart=false) const
	Returns, as an Iterator, the log of transfer for one object <level> = 0 : this object only and if <start> is a scope owner (else, <level> is ignored) : <level> = 1 : object plus its immediate scoped ones <level> = 2 : object plus all its scoped ones.
Interface_CheckIterator	CheckListOne (const occ::handle< Transfer_Finder > &startstart, const int levellevel, const bool erronly) const
	Returns a CheckList for one starting object <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored.
bool	IsCheckListEmpty (const occ::handle< Transfer_Finder > &startstart, const int levellevel, const bool erronly) const
	Returns True if no check message is attached to a starting object. <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored.
void	RemoveResult (const occ::handle< Transfer_Finder > &startstart, const int levellevel, const bool compute=true)
	Removes Results attached to (== Unbinds) a given object and, according <level> : <level> = 0 : only it <level> = 1 : it plus its immediately owned sub-results(scope) <level> = 2 : it plus all its owned sub-results(scope).
virtual int	CheckNum (const occ::handle< Transfer_Finder > &startstart) const
	Computes a number to be associated to a starting object in a check or a check-list By default, returns 0; can be redefined.
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.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.

Detailed Description

Adds specific features to the generic definition : PrintTrace is adapted.

Constructor & Destructor Documentation

◆ Transfer_FinderProcess()

Transfer_FinderProcess::Transfer_FinderProcess ( const int nb = 10000 )

Sets FinderProcess at initial state, with an initial size.

Member Function Documentation

◆ Model()

occ::handle< Interface_InterfaceModel > Transfer_FinderProcess::Model ( ) const

Returns the Model which can be used for context.

◆ NextMappedWithAttribute()

int Transfer_FinderProcess::NextMappedWithAttribute	(	const char *const	name,
		const int	num0 ) const

In the list of mapped items (between 1 and NbMapped), searches for the first mapped item which follows <num0> (not included) and which has an attribute named <name> The considered Attributes are those brought by Finders,i.e. by Input data. While NextItemWithAttribute works on Result data (Binders).

Hence, allows such an iteration

for (num = FP->NextMappedWithAttribute(name,0); num > 0; num = FP->NextMappedWithAttribute(name,num) { .. process mapped item <num> }

◆ PrintStats()

void Transfer_FinderProcess::PrintStats	(	const int	mode,
		Standard_OStream &	S ) const

Prints statistics on a given output, according mode.

◆ PrintTrace()

void Transfer_FinderProcess::PrintTrace	(	const occ::handle< Transfer_Finder > &	start,
		Standard_OStream &	S ) const

overridevirtual

Specific printing to trace a Finder (by its method ValueType).

Reimplemented from Transfer_ProcessForFinder.

◆ SetModel()

void Transfer_FinderProcess::SetModel ( const occ::handle< Interface_InterfaceModel > & model )

Sets an InterfaceModel, which can be used during transfer for instance if a context must be managed, it is in the Model.

◆ TransientMapper()

occ::handle< Transfer_TransientMapper > Transfer_FinderProcess::TransientMapper ( const occ::handle< Standard_Transient > & obj ) const

Returns a TransientMapper for a given Transient Object Either <obj> is already mapped, then its Mapper is returned Or it is not, then a new one is created then returned, BUT it is not mapped here (use Bind or FindElseBind to do this).

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

Transfer_FinderProcess.hxx

Public Member Functions

Additional Inherited Members