This binder binds several (a list of) Transients with a starting entity, when this entity itself corresponds to a simple list of Transients. Each part is not seen as a sub-result of an independent component, but as an item of a built-in list. More...

#include <Transfer_TransientListBinder.hxx>

Inheritance diagram for Transfer_TransientListBinder:

[legend]

Public Member Functions
	Transfer_TransientListBinder ()

	Transfer_TransientListBinder (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)

bool	IsMultiple () const override
	Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes.

occ::handle< Standard_Type >	ResultType () const override
	Returns the Type which characterizes the Result (if known)

const char *	ResultTypeName () const override
	Returns the Name of the Type which characterizes the Result Can be returned even if ResultType itself is unknown.

void	AddResult (const occ::handle< Standard_Transient > &res)
	Adds an item to the result list.

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	Result () const

void	SetResult (const int num, const occ::handle< Standard_Transient > &res)
	Changes an already defined sub-result.

int	NbTransients () const

const occ::handle< Standard_Transient > &	Transient (const int num) const

Public Member Functions inherited from Transfer_Binder
void	Merge (const occ::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.

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

occ::handle< Transfer_Binder >	NextResult () const
	Returns the next result, Null if none.

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

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

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)

Transfer_StatusExec	StatusExec () const
	Returns execution status.

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

void	AddFail (const char const mess, const char const orig="")
	Used to declare an individual transfer as being 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.

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

const occ::handle< Interface_Check >	Check () const
	Returns Check which stores Fail messages Note that no Entity is associated in this Check.

occ::handle< Interface_Check >	CCheck ()
	Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it)

	~Transfer_Binder () override
	Destructor.

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

Protected Member Functions inherited from Transfer_Binder
	Transfer_Binder ()
	Sets fields at initial values.

void	SetResultPresent ()
	Used to declare that a result is recorded for an individual transfer (works by setting StatusResult to Defined)

Detailed Description

This binder binds several (a list of) Transients with a starting entity, when this entity itself corresponds to a simple list of Transients. Each part is not seen as a sub-result of an independent component, but as an item of a built-in list.

Constructor & Destructor Documentation

◆ Transfer_TransientListBinder() [1/2]

Transfer_TransientListBinder::Transfer_TransientListBinder ( )

◆ Transfer_TransientListBinder() [2/2]

Transfer_TransientListBinder::Transfer_TransientListBinder ( const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > & list )

Member Function Documentation

◆ AddResult()

void Transfer_TransientListBinder::AddResult ( const occ::handle< Standard_Transient > & res )

Adds an item to the result list.

◆ IsMultiple()

bool Transfer_TransientListBinder::IsMultiple ( ) const

overridevirtual

Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes.

Reimplemented from Transfer_Binder.

◆ NbTransients()

int Transfer_TransientListBinder::NbTransients ( ) const

◆ Result()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > Transfer_TransientListBinder::Result ( ) const

◆ ResultType()

occ::handle< Standard_Type > Transfer_TransientListBinder::ResultType ( ) const

overridevirtual

Returns the Type which characterizes the Result (if known)

Implements Transfer_Binder.

◆ ResultTypeName()

const char * Transfer_TransientListBinder::ResultTypeName ( ) const

overridevirtual

Returns the Name of the Type which characterizes the Result Can be returned even if ResultType itself is unknown.

Implements Transfer_Binder.

◆ SetResult()

void Transfer_TransientListBinder::SetResult	(	const int	num,
		const occ::handle< Standard_Transient > &	res )

Changes an already defined sub-result.

◆ Transient()

const occ::handle< Standard_Transient > & Transfer_TransientListBinder::Transient ( const int num ) const

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

Transfer_TransientListBinder.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Transfer_TransientListBinder() [1/2]

◆ Transfer_TransientListBinder() [2/2]

Member Function Documentation

◆ AddResult()

◆ IsMultiple()

◆ NbTransients()

◆ Result()

◆ ResultType()

◆ ResultTypeName()

◆ SetResult()

◆ Transient()