OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    STEPControl_ActorRead Class Reference

    This class performs the transfer of an Entity from AP214 and AP203, either Geometric or Topologic. More...

    #include <STEPControl_ActorRead.hxx>

    Inheritance diagram for STEPControl_ActorRead:

    Public Member Functions

     STEPControl_ActorRead (const occ::handle< Interface_InterfaceModel > &theModel)
    bool Recognize (const occ::handle< Standard_Transient > &startstart) 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.
    occ::handle< Transfer_BinderTransfer (const occ::handle< Standard_Transient > &startstart, const occ::handle< Transfer_TransientProcess > &TP, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
    occ::handle< Transfer_BinderTransferShape (const occ::handle< Standard_Transient > &startstart, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors=StepData_Factors(), const bool isManifold=true, const bool theUseTrsf=false, const Message_ProgressRange &theProgress=Message_ProgressRange())
     theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape
    void PrepareUnits (const occ::handle< StepRepr_Representation > &rep, const occ::handle< Transfer_TransientProcess > &TP, StepData_Factors &theLocalFactors)
     set units and tolerances context by given ShapeRepresentation
    void ResetUnits (const occ::handle< StepData_StepModel > &theModel, StepData_Factors &theLocalFactors)
     reset units and tolerances context to default (mm, radians, read.precision.val, etc.)
    void SetModel (const occ::handle< Interface_InterfaceModel > &theModel)
     Set model.
    bool ComputeTransformation (const occ::handle< StepGeom_Axis2Placement3d > &Origin, const occ::handle< StepGeom_Axis2Placement3d > &Target, const occ::handle< StepRepr_Representation > &OrigContext, const occ::handle< StepRepr_Representation > &TargContext, const occ::handle< Transfer_TransientProcess > &TP, gp_Trsf &Trsf, const StepData_Factors &theLocalFactors=StepData_Factors())
     Computes transformation defined by two axis placements (in MAPPED_ITEM or ITEM_DEFINED_TRANSFORMATION) taking into account their representation contexts (i.e. units, which may be different) Returns True if transformation is computed and is not an identity.
    bool ComputeSRRWT (const occ::handle< StepRepr_RepresentationRelationship > &SRR, const occ::handle< Transfer_TransientProcess > &TP, gp_Trsf &Trsf, const StepData_Factors &theLocalFactors=StepData_Factors())
     Computes transformation defined by given REPRESENTATION_RELATIONSHIP_WITH_TRANSFORMATION.
    Public Member Functions inherited from Transfer_ActorOfTransientProcess
     Transfer_ActorOfTransientProcess ()
    occ::handle< Transfer_BinderTransferring (const occ::handle< Standard_Transient > &startstart, 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< Standard_TransientTransferTransient (const occ::handle< Standard_Transient > &startstart, 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 ()
    occ::handle< Transfer_SimpleBinderOfTransientTransientResult (const occ::handle< Standard_Transient > &resres) 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 modemode=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.

    Protected Member Functions

    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepBasic_ProductDefinition > &PD, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors=StepData_Factors(), const bool theUseTrsf=false, const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers product definition entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepRepr_NextAssemblyUsageOccurrence > &NAUO, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors=StepData_Factors(), const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers next assembly usage occurrence entity.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepShape_ShapeRepresentation > &sr, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors, bool &isBound, const bool theUseTrsf=false, const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers shape representation entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepShape_ContextDependentShapeRepresentation > &CDSR, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors=StepData_Factors(), const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers context dependent shape representation entity.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepRepr_ShapeRepresentationRelationship > &und, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors, const int nbrep=0, const bool theUseTrsf=false, const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers shape representation relationship entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepGeom_GeometricRepresentationItem > &git, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors, const bool isManifold, const Message_ProgressRange &theProgress)
     Transfers geometric representation item entity such as ManifoldSolidBRep ,...etc.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepRepr_MappedItem > &mapit, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors, const Message_ProgressRange &theProgress)
     Transfers mapped item.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepShape_FaceSurface > &fs, const occ::handle< Transfer_TransientProcess > &TP, const StepData_Factors &theLocalFactors, const Message_ProgressRange &theProgress)
     Transfers FaceSurface entity.
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepRepr_ConstructiveGeometryRepresentationRelationship > &theCGRR, const occ::handle< Transfer_TransientProcess > &theTP, const StepData_Factors &theLocalFactors=StepData_Factors())
    occ::handle< TransferBRep_ShapeBinderTransferEntity (const occ::handle< StepRepr_MechanicalDesignAndDraughtingRelationship > &theMDADR, const occ::handle< Transfer_TransientProcess > &theTP, const StepData_Factors &theLocalFactors, const Message_ProgressRange &theProgress)
     Transfers MechanicalDesignAndDraughtingRelationship entity.
    occ::handle< TransferBRep_ShapeBinderOldWay (const occ::handle< Standard_Transient > &startstart, const occ::handle< Transfer_TransientProcess > &TP, const Message_ProgressRange &theProgress)
     Translates file by old way when CDSR are roots. Acts only if "read.step.product_mode" is equal Off.

    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.

    Detailed Description

    This class performs the transfer of an Entity from AP214 and AP203, either Geometric or Topologic.

    I.E. for each type of Entity, it invokes the appropriate Tool then returns the Binder which contains the Result

    Constructor & Destructor Documentation

    ◆ STEPControl_ActorRead()

    STEPControl_ActorRead::STEPControl_ActorRead ( const occ::handle< Interface_InterfaceModel > & theModel)

    Member Function Documentation

    ◆ ComputeSRRWT()

    bool STEPControl_ActorRead::ComputeSRRWT ( const occ::handle< StepRepr_RepresentationRelationship > & SRR,
    const occ::handle< Transfer_TransientProcess > & TP,
    gp_Trsf & Trsf,
    const StepData_Factors & theLocalFactors = StepData_Factors() )

    Computes transformation defined by given REPRESENTATION_RELATIONSHIP_WITH_TRANSFORMATION.

    ◆ ComputeTransformation()

    bool STEPControl_ActorRead::ComputeTransformation ( const occ::handle< StepGeom_Axis2Placement3d > & Origin,
    const occ::handle< StepGeom_Axis2Placement3d > & Target,
    const occ::handle< StepRepr_Representation > & OrigContext,
    const occ::handle< StepRepr_Representation > & TargContext,
    const occ::handle< Transfer_TransientProcess > & TP,
    gp_Trsf & Trsf,
    const StepData_Factors & theLocalFactors = StepData_Factors() )

    Computes transformation defined by two axis placements (in MAPPED_ITEM or ITEM_DEFINED_TRANSFORMATION) taking into account their representation contexts (i.e. units, which may be different) Returns True if transformation is computed and is not an identity.

    ◆ OldWay()

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::OldWay ( const occ::handle< Standard_Transient > & start,
    const occ::handle< Transfer_TransientProcess > & TP,
    const Message_ProgressRange & theProgress )
    protected

    Translates file by old way when CDSR are roots. Acts only if "read.step.product_mode" is equal Off.

    ◆ PrepareUnits()

    void STEPControl_ActorRead::PrepareUnits ( const occ::handle< StepRepr_Representation > & rep,
    const occ::handle< Transfer_TransientProcess > & TP,
    StepData_Factors & theLocalFactors )

    set units and tolerances context by given ShapeRepresentation

    ◆ Recognize()

    bool STEPControl_ActorRead::Recognize ( const occ::handle< Standard_Transient > & 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_ActorOfProcessForTransient.

    ◆ ResetUnits()

    void STEPControl_ActorRead::ResetUnits ( const occ::handle< StepData_StepModel > & theModel,
    StepData_Factors & theLocalFactors )

    reset units and tolerances context to default (mm, radians, read.precision.val, etc.)

    ◆ SetModel()

    void STEPControl_ActorRead::SetModel ( const occ::handle< Interface_InterfaceModel > & theModel)

    Set model.

    ◆ Transfer()

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

    Reimplemented from Transfer_ActorOfTransientProcess.

    ◆ TransferEntity() [1/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepBasic_ProductDefinition > & PD,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors = StepData_Factors(),
    const bool theUseTrsf = false,
    const Message_ProgressRange & theProgress = Message_ProgressRange() )
    protected

    Transfers product definition entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.

    ◆ TransferEntity() [2/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepGeom_GeometricRepresentationItem > & git,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors,
    const bool isManifold,
    const Message_ProgressRange & theProgress )
    protected

    Transfers geometric representation item entity such as ManifoldSolidBRep ,...etc.

    ◆ TransferEntity() [3/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepRepr_ConstructiveGeometryRepresentationRelationship > & theCGRR,
    const occ::handle< Transfer_TransientProcess > & theTP,
    const StepData_Factors & theLocalFactors = StepData_Factors() )
    protected

    ◆ TransferEntity() [4/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepRepr_MappedItem > & mapit,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors,
    const Message_ProgressRange & theProgress )
    protected

    Transfers mapped item.

    ◆ TransferEntity() [5/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepRepr_MechanicalDesignAndDraughtingRelationship > & theMDADR,
    const occ::handle< Transfer_TransientProcess > & theTP,
    const StepData_Factors & theLocalFactors,
    const Message_ProgressRange & theProgress )
    protected

    Transfers MechanicalDesignAndDraughtingRelationship entity.

    ◆ TransferEntity() [6/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepRepr_NextAssemblyUsageOccurrence > & NAUO,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors = StepData_Factors(),
    const Message_ProgressRange & theProgress = Message_ProgressRange() )
    protected

    Transfers next assembly usage occurrence entity.

    ◆ TransferEntity() [7/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepRepr_ShapeRepresentationRelationship > & und,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors,
    const int nbrep = 0,
    const bool theUseTrsf = false,
    const Message_ProgressRange & theProgress = Message_ProgressRange() )
    protected

    Transfers shape representation relationship entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.

    ◆ TransferEntity() [8/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepShape_ContextDependentShapeRepresentation > & CDSR,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors = StepData_Factors(),
    const Message_ProgressRange & theProgress = Message_ProgressRange() )
    protected

    Transfers context dependent shape representation entity.

    ◆ TransferEntity() [9/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepShape_FaceSurface > & fs,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors,
    const Message_ProgressRange & theProgress )
    protected

    Transfers FaceSurface entity.

    ◆ TransferEntity() [10/10]

    occ::handle< TransferBRep_ShapeBinder > STEPControl_ActorRead::TransferEntity ( const occ::handle< StepShape_ShapeRepresentation > & sr,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors,
    bool & isBound,
    const bool theUseTrsf = false,
    const Message_ProgressRange & theProgress = Message_ProgressRange() )
    protected

    Transfers shape representation entity theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape.

    ◆ TransferShape()

    occ::handle< Transfer_Binder > STEPControl_ActorRead::TransferShape ( const occ::handle< Standard_Transient > & start,
    const occ::handle< Transfer_TransientProcess > & TP,
    const StepData_Factors & theLocalFactors = StepData_Factors(),
    const bool isManifold = true,
    const bool theUseTrsf = false,
    const Message_ProgressRange & theProgress = Message_ProgressRange() )

    theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root shape


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