Allows direct binding between a starting Object and the Result
of its transfer, when it can be made of several Transient
Objects. Compared to a Transcriptor, it has no Transfer Action

Result is a list of Transient Results. Unique Result is not
available : SetResult is redefined to start the list on the
first call, and refuse the other times.

rr

Remark : MultipleBinder itself is intended to be created and
filled by TransferProcess itself (method Bind). In particular,
conflicts between Unique (Standard) result and Multiple result
are avoided through management made by TransferProcess.

Also, a Transcriptor (with an effective Transfer Method) which
can produce a Multiple Result, may be defined as a sub-class
of MultipleBinder by redefining method Transfer.
More...

#include <Transfer_MultipleBinder.hxx>

Inheritance diagram for Transfer_MultipleBinder:

[legend]

Public Member Functions
	Transfer_MultipleBinder ()
	normal standard constructor, creates an empty MultipleBinder More...

virtual Standard_Boolean	IsMultiple () const
	Returns True if a starting object is bound with SEVERAL results : Here, returns allways True More...

Handle_Standard_Type	ResultType () const
	Returns the Type permitted for Results, i.e. here Transient More...

Standard_CString	ResultTypeName () const
	Returns the Name of the Type which characterizes the Result Here, returns "(list)" More...

void	AddResult (const Handle< Standard_Transient > &res)
	Adds a new Item to the Multiple Result More...

Standard_Integer	NbResults () const
	Returns the actual count of recorded (Transient) results More...

Handle_Standard_Transient	ResultValue (const Standard_Integer num) const
	Returns the value of the recorded result n0 <num> More...

Handle_TColStd_HSequenceOfTransient	MultipleResult () const
	Returns the Multiple Result, if it is defined (at least one Item). Else, returns a Null Handle More...

void	SetMultipleResult (const Handle< TColStd_HSequenceOfTransient > &mulres)
	Defines a Binding with a Multiple Result, given as a Sequence Error if a Unique Result has yet been defined More...

Public Member Functions inherited from Transfer_Binder
void	Merge (const Handle< Transfer_Binder > &other)
	Merges basic data (Check, ExecStatus) from another Binder but keeps its result. Used when a binder is replaced by another one, this allows to keep messages More...

void	AddResult (const Handle< Transfer_Binder > &next)
	Adds a next result (at the end of the list) Remark : this information is not processed by Merge More...

Handle_Transfer_Binder	NextResult () const
	Returns the next result, Null if none More...

Standard_Boolean	HasResult () const
	Returns True if a Result is available (StatusResult = Defined) A Unique Result will be gotten by Result (which must be defined in each sub-class according to result type) For a Multiple Result, see class MultipleBinder For other case, specific access has to be forecast More...

void	SetAlreadyUsed ()
	Declares that result is now used by another one, it means that it cannot be modified (by Rebind) More...

Transfer_StatusResult	Status () const
	Returns status, which can be Initial (not yet done), Made (a result is recorded, not yet shared), Used (it is shared and cannot be modified) More...

Transfer_StatusExec	StatusExec () const
	Returns execution status More...

void	SetStatusExec (const Transfer_StatusExec stat)
	Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below) More...

void	AddFail (const Standard_CString mess, const Standard_CString orig="")
	Used to declare an individual transfer as beeing erroneous <br> (Status is set to Void, StatusExec is set to Error, <errmess> <br> is added to Check's list of Fails) <br> It is possible to record several messages of error <br> It has same effect for TransferProcess as raising an exception during the operation of Transfer, except the Transfer tries to continue (as if ErrorHandle had been set) More...

void	AddWarning (const Standard_CString mess, const Standard_CString orig="")
	Used to attach a Warning Message to an individual Transfer It has no effect on the Status More...

const Handle_Interface_Check	Check () const
	Returns Check which stores Fail messages Note that no Entity is associated in this Check More...

Handle_Interface_Check	CCheck ()
	Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it) More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

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

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

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

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const Handle_Standard_Type &theType) const
	Returns a true value if this is an instance of Type. More...

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

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

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

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

Additional Inherited Members
Protected Member Functions inherited from Transfer_Binder
	Transfer_Binder ()
	Sets fields at initial values More...

void	SetResultPresent ()
	Used to declare that a result is recorded for an individual <br> transfer (works by setting StatusResult to Defined) <br> This Method is to be called once a Result is really recorded (see sub-classes of Binder, especially SimpleBinder) : it is senseless if called isolately More...

Detailed Description

Allows direct binding between a starting Object and the Result
of its transfer, when it can be made of several Transient
Objects. Compared to a Transcriptor, it has no Transfer Action

Result is a list of Transient Results. Unique Result is not
available : SetResult is redefined to start the list on the
first call, and refuse the other times.

rr

Remark : MultipleBinder itself is intended to be created and
filled by TransferProcess itself (method Bind). In particular,
conflicts between Unique (Standard) result and Multiple result
are avoided through management made by TransferProcess.

Also, a Transcriptor (with an effective Transfer Method) which
can produce a Multiple Result, may be defined as a sub-class
of MultipleBinder by redefining method Transfer.

Constructor & Destructor Documentation

Transfer_MultipleBinder::Transfer_MultipleBinder ( )

normal standard constructor, creates an empty MultipleBinder

Member Function Documentation

void Transfer_MultipleBinder::AddResult ( const Handle< Standard_Transient > & res )

Adds a new Item to the Multiple Result

virtual Standard_Boolean Transfer_MultipleBinder::IsMultiple ( ) const

virtual

Returns True if a starting object is bound with SEVERAL
results : Here, returns allways True

Reimplemented from Transfer_Binder.

Handle_TColStd_HSequenceOfTransient Transfer_MultipleBinder::MultipleResult ( ) const

Returns the Multiple Result, if it is defined (at least one
Item). Else, returns a Null Handle

Standard_Integer Transfer_MultipleBinder::NbResults ( ) const

Returns the actual count of recorded (Transient) results

Handle_Standard_Type Transfer_MultipleBinder::ResultType ( ) const

virtual

Returns the Type permitted for Results, i.e. here Transient

Implements Transfer_Binder.

Standard_CString Transfer_MultipleBinder::ResultTypeName ( ) const

virtual

Returns the Name of the Type which characterizes the Result
Here, returns "(list)"

Implements Transfer_Binder.

Handle_Standard_Transient Transfer_MultipleBinder::ResultValue ( const Standard_Integer num ) const

Returns the value of the recorded result n0 <num>

void Transfer_MultipleBinder::SetMultipleResult ( const Handle< TColStd_HSequenceOfTransient > & mulres )

Defines a Binding with a Multiple Result, given as a Sequence
Error if a Unique Result has yet been defined

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

Transfer_MultipleBinder.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation