Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
Transfer_ActorOfTransientProcess Class Reference

The original class was renamed. Compatibility only. More...

#include <Transfer_ActorOfTransientProcess.hxx>

Inheritance diagram for Transfer_ActorOfTransientProcess:
Inheritance graph
[legend]

Public Member Functions

 Transfer_ActorOfTransientProcess ()
 
occ::handle< Transfer_BinderTransferring (const occ::handle< Standard_Transient > &start, const occ::handle< Transfer_ProcessForTransient > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 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.
 
virtual occ::handle< Transfer_BinderTransfer (const occ::handle< Standard_Transient > &start, const occ::handle< Transfer_TransientProcess > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange())
 
virtual occ::handle< Standard_TransientTransferTransient (const occ::handle< Standard_Transient > &start, const occ::handle< Transfer_TransientProcess > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange())
 
void SetShapeFixParameters (const XSAlgo_ShapeProcessor::ParameterMap &theParameters)
 Sets parameters for shape processing.
 
void SetShapeFixParameters (XSAlgo_ShapeProcessor::ParameterMap &&theParameters)
 Sets parameters for shape processing. Parameters are moved from the input map.
 
void SetShapeFixParameters (const DE_ShapeFixParameters &theParameters, const XSAlgo_ShapeProcessor::ParameterMap &theAdditionalParameters={})
 Sets parameters for shape processing. Parameters from theParameters are copied to the internal map. Parameters from theAdditionalParameters are copied to the internal map if they are not present in theParameters.
 
const XSAlgo_ShapeProcessor::ParameterMapGetShapeFixParameters () const
 Returns parameters for shape processing that was set by SetParameters() method.
 
void SetProcessingFlags (const ShapeProcess::OperationsFlags &theFlags)
 Sets flags defining operations to be performed on shapes.
 
const XSAlgo_ShapeProcessor::ProcessingFlagsGetProcessingFlags () const
 Returns flags defining operations to be performed on shapes.
 
- Public Member Functions inherited from Transfer_ActorOfProcessForTransient
 Transfer_ActorOfProcessForTransient ()
 
virtual bool Recognize (const occ::handle< Standard_Transient > &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.
 
occ::handle< Transfer_SimpleBinderOfTransientTransientResult (const occ::handle< Standard_Transient > &res) const
 Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null.
 
occ::handle< Transfer_BinderNullResult () const
 Returns a Binder for No Result, i.e. a Null Handle.
 
void SetLast (const bool mode=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)
 
bool IsLast () const
 Returns the Last status (see SetLast).
 
void SetNext (const occ::handle< Transfer_ActorOfProcessForTransient > &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.
 
occ::handle< Transfer_ActorOfProcessForTransientNext () 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_Transientoperator= (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_TransientThis () 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 charget_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.
 

Detailed Description

The original class was renamed. Compatibility only.

Constructor & Destructor Documentation

◆ Transfer_ActorOfTransientProcess()

Transfer_ActorOfTransientProcess::Transfer_ActorOfTransientProcess ( )

Member Function Documentation

◆ GetProcessingFlags()

const XSAlgo_ShapeProcessor::ProcessingFlags & Transfer_ActorOfTransientProcess::GetProcessingFlags ( ) const
inline

Returns flags defining operations to be performed on shapes.

Returns
Pair: the flags defining operations to be performed on shapes and a boolean value that indicates whether the flags were set.

◆ GetShapeFixParameters()

const XSAlgo_ShapeProcessor::ParameterMap & Transfer_ActorOfTransientProcess::GetShapeFixParameters ( ) const
inline

Returns parameters for shape processing that was set by SetParameters() method.

Returns
the parameters for shape processing. Empty map if no parameters were set.

◆ SetProcessingFlags()

void Transfer_ActorOfTransientProcess::SetProcessingFlags ( const ShapeProcess::OperationsFlags & theFlags)

Sets flags defining operations to be performed on shapes.

Parameters
theFlagsThe flags defining operations to be performed on shapes.

◆ SetShapeFixParameters() [1/3]

void Transfer_ActorOfTransientProcess::SetShapeFixParameters ( const DE_ShapeFixParameters & theParameters,
const XSAlgo_ShapeProcessor::ParameterMap & theAdditionalParameters = {} )

Sets parameters for shape processing. Parameters from theParameters are copied to the internal map. Parameters from theAdditionalParameters are copied to the internal map if they are not present in theParameters.

Parameters
theParametersthe parameters for shape processing.
theAdditionalParametersthe additional parameters for shape processing.

◆ SetShapeFixParameters() [2/3]

void Transfer_ActorOfTransientProcess::SetShapeFixParameters ( const XSAlgo_ShapeProcessor::ParameterMap & theParameters)

Sets parameters for shape processing.

Parameters
theParametersthe parameters for shape processing.

◆ SetShapeFixParameters() [3/3]

void Transfer_ActorOfTransientProcess::SetShapeFixParameters ( XSAlgo_ShapeProcessor::ParameterMap && theParameters)

Sets parameters for shape processing. Parameters are moved from the input map.

Parameters
theParametersthe parameters for shape processing.

◆ Transfer()

virtual occ::handle< Transfer_Binder > Transfer_ActorOfTransientProcess::Transfer ( const occ::handle< Standard_Transient > & start,
const occ::handle< Transfer_TransientProcess > & TP,
const Message_ProgressRange & theProgress = Message_ProgressRange() )
virtual

◆ Transferring()

occ::handle< Transfer_Binder > Transfer_ActorOfTransientProcess::Transferring ( const occ::handle< Standard_Transient > & start,
const occ::handle< Transfer_ProcessForTransient > & TP,
const Message_ProgressRange & theProgress = Message_ProgressRange() )
overridevirtual

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

◆ TransferTransient()

virtual occ::handle< Standard_Transient > Transfer_ActorOfTransientProcess::TransferTransient ( const occ::handle< Standard_Transient > & start,
const occ::handle< Transfer_TransientProcess > & TP,
const Message_ProgressRange & theProgress = Message_ProgressRange() )
virtual

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