OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    StepSelect_Activator Class Reference

    Performs Actions specific to StepSelect, i.e. creation of Step Selections and Counters, plus dumping specific to Step. More...

    #include <StepSelect_Activator.hxx>

    Inheritance diagram for StepSelect_Activator:

    Public Member Functions

     StepSelect_Activator ()
    IFSelect_ReturnStatus Do (const int number, const occ::handle< IFSelect_SessionPilot > &pilot) override
     Executes a Command Line for StepSelect.
    const char * Help (const int number) const override
     Sends a short help message for StepSelect commands.
    Public Member Functions inherited from IFSelect_Activator
    void Add (const int number, const char *const command) const
     Allows a self-definition by an Activator of the Commands it processes, call the class method Adding (mode 0).
    void AddSet (const int number, const char *const command) const
     Same as Add but specifies that this command is candidate for xset (creation of items, xset : named items; mode 1).
    const char * Group () const
    const char * File () const
    void SetForGroup (const char *const groupgroup, const char *const file="")
     Group and SetGroup define a "Group of commands" which correspond to an Activator. Default is "XSTEP" Also a file may be attached.
    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 Public Member Functions inherited from IFSelect_Activator
    static void Adding (const occ::handle< IFSelect_Activator > &actor, const int number, const char *const command, const int modemode)
     Records, in a Dictionary available for all the Activators, the command title an Activator can process, attached with its number, proper for this Activator <mode> allows to distinguish various execution modes 0: default mode; 1 : for xset.
    static void Remove (const char *const command)
     Removes a Command, if it is recorded (else, does nothing).
    static bool Select (const char *const command, int &number, occ::handle< IFSelect_Activator > &actor)
     Selects, for a Command given by its title, an actor with its command number. Returns True if found, False else.
    static int Mode (const char *const command)
     Returns mode recorded for a command. -1 if not found.
    static occ::handle< NCollection_HSequence< TCollection_AsciiString > > Commands (const int modemode=-1, const char *const command="")
     Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
    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_Activator
     IFSelect_Activator ()
     Sets the default values.

    Detailed Description

    Performs Actions specific to StepSelect, i.e. creation of Step Selections and Counters, plus dumping specific to Step.

    Constructor & Destructor Documentation

    ◆ StepSelect_Activator()

    StepSelect_Activator::StepSelect_Activator ( )

    Member Function Documentation

    ◆ Do()

    IFSelect_ReturnStatus StepSelect_Activator::Do ( const int number,
    const occ::handle< IFSelect_SessionPilot > & pilot )
    overridevirtual

    Executes a Command Line for StepSelect.

    Implements IFSelect_Activator.

    ◆ Help()

    const char * StepSelect_Activator::Help ( const int number) const
    overridevirtual

    Sends a short help message for StepSelect commands.

    Implements IFSelect_Activator.


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