This selection selects the entities which are recognised for transfer by an Actor for Read : current one or another one. More...

#include <XSControl_SelectForTransfer.hxx>

Inheritance diagram for XSControl_SelectForTransfer:

[legend]

Public Member Functions
	XSControl_SelectForTransfer ()
	Creates a SelectForTransfer, non initialised it sorts nothing, unless an Actor has been defined.
	XSControl_SelectForTransfer (const occ::handle< XSControl_TransferReader > &TR)
	Creates a SelectForTransfer, which will work with the currently defined Actor brought by the TransferReader.
void	SetReader (const occ::handle< XSControl_TransferReader > &TR)
	Sets a TransferReader to sort entities : it brings the Actor, which may change, while the TransferReader does not.
void	SetActor (const occ::handle< Transfer_ActorOfTransientProcess > &act)
	Sets a precise actor to sort entities This definition oversedes the creation with a TransferReader.
occ::handle< Transfer_ActorOfTransientProcess >	Actor () const
	Returns the Actor used as precised one. Returns a Null Handle for a creation from a TransferReader without any further setting.
occ::handle< XSControl_TransferReader >	Reader () const
	Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader.
bool	Sort (const int rank, const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const override
	Returns True for an Entity which is recognized by the Actor, either the precised one, or the one defined by TransferReader.
TCollection_AsciiString	ExtractLabel () const override
	Returns a text defining the criterium : "Recognized for Transfer [(current actor)]".
Public Member Functions inherited from IFSelect_SelectExtract
bool	IsDirect () const
	Returns True if Sort criterium is Direct, False if Reverse.
void	SetDirect (const bool direct)
	Sets Sort criterium sense to a new value (True : Direct , False : Reverse).
Interface_EntityIterator	RootResult (const Interface_Graph &G) const override
	Returns the list of selected entities. Works by calling the method Sort on each input Entity : the Entity is kept as output if Sort returns the same value as Direct status.
virtual bool	SortInGraph (const int rank, const occ::handle< Standard_Transient > &ent, const Interface_Graph &G) const
	Works as Sort but works on the Graph Default directly calls Sort, but it can be redefined If SortInGraph is redefined, Sort should be defined even if not called (to avoid deferred methods in a final class).
TCollection_AsciiString	Label () const override
	Returns a text saying "Picked" or "Removed", plus the specific criterium returned by ExtractLabel (see below).
Public Member Functions inherited from IFSelect_SelectDeduct
void	SetInput (const occ::handle< IFSelect_Selection > &sel)
	Defines or Changes the Input Selection.
occ::handle< IFSelect_Selection >	Input () const
	Returns the Input Selection.
bool	HasInput () const
	Returns True if the Input Selection is defined, False else.
bool	HasAlternate () const
	Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set.
occ::handle< IFSelect_SelectPointed > &	Alternate ()
	Returns the Alternate Definition It is returned modifiable, hence an already defined SelectPointed can be used But if it was not yet defined, it is created the first time.
Interface_EntityIterator	InputResult (const Interface_Graph &G) const
	Returns the Result determined by Input Selection, as Unique if Input Selection is not defined, returns an empty list.
void	FillIterator (IFSelect_SelectionIterator &iter) const override
	Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection.
Public Member Functions inherited from IFSelect_Selection
Interface_EntityIterator	UniqueResult (const Interface_Graph &G) const
	Returns the list of selected entities, each of them being unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph.
virtual Interface_EntityIterator	CompleteResult (const Interface_Graph &G) const
	Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not).
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
typedef void	base_type
	Returns a type descriptor about this object.
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 IFSelect_SelectExtract
	IFSelect_SelectExtract ()
	Initializes a SelectExtract : enforces the sort to be Direct.
Protected Member Functions inherited from IFSelect_Selection
virtual bool	HasUniqueResult () const
	Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined.

Detailed Description

This selection selects the entities which are recognised for transfer by an Actor for Read : current one or another one.

An Actor is an operator which runs transfers from interface entities to objects for Imagine. It has a method to recognize the entities it can process (by default, it recognises all, this method can be redefined).

A TransferReader brings an Actor, according to the currently selected norm and transfer conditions.

This selection considers, either the current Actor (brought by the TransferReader, updated as required), or a precise one.

Constructor & Destructor Documentation

◆ XSControl_SelectForTransfer() [1/2]

XSControl_SelectForTransfer::XSControl_SelectForTransfer ( )

Creates a SelectForTransfer, non initialised it sorts nothing, unless an Actor has been defined.

◆ XSControl_SelectForTransfer() [2/2]

XSControl_SelectForTransfer::XSControl_SelectForTransfer ( const occ::handle< XSControl_TransferReader > & TR )

Creates a SelectForTransfer, which will work with the currently defined Actor brought by the TransferReader.

Member Function Documentation

◆ Actor()

occ::handle< Transfer_ActorOfTransientProcess > XSControl_SelectForTransfer::Actor ( ) const

Returns the Actor used as precised one. Returns a Null Handle for a creation from a TransferReader without any further setting.

◆ ExtractLabel()

TCollection_AsciiString XSControl_SelectForTransfer::ExtractLabel ( ) const

overridevirtual

Returns a text defining the criterium : "Recognized for Transfer [(current actor)]".

Implements IFSelect_SelectExtract.

◆ Reader()

occ::handle< XSControl_TransferReader > XSControl_SelectForTransfer::Reader ( ) const

Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader.

◆ SetActor()

void XSControl_SelectForTransfer::SetActor ( const occ::handle< Transfer_ActorOfTransientProcess > & act )

Sets a precise actor to sort entities This definition oversedes the creation with a TransferReader.

◆ SetReader()

void XSControl_SelectForTransfer::SetReader ( const occ::handle< XSControl_TransferReader > & TR )

Sets a TransferReader to sort entities : it brings the Actor, which may change, while the TransferReader does not.

◆ Sort()

bool XSControl_SelectForTransfer::Sort	(	const int	rank,
		const occ::handle< Standard_Transient > &	ent,
		const occ::handle< Interface_InterfaceModel > &	model ) const