Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions | Protected Member Functions
IFSelect_Activator Class Referenceabstract

Defines the general frame for working with a SessionPilot. Each Activator treats a set of Commands. Commands are given as alphanumeric strings. They can be of two main forms : More...

#include <IFSelect_Activator.hxx>

Inheritance diagram for IFSelect_Activator:
Inheritance graph
[legend]

Public Member Functions

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) More...
 
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) More...
 
virtual IFSelect_ReturnStatus Do (const Standard_Integer number, const Handle< IFSelect_SessionPilot > &pilot)=0
 Tries to execute a Command Line. <number> is the number of the command for this Activator. It Must forecast to record the result of the execution, for need of Undo-Redo Must Returns : 0 for a void command (not to be recorded), 1 if execution OK, -1 if command incorrect, -2 if error on execution. More...
 
virtual Standard_CString Help (const Standard_Integer number) const =0
 Sends a short help message for a given command identified by it number for this Activator (must take one line max) More...
 
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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

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. More...
 
static void Remove (const Standard_CString command)
 Removes a Command, if it is recorded (else, does nothing) More...
 
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. More...
 
static Standard_Integer Mode (const Standard_CString command)
 Returns mode recorded for a command. -1 if not found. More...
 
static Handle< TColStd_HSequenceOfAsciiString > Commands (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. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Protected Member Functions

 IFSelect_Activator ()
 Sets the default values. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

Defines the general frame for working with a SessionPilot. Each Activator treats a set of Commands. Commands are given as alphanumeric strings. They can be of two main forms :

In order to make easier the use of Activator, this class provides a simple way to Select an Actor for a Command : each sub-class of SectionActor defines the command titles it recognizes, plus attaches a Number, unique for this sub-class, to each distinct command title.

Each time an action is required, the corresponding Number can then be given to help the selection of the action to do.

The result of an Execution must indicate if it is worth to be recorded or not : see method Do

Constructor & Destructor Documentation

◆ IFSelect_Activator()

IFSelect_Activator::IFSelect_Activator ( )
protected

Sets the default values.

Member Function Documentation

◆ Add()

void IFSelect_Activator::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)

◆ Adding()

static void IFSelect_Activator::Adding ( const Handle< IFSelect_Activator > &  actor,
const Standard_Integer  number,
const Standard_CString  command,
const Standard_Integer  mode 
)
static

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.

◆ AddSet()

void IFSelect_Activator::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)

◆ Commands()

static Handle< TColStd_HSequenceOfAsciiString > IFSelect_Activator::Commands ( const Standard_Integer  mode = -1,
const Standard_CString  command = "" 
)
static

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.

◆ Do()

virtual IFSelect_ReturnStatus IFSelect_Activator::Do ( const Standard_Integer  number,
const Handle< IFSelect_SessionPilot > &  pilot 
)
pure virtual

Tries to execute a Command Line. <number> is the number of the command for this Activator. It Must forecast to record the result of the execution, for need of Undo-Redo Must Returns : 0 for a void command (not to be recorded), 1 if execution OK, -1 if command incorrect, -2 if error on execution.

Implemented in IFSelect_SessionPilot, IFSelect_Act, StepSelect_Activator, and IGESSelect_Activator.

◆ File()

Standard_CString IFSelect_Activator::File ( ) const

◆ Group()

Standard_CString IFSelect_Activator::Group ( ) const

◆ Help()

virtual Standard_CString IFSelect_Activator::Help ( const Standard_Integer  number) const
pure virtual

Sends a short help message for a given command identified by it number for this Activator (must take one line max)

Implemented in IFSelect_SessionPilot, IFSelect_Act, StepSelect_Activator, and IGESSelect_Activator.

◆ Mode()

static Standard_Integer IFSelect_Activator::Mode ( const Standard_CString  command)
static

Returns mode recorded for a command. -1 if not found.

◆ Remove()

static void IFSelect_Activator::Remove ( const Standard_CString  command)
static

Removes a Command, if it is recorded (else, does nothing)

◆ Select()

static Standard_Boolean IFSelect_Activator::Select ( const Standard_CString  command,
Standard_Integer number,
Handle< IFSelect_Activator > &  actor 
)
static

Selects, for a Command given by its title, an actor with its command number. Returns True if found, False else.

◆ SetForGroup()

void IFSelect_Activator::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.


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