#include <Transfer_ProcessForFinder.hxx>

Inheritance diagram for Transfer_ProcessForFinder:

[legend]

Public Member Functions
	Transfer_ProcessForFinder (const Standard_Integer 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 Handle< Message_Messenger > &printer, const Standard_Integer 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 Standard_Integer 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 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)

Handle< Transfer_ActorOfProcessForFinder >	Actor () const
	Returns the defined Actor. Returns a Null Handle if not set.

Handle< Transfer_Binder >	Find (const Handle< Transfer_Finder > &start) 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.

Standard_Boolean	IsBound (const Handle< Transfer_Finder > &start) 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.

Standard_Boolean	IsAlreadyUsed (const Handle< Transfer_Finder > &start) 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 Handle< Transfer_Finder > &start, const 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 Handle< Transfer_Finder > &start, const 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.

Standard_Boolean	Unbind (const Handle< Transfer_Finder > &start)
	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.

Handle< Transfer_Binder >	FindElseBind (const Handle< Transfer_Finder > &start)
	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 Handle< Message_Messenger > &messenger)
	Sets Messenger used for outputting messages.

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 Standard_Integer 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.

Standard_Integer	TraceLevel () const
	Returns trace level used for outputting messages.

void	SendFail (const Handle< Transfer_Finder > &start, const Message_Msg &amsg)
	New name for AddFail (Msg)

void	SendWarning (const Handle< Transfer_Finder > &start, const Message_Msg &amsg)
	New name for AddWarning (Msg)

void	SendMsg (const Handle< Transfer_Finder > &start, const Message_Msg &amsg)
	Adds an information message Trace is filled if trace level is at least 3.

void	AddFail (const Handle< Transfer_Finder > &start, const Standard_CString mess, const Standard_CString orig="")
	Adds an Error message to a starting entity (to the check of its Binder of category 0, as a Fail)

void	AddError (const Handle< Transfer_Finder > &start, const Standard_CString mess, const Standard_CString orig="")
	(other name of AddFail, maintained for compatibility)

void	AddFail (const Handle< Transfer_Finder > &start, const Message_Msg &amsg)
	Adds an Error Message to a starting entity from the definition of a Msg (Original+Value)

void	AddWarning (const Handle< Transfer_Finder > &start, const Standard_CString mess, const Standard_CString orig="")
	Adds a Warning message to a starting entity (to the check of its Binder of category 0)

void	AddWarning (const Handle< Transfer_Finder > &start, const Message_Msg &amsg)
	Adds a Warning Message to a starting entity from the definition of a Msg (Original+Value)

void	Mend (const Handle< Transfer_Finder > &start, const Standard_CString pref="")

Handle< Interface_Check >	Check (const Handle< Transfer_Finder > &start) 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 Handle< Transfer_Finder > &start, const Handle< Standard_Transient > &res)
	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 Handle< Standard_Transient > &	FindTransient (const Handle< Transfer_Finder > &start) 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 Handle< Transfer_Finder > &start)
	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 Handle< Transfer_Finder > &start, const Handle< Standard_Transient > &res)
	Adds an item to a list of results bound to a starting object. Considers a category number, by default 0, for all results.

Standard_Boolean	FindTypedTransient (const Handle< Transfer_Finder > &start, const Handle< Standard_Type > &atype, Handle< Standard_Transient > &val) const
	Searches for a transient result attached to a starting object, according to its type, by criterium IsKind(atype)

template<class T >
Standard_Boolean	FindTypedTransient (const Handle< Transfer_Finder > &start, const Handle< Standard_Type > &atype, Handle< T > &val) const
	Safe variant for arbitrary type of argument.

Standard_Boolean	GetTypedTransient (const Handle< Transfer_Binder > &binder, const Handle< Standard_Type > &atype, Handle< Standard_Transient > &val) const
	Searches for a transient result recorded in a Binder, whatever this Binder is recorded or not in <me>

template<class T >
Standard_Boolean	GetTypedTransient (const Handle< Transfer_Binder > &start, const Handle< Standard_Type > &atype, Handle< T > &val) const
	Safe variant for arbitrary type of argument.

Standard_Integer	NbMapped () const
	Returns the maximum possible value for Map Index (no result can be bound with a value greater than it)

const Handle< Transfer_Finder > &	Mapped (const Standard_Integer num) const
	Returns the Starting Object bound to an Index,.

Standard_Integer	MapIndex (const Handle< Transfer_Finder > &start) const
	Returns the Index value bound to a Starting Object, 0 if none.

Handle< Transfer_Binder >	MapItem (const Standard_Integer num) const
	Returns the Binder bound to an Index Considers a category number, by default 0.

void	SetRoot (const Handle< Transfer_Finder > &start)
	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 Standard_Boolean 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.

Standard_Integer	NbRoots () const
	Returns the count of recorded Roots.

const Handle< Transfer_Finder > &	Root (const Standard_Integer num) const
	Returns a Root Entity given its number in the list (1-NbRoots)

Handle< Transfer_Binder >	RootItem (const Standard_Integer num) const
	Returns the Binder bound with a Root Entity given its number Considers a category number, by default 0.

Standard_Integer	RootIndex (const Handle< Transfer_Finder > &start) const
	Returns the index in the list of roots for a starting item, or 0 if it is not recorded as a root.

Standard_Integer	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.

Standard_Boolean	Recognize (const Handle< Transfer_Finder > &start) const
	Tells if <start> has been recognized as good candidate for Transfer. i.e. queries the Actor and its Nexts.

Handle< Transfer_Binder >	Transferring (const Handle< Transfer_Finder > &start, 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.

Standard_Boolean	Transfer (const Handle< Transfer_Finder > &start, 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 Standard_Boolean 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.

Standard_Boolean	ErrorHandle () const
	Returns error handling flag.

void	StartTrace (const Handle< Transfer_Binder > &binder, const Handle< Transfer_Finder > &start, const Standard_Integer level, const Standard_Integer mode) 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.

virtual void	PrintTrace (const Handle< Transfer_Finder > &start, Standard_OStream &S) const
	Prints a short information on a starting object. By default prints its Dynamic Type. Can be redefined.

Standard_Boolean	IsLooping (const Standard_Integer 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 Standard_Boolean withstart=Standard_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 Standard_Boolean withstart=Standard_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 Standard_Boolean 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 Handle< Transfer_Finder > &start, const Standard_Integer level, const Standard_Boolean withstart=Standard_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 Handle< Transfer_Finder > &start, const Standard_Integer level, const Standard_Boolean erronly) const
	Returns a CheckList for one starting object <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored.

Standard_Boolean	IsCheckListEmpty (const Handle< Transfer_Finder > &start, const Standard_Integer level, const Standard_Boolean 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 Handle< Transfer_Finder > &start, const Standard_Integer level, const Standard_Boolean compute=Standard_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 Standard_Integer	CheckNum (const Handle< Transfer_Finder > &start) 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 ()
	Destructor must be virtual.

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

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

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	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.

Standard_Boolean	IsKind (const Standard_CString 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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

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

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.

Constructor & Destructor Documentation

◆ Transfer_ProcessForFinder() [1/2]

Transfer_ProcessForFinder::Transfer_ProcessForFinder ( const Standard_Integer 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() [2/2]

Transfer_ProcessForFinder::Transfer_ProcessForFinder	(	const Handle< Message_Messenger > &	printer,
		const Standard_Integer	nb = 10000 )

Sets TransferProcess at initial state. Gives an Initial size (indicative) for the Map when known (default is 10000). Sets a specified printer.

Member Function Documentation

◆ AbnormalResult()

Transfer_IteratorOfProcessForFinder Transfer_ProcessForFinder::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.

◆ Actor()

Handle< Transfer_ActorOfProcessForFinder > Transfer_ProcessForFinder::Actor ( ) const

Returns the defined Actor. Returns a Null Handle if not set.

◆ AddError()

void Transfer_ProcessForFinder::AddError	(	const Handle< Transfer_Finder > &	start,
		const Standard_CString	mess,
		const Standard_CString	orig = "" )

(other name of AddFail, maintained for compatibility)

◆ AddFail() [1/2]

void Transfer_ProcessForFinder::AddFail	(	const Handle< Transfer_Finder > &	start,
		const Message_Msg &	amsg )

Adds an Error Message to a starting entity from the definition of a Msg (Original+Value)

◆ AddFail() [2/2]

void Transfer_ProcessForFinder::AddFail	(	const Handle< Transfer_Finder > &	start,
		const Standard_CString	mess,
		const Standard_CString	orig = "" )

Adds an Error message to a starting entity (to the check of its Binder of category 0, as a Fail)

◆ AddMultiple()

void Transfer_ProcessForFinder::AddMultiple	(	const Handle< Transfer_Finder > &	start,
		const Handle< Standard_Transient > &	res )

Adds an item to a list of results bound to a starting object. Considers a category number, by default 0, for all results.

◆ AddWarning() [1/2]

void Transfer_ProcessForFinder::AddWarning	(	const Handle< Transfer_Finder > &	start,
		const Message_Msg &	amsg )

Adds a Warning Message to a starting entity from the definition of a Msg (Original+Value)

◆ AddWarning() [2/2]

void Transfer_ProcessForFinder::AddWarning	(	const Handle< Transfer_Finder > &	start,
		const Standard_CString	mess,
		const Standard_CString	orig = "" )

Adds a Warning message to a starting entity (to the check of its Binder of category 0)

◆ Bind()

void Transfer_ProcessForFinder::Bind	(	const Handle< Transfer_Finder > &	start,
		const 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.

◆ BindMultiple()

void Transfer_ProcessForFinder::BindMultiple ( const Handle< Transfer_Finder > & start )

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.

◆ BindTransient()

void Transfer_ProcessForFinder::BindTransient	(	const Handle< Transfer_Finder > &	start,
		const Handle< Standard_Transient > &	res )

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.

◆ Check()

Handle< Interface_Check > Transfer_ProcessForFinder::Check ( const Handle< Transfer_Finder > & start ) 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.

for (num = TP->NextItemWithAttribute(name,0); num > 0; num = TP->NextItemWithAttribute(name,num) { .. process mapped item <num> } Returns the type of an Attribute attached to binders If this name gives no Attribute, returns ParamVoid If this name gives several different types, returns ParamMisc Else, returns the effective type (ParamInteger, ParamReal, ParamIdent, or ParamText) Returns the list of recorded Attribute Names, as a Dictionary of Integer : each value gives the count of items which bring this attribute name By default, considers all the attribute names If <rootname> is given, considers only the attribute names which begin by <rootname>

◆ CheckList()

Interface_CheckIterator Transfer_ProcessForFinder::CheckList ( const Standard_Boolean 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.

◆ CheckListOne()

Interface_CheckIterator Transfer_ProcessForFinder::CheckListOne	(	const Handle< Transfer_Finder > &	start,
		const Standard_Integer	level,
		const Standard_Boolean	erronly ) const

Returns a CheckList for one starting object <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored.

◆ CheckNum()

virtual Standard_Integer Transfer_ProcessForFinder::CheckNum ( const Handle< Transfer_Finder > & start ) const

virtual

Computes a number to be associated to a starting object in a check or a check-list By default, returns 0; can be redefined.

◆ Clean()

void Transfer_ProcessForFinder::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.

◆ Clear()

void Transfer_ProcessForFinder::Clear ( )

Resets a TransferProcess as ready for a completely new work. Clears general data (roots) and the Map.

◆ CompleteResult()

Transfer_IteratorOfProcessForFinder Transfer_ProcessForFinder::CompleteResult ( const Standard_Boolean withstart = Standard_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.

◆ ErrorHandle()

Standard_Boolean Transfer_ProcessForFinder::ErrorHandle ( ) const

Returns error handling flag.

◆ Find()

Handle< Transfer_Binder > Transfer_ProcessForFinder::Find ( const Handle< Transfer_Finder > & start ) 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.

◆ FindElseBind()

Handle< Transfer_Binder > Transfer_ProcessForFinder::FindElseBind ( const Handle< Transfer_Finder > & start )

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.

◆ FindTransient()

const Handle< Standard_Transient > & Transfer_ProcessForFinder::FindTransient ( const Handle< Transfer_Finder > & start ) 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.

◆ FindTypedTransient() [1/2]

Standard_Boolean Transfer_ProcessForFinder::FindTypedTransient	(	const Handle< Transfer_Finder > &	start,
		const Handle< Standard_Type > &	atype,
		Handle< Standard_Transient > &	val ) const

Searches for a transient result attached to a starting object, according to its type, by criterium IsKind(atype)

In case of multiple result, explores the list and gives in <val> the first transient result IsKind(atype) Returns True and fills <val> if found Else, returns False (<val> is not touched, not even nullified)

This syntactic form avoids to do DownCast : if a result is found with the good type, it is loaded in <val> and can be immediately used, well initialised

◆ FindTypedTransient() [2/2]

template<class T >

Standard_Boolean Transfer_ProcessForFinder::FindTypedTransient	(	const Handle< Transfer_Finder > &	start,
		const Handle< Standard_Type > &	atype,
		Handle< T > &	val ) const

inline

Safe variant for arbitrary type of argument.

◆ GetTypedTransient() [1/2]

Standard_Boolean Transfer_ProcessForFinder::GetTypedTransient	(	const Handle< Transfer_Binder > &	binder,
		const Handle< Standard_Type > &	atype,
		Handle< Standard_Transient > &	val ) const

Searches for a transient result recorded in a Binder, whatever this Binder is recorded or not in <me>

This is strictly equivalent to the class method GetTypedResult from class SimpleBinderOfTransient, but is just lighter to call

Apart from this, works as FindTypedTransient

◆ GetTypedTransient() [2/2]

template<class T >

Standard_Boolean Transfer_ProcessForFinder::GetTypedTransient	(	const Handle< Transfer_Binder > &	start,
		const Handle< Standard_Type > &	atype,
		Handle< T > &	val ) const

inline

Safe variant for arbitrary type of argument.

◆ IsAlreadyUsed()

Standard_Boolean Transfer_ProcessForFinder::IsAlreadyUsed ( const Handle< Transfer_Finder > & start ) 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.

◆ IsBound()

Standard_Boolean Transfer_ProcessForFinder::IsBound ( const Handle< Transfer_Finder > & start ) 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.

◆ IsCheckListEmpty()

Standard_Boolean Transfer_ProcessForFinder::IsCheckListEmpty	(	const Handle< Transfer_Finder > &	start,
		const Standard_Integer	level,
		const Standard_Boolean	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.

◆ IsLooping()

Standard_Boolean Transfer_ProcessForFinder::IsLooping ( const Standard_Integer 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.

◆ MapIndex()

Standard_Integer Transfer_ProcessForFinder::MapIndex ( const Handle< Transfer_Finder > & start ) const

Returns the Index value bound to a Starting Object, 0 if none.

◆ MapItem()

Handle< Transfer_Binder > Transfer_ProcessForFinder::MapItem ( const Standard_Integer num ) const

Returns the Binder bound to an Index Considers a category number, by default 0.

◆ Mapped()

const Handle< Transfer_Finder > & Transfer_ProcessForFinder::Mapped ( const Standard_Integer num ) const

Returns the Starting Object bound to an Index,.

◆ Mend()

void Transfer_ProcessForFinder::Mend	(	const Handle< Transfer_Finder > &	start,
		const Standard_CString	pref = "" )

◆ Messenger()

Handle< Message_Messenger > Transfer_ProcessForFinder::Messenger ( ) const

Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().

◆ NbMapped()

Standard_Integer Transfer_ProcessForFinder::NbMapped ( ) const

Returns the maximum possible value for Map Index (no result can be bound with a value greater than it)

◆ NbRoots()

Standard_Integer Transfer_ProcessForFinder::NbRoots ( ) const

Returns the count of recorded Roots.

◆ NestingLevel()

Standard_Integer Transfer_ProcessForFinder::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.

◆ PrintTrace()

virtual void Transfer_ProcessForFinder::PrintTrace	(	const Handle< Transfer_Finder > &	start,
		Standard_OStream &	S ) const

virtual

Prints a short information on a starting object. By default prints its Dynamic Type. Can be redefined.

Reimplemented in Transfer_FinderProcess.

◆ Rebind()

void Transfer_ProcessForFinder::Rebind	(	const Handle< Transfer_Finder > &	start,
		const 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.

◆ Recognize()

Standard_Boolean Transfer_ProcessForFinder::Recognize ( const Handle< Transfer_Finder > & start ) const

Tells if <start> has been recognized as good candidate for Transfer. i.e. queries the Actor and its Nexts.

◆ RemoveResult()

void Transfer_ProcessForFinder::RemoveResult	(	const Handle< Transfer_Finder > &	start,
		const Standard_Integer	level,
		const Standard_Boolean	compute = Standard_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)

◆ ResetNestingLevel()

void Transfer_ProcessForFinder::ResetNestingLevel ( )

Resets Nesting Level of Transfers to Zero (Root Level), whatever its current value.

◆ Resize()

void Transfer_ProcessForFinder::Resize ( const Standard_Integer nb )

Resizes the Map as required (if a new reliable value has been determined). Acts only if <nb> is greater than actual NbMapped.

◆ ResultOne()

Transfer_IteratorOfProcessForFinder Transfer_ProcessForFinder::ResultOne	(	const Handle< Transfer_Finder > &	start,
		const Standard_Integer	level,
		const Standard_Boolean	withstart = Standard_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.

◆ Root()

const Handle< Transfer_Finder > & Transfer_ProcessForFinder::Root ( const Standard_Integer num ) const

Returns a Root Entity given its number in the list (1-NbRoots)

◆ RootIndex()

Standard_Integer Transfer_ProcessForFinder::RootIndex ( const Handle< Transfer_Finder > & start ) const

Returns the index in the list of roots for a starting item, or 0 if it is not recorded as a root.

◆ RootItem()

Handle< Transfer_Binder > Transfer_ProcessForFinder::RootItem ( const Standard_Integer num ) const

Returns the Binder bound with a Root Entity given its number Considers a category number, by default 0.

◆ RootResult()

Transfer_IteratorOfProcessForFinder Transfer_ProcessForFinder::RootResult ( const Standard_Boolean withstart = Standard_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.

◆ SendFail()

void Transfer_ProcessForFinder::SendFail	(	const Handle< Transfer_Finder > &	start,
		const Message_Msg &	amsg )

New name for AddFail (Msg)

◆ SendMsg()

void Transfer_ProcessForFinder::SendMsg	(	const Handle< Transfer_Finder > &	start,
		const Message_Msg &	amsg )

Adds an information message Trace is filled if trace level is at least 3.

◆ SendWarning()

void Transfer_ProcessForFinder::SendWarning	(	const Handle< Transfer_Finder > &	start,
		const Message_Msg &	amsg )

New name for AddWarning (Msg)

◆ SetActor()

void Transfer_ProcessForFinder::SetActor ( const 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)

◆ SetErrorHandle()

void Transfer_ProcessForFinder::SetErrorHandle ( const Standard_Boolean 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.

◆ SetMessenger()

void Transfer_ProcessForFinder::SetMessenger ( const Handle< Message_Messenger > & messenger )

Sets Messenger used for outputting messages.

◆ SetRoot()

void Transfer_ProcessForFinder::SetRoot ( const Handle< Transfer_Finder > & start )

Declares <obj> (and its Result) as Root. This status will be later exploited by RootResult, see below (Result can be produced at any time)

◆ SetRootManagement()

void Transfer_ProcessForFinder::SetRootManagement ( const Standard_Boolean 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.

◆ SetTraceLevel()

void Transfer_ProcessForFinder::SetTraceLevel ( const Standard_Integer 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.

◆ StartTrace()

void Transfer_ProcessForFinder::StartTrace	(	const Handle< Transfer_Binder > &	binder,
		const Handle< Transfer_Finder > &	start,
		const Standard_Integer	level,
		const Standard_Integer	mode ) 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.

◆ TraceLevel()

Standard_Integer Transfer_ProcessForFinder::TraceLevel ( ) const

Returns trace level used for outputting messages.

◆ Transfer()

Standard_Boolean Transfer_ProcessForFinder::Transfer	(	const Handle< Transfer_Finder > &	start,
		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)

◆ Transferring()

Handle< Transfer_Binder > Transfer_ProcessForFinder::Transferring	(	const Handle< Transfer_Finder > &	start,
		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.

◆ Unbind()

Standard_Boolean Transfer_ProcessForFinder::Unbind ( const Handle< Transfer_Finder > & start )

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.

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

Transfer_ProcessForFinder.hxx

Public Member Functions

Additional Inherited Members