Open CASCADE Technology 7.8.2.dev
STEPControl_ActorWrite Class Reference

This class performs the transfer of a Shape from TopoDS to AP203 or AP214 (CD2 or DIS) More...

#include <STEPControl_ActorWrite.hxx>

Inheritance diagram for STEPControl_ActorWrite:

Public Member Functions

 STEPControl_ActorWrite ()
 
virtual Standard_Boolean Recognize (const Handle< Transfer_Finder > &start) override
 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.
 
virtual Handle< Transfer_BinderTransfer (const Handle< Transfer_Finder > &start, const Handle< Transfer_FinderProcess > &FP, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 
Handle< Transfer_BinderTransferSubShape (const Handle< Transfer_Finder > &start, const Handle< StepShape_ShapeDefinitionRepresentation > &SDR, Handle< StepGeom_Axis2Placement3d > &AX1, const Handle< Transfer_FinderProcess > &FP, const StepData_Factors &theLocalFactors=StepData_Factors(), const Handle< TopTools_HSequenceOfShape > &shapeGroup=NULL, const Standard_Boolean isManifold=Standard_True, const Message_ProgressRange &theProgress=Message_ProgressRange())
 
Handle< Transfer_BinderTransferShape (const Handle< Transfer_Finder > &start, const Handle< StepShape_ShapeDefinitionRepresentation > &SDR, const Handle< Transfer_FinderProcess > &FP, const StepData_Factors &theLocalFactors=StepData_Factors(), const Handle< TopTools_HSequenceOfShape > &shapeGroup=NULL, const Standard_Boolean isManifold=Standard_True, const Message_ProgressRange &theProgress=Message_ProgressRange())
 
Handle< Transfer_BinderTransferCompound (const Handle< Transfer_Finder > &start, const Handle< StepShape_ShapeDefinitionRepresentation > &SDR, const Handle< Transfer_FinderProcess > &FP, const StepData_Factors &theLocalFactors=StepData_Factors(), const Message_ProgressRange &theProgress=Message_ProgressRange())
 
void SetMode (const STEPControl_StepModelType M)
 
STEPControl_StepModelType Mode () const
 
void SetGroupMode (const Standard_Integer mode)
 
Standard_Integer GroupMode () const
 
void SetTolerance (const Standard_Real Tol)
 
virtual Standard_Boolean IsAssembly (const Handle< StepData_StepModel > &theModel, TopoDS_Shape &S) const
 Customizable method to check whether shape S should be written as assembly or not Default implementation uses flag GroupMode and analyses the shape itself NOTE: this method can modify shape.
 
- Public Member Functions inherited from Transfer_ActorOfFinderProcess
 Transfer_ActorOfFinderProcess ()
 
Standard_IntegerModeTrans ()
 Returns the Transfer Mode, modifiable.
 
virtual Handle< Transfer_BinderTransferring (const Handle< Transfer_Finder > &start, const Handle< Transfer_ProcessForFinder > &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 Handle< Standard_TransientTransferTransient (const Handle< Standard_Transient > &start, const Handle< Transfer_FinderProcess > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange())
 
- Public Member Functions inherited from Transfer_ActorOfProcessForFinder
 Transfer_ActorOfProcessForFinder ()
 
Handle< Transfer_SimpleBinderOfTransientTransientResult (const Handle< Standard_Transient > &res) const
 Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null.
 
Handle< Transfer_BinderNullResult () const
 Returns a Binder for No Result, i.e. a Null Handle.
 
void SetLast (const Standard_Boolean mode=Standard_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)
 
Standard_Boolean IsLast () const
 Returns the Last status (see SetLast).
 
void SetNext (const Handle< Transfer_ActorOfProcessForFinder > &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.
 
Handle< Transfer_ActorOfProcessForFinderNext () 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 ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean 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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
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 Attributes inherited from Transfer_ActorOfFinderProcess
Standard_Integer themodetrans
 

Detailed Description

This class performs the transfer of a Shape from TopoDS to AP203 or AP214 (CD2 or DIS)

Constructor & Destructor Documentation

◆ STEPControl_ActorWrite()

STEPControl_ActorWrite::STEPControl_ActorWrite ( )

Member Function Documentation

◆ GroupMode()

Standard_Integer STEPControl_ActorWrite::GroupMode ( ) const

◆ IsAssembly()

virtual Standard_Boolean STEPControl_ActorWrite::IsAssembly ( const Handle< StepData_StepModel > & theModel,
TopoDS_Shape & S ) const
virtual

Customizable method to check whether shape S should be written as assembly or not Default implementation uses flag GroupMode and analyses the shape itself NOTE: this method can modify shape.

Reimplemented in STEPCAFControl_ActorWrite.

◆ Mode()

STEPControl_StepModelType STEPControl_ActorWrite::Mode ( ) const

◆ Recognize()

virtual Standard_Boolean STEPControl_ActorWrite::Recognize ( const Handle< Transfer_Finder > & start)
overridevirtual

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.

The provided default returns True, can be redefined

Reimplemented from Transfer_ActorOfProcessForFinder.

◆ SetGroupMode()

void STEPControl_ActorWrite::SetGroupMode ( const Standard_Integer mode)

◆ SetMode()

void STEPControl_ActorWrite::SetMode ( const STEPControl_StepModelType M)

◆ SetTolerance()

void STEPControl_ActorWrite::SetTolerance ( const Standard_Real Tol)

◆ Transfer()

virtual Handle< Transfer_Binder > STEPControl_ActorWrite::Transfer ( const Handle< Transfer_Finder > & start,
const Handle< Transfer_FinderProcess > & FP,
const Message_ProgressRange & theProgress = Message_ProgressRange() )
overridevirtual

Reimplemented from Transfer_ActorOfFinderProcess.

◆ TransferCompound()

Handle< Transfer_Binder > STEPControl_ActorWrite::TransferCompound ( const Handle< Transfer_Finder > & start,
const Handle< StepShape_ShapeDefinitionRepresentation > & SDR,
const Handle< Transfer_FinderProcess > & FP,
const StepData_Factors & theLocalFactors = StepData_Factors(),
const Message_ProgressRange & theProgress = Message_ProgressRange() )

◆ TransferShape()

Handle< Transfer_Binder > STEPControl_ActorWrite::TransferShape ( const Handle< Transfer_Finder > & start,
const Handle< StepShape_ShapeDefinitionRepresentation > & SDR,
const Handle< Transfer_FinderProcess > & FP,
const StepData_Factors & theLocalFactors = StepData_Factors(),
const Handle< TopTools_HSequenceOfShape > & shapeGroup = NULL,
const Standard_Boolean isManifold = Standard_True,
const Message_ProgressRange & theProgress = Message_ProgressRange() )

◆ TransferSubShape()

Handle< Transfer_Binder > STEPControl_ActorWrite::TransferSubShape ( const Handle< Transfer_Finder > & start,
const Handle< StepShape_ShapeDefinitionRepresentation > & SDR,
Handle< StepGeom_Axis2Placement3d > & AX1,
const Handle< Transfer_FinderProcess > & FP,
const StepData_Factors & theLocalFactors = StepData_Factors(),
const Handle< TopTools_HSequenceOfShape > & shapeGroup = NULL,
const Standard_Boolean isManifold = Standard_True,
const Message_ProgressRange & theProgress = Message_ProgressRange() )

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