Allows direct binding between a starting Object and the Result of its transfer when it is Unique. The Result itself is defined as a formal parameter <Shape from="" topods>=""> Warning : While it is possible to instantiate BinderOfShape with any Type for the Result, it is not advisable to instantiate it with Transient Classes, because such Results are directly known and managed by TransferProcess & Co, through SimpleBinderOfTransient : this class looks like instantiation of BinderOfShape, but its method ResultType is adapted (reads DynamicType of the Result) More...

#include <TransferBRep_BinderOfShape.hxx>

Inheritance diagram for TransferBRep_BinderOfShape:

[legend]

Public Member Functions
	TransferBRep_BinderOfShape ()
	normal standard constructor, creates an empty BinderOfShape More...

	TransferBRep_BinderOfShape (const TopoDS_Shape &res)
	constructor which in the same time defines the result Returns True if a starting object is bound with SEVERAL results : Here, returns allways False But it can have next results More...

Handle< Standard_Type >	ResultType () const
	Returns the Type permitted for the Result, i.e. the Type of the Parameter Class <Shape from="" topods>=""> (statically defined) More...

Standard_CString	ResultTypeName () const
	Returns the Type Name computed for the Result (dynamic) More...

void	SetResult (const TopoDS_Shape &res)
	Defines the Result. More...

const TopoDS_Shape &	Result () const
	Returns the defined Result, if there is one. More...

TopoDS_Shape &	CResult ()
	Returns the defined Result, if there is one, and allows to change it (avoids Result + SetResult). Admits that Result can be not yet defined Warning : a call to CResult causes Result to be known as 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...

virtual Standard_Boolean	IsMultiple () const
	Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes. 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 (Status is set to Void, StatusExec is set to Error, <errmess> is added to Check's list of Fails) It is possible to record several messages of error. 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 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 transfer (works by setting StatusResult to Defined) More...

Detailed Description

Allows direct binding between a starting Object and the Result of its transfer when it is Unique. The Result itself is defined as a formal parameter <Shape from="" topods>=""> Warning : While it is possible to instantiate BinderOfShape with any Type for the Result, it is not advisable to instantiate it with Transient Classes, because such Results are directly known and managed by TransferProcess & Co, through SimpleBinderOfTransient : this class looks like instantiation of BinderOfShape, but its method ResultType is adapted (reads DynamicType of the Result)

Constructor & Destructor Documentation

TransferBRep_BinderOfShape::TransferBRep_BinderOfShape ( )

normal standard constructor, creates an empty BinderOfShape

TransferBRep_BinderOfShape::TransferBRep_BinderOfShape ( const TopoDS_Shape & res )

constructor which in the same time defines the result Returns True if a starting object is bound with SEVERAL results : Here, returns allways False But it can have next results

Member Function Documentation

TopoDS_Shape& TransferBRep_BinderOfShape::CResult ( )

Returns the defined Result, if there is one, and allows to change it (avoids Result + SetResult). Admits that Result can be not yet defined Warning : a call to CResult causes Result to be known as defined.

const TopoDS_Shape& TransferBRep_BinderOfShape::Result ( ) const

Returns the defined Result, if there is one.

Handle< Standard_Type > TransferBRep_BinderOfShape::ResultType ( ) const

virtual

Returns the Type permitted for the Result, i.e. the Type of the Parameter Class <Shape from="" topods>=""> (statically defined)

Implements Transfer_Binder.

Standard_CString TransferBRep_BinderOfShape::ResultTypeName ( ) const

virtual

Returns the Type Name computed for the Result (dynamic)

Implements Transfer_Binder.

void TransferBRep_BinderOfShape::SetResult ( const TopoDS_Shape & res )

Defines the Result.