Open CASCADE Technology 7.8.0
Public Member Functions
IGESSelect_Activator Class Reference

Performs Actions specific to IGESSelect, i.e. creation of IGES Selections and Dispatches, plus dumping specific to IGES. More...

#include <IGESSelect_Activator.hxx>

Inheritance diagram for IGESSelect_Activator:
Inheritance graph
[legend]

Public Member Functions

 IGESSelect_Activator ()
 
IFSelect_ReturnStatus Do (const Standard_Integer number, const Handle< IFSelect_SessionPilot > &pilot) override
 Executes a Command Line for IGESSelect.
 
Standard_CString Help (const Standard_Integer number) const override
 Sends a short help message for IGESSelect commands.
 
- Public Member Functions inherited from IFSelect_Activator
void Add (const Standard_Integer number, const Standard_CString command) const
 Allows a self-definition by an Activator of the Commands it processes, call the class method Adding (mode 0)
 
void AddSet (const Standard_Integer number, const Standard_CString command) const
 Same as Add but specifies that this command is candidate for xset (creation of items, xset : named items; mode 1)
 
Standard_CString Group () const
 
Standard_CString File () const
 
void SetForGroup (const Standard_CString group, const Standard_CString 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_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 IFSelect_Activator
static void Adding (const Handle< IFSelect_Activator > &actor, const Standard_Integer number, const Standard_CString command, const Standard_Integer mode)
 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 Standard_CString command)
 Removes a Command, if it is recorded (else, does nothing)
 
static Standard_Boolean Select (const Standard_CString command, Standard_Integer &number, 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 Standard_Integer Mode (const Standard_CString command)
 Returns mode recorded for a command. -1 if not found.
 
static Handle< TColStd_HSequenceOfAsciiStringCommands (const Standard_Integer mode=-1, const Standard_CString 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 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.
 
- Protected Member Functions inherited from IFSelect_Activator
 IFSelect_Activator ()
 Sets the default values.
 

Detailed Description

Performs Actions specific to IGESSelect, i.e. creation of IGES Selections and Dispatches, plus dumping specific to IGES.

Constructor & Destructor Documentation

◆ IGESSelect_Activator()

IGESSelect_Activator::IGESSelect_Activator ( )

Member Function Documentation

◆ Do()

IFSelect_ReturnStatus IGESSelect_Activator::Do ( const Standard_Integer  number,
const Handle< IFSelect_SessionPilot > &  pilot 
)
overridevirtual

Executes a Command Line for IGESSelect.

Implements IFSelect_Activator.

◆ Help()

Standard_CString IGESSelect_Activator::Help ( const Standard_Integer  number) const
overridevirtual

Sends a short help message for IGESSelect commands.

Implements IFSelect_Activator.


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