#include <Transfer_ActorOfProcessForFinder.hxx>

Inheritance diagram for Transfer_ActorOfProcessForFinder:

[legend]

Public Member Functions
	Transfer_ActorOfProcessForFinder ()

virtual Standard_Boolean	Recognize (const Handle< Transfer_Finder > &start)
	Prerequisite for Transfer : the method Transfer is called on a starting object only if Recognize has returned True on it This allows to define a list of Actors, each one processing a definite kind of data TransferProcess calls Recognize on each one before calling Transfer. But even if Recognize has returned True, Transfer can reject by returning a Null Binder (afterwards rejection), the next actor is then invoked.

virtual Handle< Transfer_Binder >	Transferring (const Handle< Transfer_Finder > &start, const Handle< Transfer_ProcessForFinder > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Specific action of Transfer. The Result is stored in the returned Binder, or a Null Handle for "No result" (Default defined as doing nothing; should be deferred) "mutable" allows the Actor to record intermediate information, in addition to those of TransferProcess.

Handle< Transfer_SimpleBinderOfTransient >	TransientResult (const Handle< Standard_Transient > &res) const
	Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null.

Handle< Transfer_Binder >	NullResult () const
	Returns a Binder for No Result, i.e. a Null Handle.

void	SetLast (const Standard_Boolean mode=Standard_True)
	If <mode> is True, commands an Actor to be set at the end of the list of Actors (see SetNext) If it is False (creation default), each add Actor is set at the beginning of the list This allows to define default Actors (which are Last)

Standard_Boolean	IsLast () const
	Returns the Last status (see SetLast).

void	SetNext (const Handle< Transfer_ActorOfProcessForFinder > &next)
	Defines a Next Actor : it can then be asked to work if <me> produces no result for a given type of Object. If Next is already set and is not "Last", calls SetNext on it. If Next defined and "Last", the new actor is added before it in the list.

Handle< Transfer_ActorOfProcessForFinder >	Next () const
	Returns the Actor defined as Next, or a Null Handle.

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_ActorOfProcessForFinder()

Transfer_ActorOfProcessForFinder::Transfer_ActorOfProcessForFinder ( )

Member Function Documentation

◆ IsLast()

Standard_Boolean Transfer_ActorOfProcessForFinder::IsLast ( ) const

Returns the Last status (see SetLast).

◆ Next()

Handle< Transfer_ActorOfProcessForFinder > Transfer_ActorOfProcessForFinder::Next ( ) const

Returns the Actor defined as Next, or a Null Handle.

◆ NullResult()

Handle< Transfer_Binder > Transfer_ActorOfProcessForFinder::NullResult ( ) const

Returns a Binder for No Result, i.e. a Null Handle.

◆ Recognize()

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

virtual

Prerequisite for Transfer : the method Transfer is called on a starting object only if Recognize has returned True on it This allows to define a list of Actors, each one processing a definite kind of data TransferProcess calls Recognize on each one before calling Transfer. But even if Recognize has returned True, Transfer can reject by returning a Null Binder (afterwards rejection), the next actor is then invoked.

The provided default returns True, can be redefined

Reimplemented in IGESControl_ActorWrite, and STEPControl_ActorWrite.

◆ SetLast()

void Transfer_ActorOfProcessForFinder::SetLast ( const Standard_Boolean mode = Standard_True )

If <mode> is True, commands an Actor to be set at the end of the list of Actors (see SetNext) If it is False (creation default), each add Actor is set at the beginning of the list This allows to define default Actors (which are Last)

◆ SetNext()

void Transfer_ActorOfProcessForFinder::SetNext ( const Handle< Transfer_ActorOfProcessForFinder > & next )

Defines a Next Actor : it can then be asked to work if <me> produces no result for a given type of Object. If Next is already set and is not "Last", calls SetNext on it. If Next defined and "Last", the new actor is added before it in the list.

◆ Transferring()

virtual Handle< Transfer_Binder > Transfer_ActorOfProcessForFinder::Transferring	(	const Handle< Transfer_Finder > &	start,
		const Handle< Transfer_ProcessForFinder > &	TP,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Specific action of Transfer. The Result is stored in the returned Binder, or a Null Handle for "No result" (Default defined as doing nothing; should be deferred) "mutable" allows the Actor to record intermediate information, in addition to those of TransferProcess.

Reimplemented in Transfer_ActorOfFinderProcess.

◆ TransientResult()

Handle< Transfer_SimpleBinderOfTransient > Transfer_ActorOfProcessForFinder::TransientResult ( const Handle< Standard_Transient > & res ) const

Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null.

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

Transfer_ActorOfProcessForFinder.hxx

Public Member Functions

Additional Inherited Members