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
    IGESControl_Controller Class Reference

    Controller for IGES-5.1. More...

    #include <IGESControl_Controller.hxx>

    Inheritance diagram for IGESControl_Controller:

    Public Member Functions

     IGESControl_Controller (const bool modefnes=false)
     Initializes the use of IGES Norm (the first time) and returns a Controller for IGES-5.1 If <modefnes> is True, sets it to internal FNES format.
    occ::handle< Interface_InterfaceModelNewModel () const override
     Creates a new empty Model ready to receive data of the Norm. It is taken from IGES Template Model.
    occ::handle< Transfer_ActorOfTransientProcessActorRead (const occ::handle< Interface_InterfaceModel > &model) const override
     Returns the Actor for Read attached to the pair (norm,appli) It is an Actor from IGESToBRep, adapted from an IGESModel : Unit, tolerances.
    IFSelect_ReturnStatus TransferWriteShape (const TopoDS_Shape &shape, const occ::handle< Transfer_FinderProcess > &FP, const occ::handle< Interface_InterfaceModel > &model, const int modetrans=0, const Message_ProgressRange &theProgress=Message_ProgressRange()) const override
     Takes one Shape and transfers it to the InterfaceModel (already created by NewModel for instance) <modetrans> is to be interpreted by each kind of XstepAdaptor Returns a status : 0 OK 1 No result 2 Fail -1 bad modeshape -2 bad model (requires an IGESModel) modeshape : 0 group of face (version < 5.1) 1 BREP-version 5.1 of IGES.
    void Customise (occ::handle< XSControl_WorkSession > &WS) override
     Customises a WorkSession, by adding to it the recorded items (by AddSessionItem).
    Public Member Functions inherited from XSControl_Controller
    void SetNames (const char *const theLongName, const char *const theShortName)
     Changes names if a name is empty, the formerly set one remains Remark : Does not call Record or AutoRecord.
    void AutoRecord () const
     Records <me> is a general dictionary under Short and Long Names (see method Name).
    void Record (const char *const namename) const
     Records <me> in a general dictionary under a name Error if <name> already used for another one.
    const char * Name (const bool rsc=false) const
     Returns a name, as given when initializing : rsc = False (D) : True Name attached to the Norm (long name) rsc = True : Name of the resource set (i.e. short name).
    const occ::handle< Interface_Protocol > & Protocol () const
     Returns the Protocol attached to the Norm (from field).
    const occ::handle< IFSelect_WorkLibrary > & WorkLibrary () const
     Returns the SignType attached to the norm (from field).
    virtual occ::handle< Transfer_ActorOfFinderProcessActorWrite () const
     Returns the Actor for Write attached to the pair (norm,appli) Read from field. Can be redefined.
    void SetModeWrite (const int modemin, const int modemax, const bool shape=true)
     Sets minimum and maximum values for modetrans (write) Erases formerly recorded bounds and values Actually only for shape Then, for each value a little help can be attached.
    void SetModeWriteHelp (const int modetrans, const char *const help, const bool shape=true)
     Attaches a short line of help to a value of modetrans (write).
    bool ModeWriteBounds (int &modemin, int &modemax, const bool shape=true) const
     Returns recorded min and max values for modetrans (write) Actually only for shapes Returns True if bounds are set, False else (then, free value).
    bool IsModeWrite (const int modetrans, const bool shape=true) const
     Tells if a value of <modetrans> is a good value(within bounds) Actually only for shapes.
    const char * ModeWriteHelp (const int modetrans, const bool shape=true) const
     Returns the help line recorded for a value of modetrans empty if help not defined or not within bounds or if values are free.
    virtual bool RecognizeWriteTransient (const occ::handle< Standard_Transient > &objobj, const int modetrans=0) const
     Tells if <obj> (an application object) is a valid candidate for a transfer to a Model. By default, asks the ActorWrite if known (through a TransientMapper). Can be redefined.
    virtual IFSelect_ReturnStatus TransferWriteTransient (const occ::handle< Standard_Transient > &objobj, const occ::handle< Transfer_FinderProcess > &FP, const occ::handle< Interface_InterfaceModel > &model, const int modetrans=0, const Message_ProgressRange &theProgress=Message_ProgressRange()) const
     Takes one Transient Object and transfers it to an InterfaceModel (already created, e.g. by NewModel) (result is recorded in the model by AddWithRefs) FP records produced results and checks.
    virtual bool RecognizeWriteShape (const TopoDS_Shape &shape, const int modetrans=0) const
     Tells if a shape is valid for a transfer to a model Asks the ActorWrite (through a ShapeMapper).
    void AddSessionItem (const occ::handle< Standard_Transient > &theItem, const char *const theName, const bool toApply=false)
     Records a Session Item, to be added for customisation of the Work Session. It must have a specific name. <setapplied> is used if is a GeneralModifier, to decide If set to true, will be applied to the hook list "send". Else, it is not applied to any hook list. Remark : this method is to be called at Create time, the recorded items will be used by Customise Warning : if <name> conflicts, the last recorded item is kept.
    occ::handle< Standard_TransientSessionItem (const char *const theName) const
     Returns an item given its name to record in a Session If <name> is unknown, returns a Null Handle.
    const NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > & AdaptorSession () const
    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.

    Static Public Member Functions

    static bool Init ()
     Standard Initialisation. It creates a Controller for IGES and records it to various names, available to select it later Returns True when done, False if could not be done Also, it creates and records an Adaptor for FNES.
    Static Public Member Functions inherited from XSControl_Controller
    static occ::handle< XSControl_ControllerRecorded (const char *const namename)
     Returns the Controller attached to a given name Returns a Null Handle if <name> is unknown.
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Protected Member Functions inherited from XSControl_Controller
     XSControl_Controller (const char *const theLongName, const char *const theShortName)
     Initializing with names <theLongName> is for the complete, official, long name <theShortName> is for the short name used for resources.
    void TraceStatic (const char *const theName, const int theUse)
     Records the name of a Static to be traced for a given use.
    Protected Attributes inherited from XSControl_Controller
    TCollection_AsciiString myShortName
    TCollection_AsciiString myLongName
    occ::handle< IFSelect_WorkLibrarymyAdaptorLibrary
    occ::handle< Interface_ProtocolmyAdaptorProtocol
    occ::handle< Transfer_ActorOfTransientProcessmyAdaptorRead
    occ::handle< Transfer_ActorOfFinderProcessmyAdaptorWrite
    NCollection_DataMap< TCollection_AsciiString, occ::handle< Standard_Transient > > myAdaptorSession

    Detailed Description

    Controller for IGES-5.1.

    Constructor & Destructor Documentation

    ◆ IGESControl_Controller()

    IGESControl_Controller::IGESControl_Controller ( const bool modefnes = false)

    Initializes the use of IGES Norm (the first time) and returns a Controller for IGES-5.1 If <modefnes> is True, sets it to internal FNES format.

    Member Function Documentation

    ◆ ActorRead()

    occ::handle< Transfer_ActorOfTransientProcess > IGESControl_Controller::ActorRead ( const occ::handle< Interface_InterfaceModel > & model) const
    overridevirtual

    Returns the Actor for Read attached to the pair (norm,appli) It is an Actor from IGESToBRep, adapted from an IGESModel : Unit, tolerances.

    Reimplemented from XSControl_Controller.

    ◆ Customise()

    void IGESControl_Controller::Customise ( occ::handle< XSControl_WorkSession > & WS)
    overridevirtual

    Customises a WorkSession, by adding to it the recorded items (by AddSessionItem).

    Reimplemented from XSControl_Controller.

    ◆ Init()

    bool IGESControl_Controller::Init ( )
    static

    Standard Initialisation. It creates a Controller for IGES and records it to various names, available to select it later Returns True when done, False if could not be done Also, it creates and records an Adaptor for FNES.

    ◆ NewModel()

    occ::handle< Interface_InterfaceModel > IGESControl_Controller::NewModel ( ) const
    overridevirtual

    Creates a new empty Model ready to receive data of the Norm. It is taken from IGES Template Model.

    Implements XSControl_Controller.

    ◆ TransferWriteShape()

    IFSelect_ReturnStatus IGESControl_Controller::TransferWriteShape ( const TopoDS_Shape & shape,
    const occ::handle< Transfer_FinderProcess > & FP,
    const occ::handle< Interface_InterfaceModel > & model,
    const int modetrans = 0,
    const Message_ProgressRange & theProgress = Message_ProgressRange() ) const
    overridevirtual

    Takes one Shape and transfers it to the InterfaceModel (already created by NewModel for instance) <modetrans> is to be interpreted by each kind of XstepAdaptor Returns a status : 0 OK 1 No result 2 Fail -1 bad modeshape -2 bad model (requires an IGESModel) modeshape : 0 group of face (version < 5.1) 1 BREP-version 5.1 of IGES.

    Reimplemented from XSControl_Controller.


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