Open CASCADE Technology 6.6.0
Public Member Functions
IFSelect_SessionPilot Class Reference

A SessionPilot is intended to make easier the use of a
WorkSession. It receives commands, under alphanumeric form,
then calls a library of Activators to interprete and run them.

Then, WorkSession just records data required to work :
Rules for Selection, Dispatch ... ; File Data (InterfaceModel
and results of Evaluations and Transfer as required).
SessionPilot records and works with alphanumeric commands and
their results (under a very simple form). It calls a list of
Activators to perform the actions.

A Command can have several forms :
More...

#include <IFSelect_SessionPilot.hxx>

Inheritance diagram for IFSelect_SessionPilot:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_SessionPilot (const Standard_CString prompt="")
 Creates an empty SessionPilot, with a prompt which will be
displayed on querying commands. If not precised (""), this
prompt is set to "Test-XSTEP>"

Handle_IFSelect_WorkSession Session () const
 Returns the WorkSession which is worked on

Handle_IFSelect_WorkLibrary Library () const
 Returns the WorKlibrary (Null if not set). WorkLibrary is used
to Read and Write Files, according to the Norm

Standard_Boolean RecordMode () const
 Returns the Record Mode for Commands. Default is False.

void SetSession (const Handle< IFSelect_WorkSession > &WS)
 Sets a WorkSession to be worked on

void SetLibrary (const Handle< IFSelect_WorkLibrary > &WL)
 Sets a WorkLibrary

void SetRecordMode (const Standard_Boolean mode)
 Changes the RecordMode.

void SetCommandLine (const TCollection_AsciiString &command)
 Sets the value of the Command Line to be interpreted
Also prepares the interpretation (splitting by blanks)

const TCollection_AsciiStringCommandLine () const
 Returns the Command Line to be interpreted

Standard_CString CommandPart (const Standard_Integer numarg=0) const
 Returns the part of the command line which begins at argument
<numarg> between 0 and NbWords-1 (by default, all the line)
Empty string if out of range

Standard_Integer NbWords () const
 Returns the count of words of the Command Line, separated by
blanks : 0 if empty, one if a command without args, else it
gives the count of args minus one.
Warning : limited to 10 (command title + 9 args)

const TCollection_AsciiStringWord (const Standard_Integer num) const
 Returns a word given its rank in the Command Line. Begins at 0
which is the Command Title, 1 is the 1st arg., etc...

Standard_CString Arg (const Standard_Integer num) const
 Returns a word given its rank, as a CString.
As for Word, begins at 0 (the command name), etc...

Standard_Boolean RemoveWord (const Standard_Integer num)
 Removes a word given its rank. Returns True if Done, False if
<num> is out of range

Standard_Integer NbCommands () const
 Returns the count of recorded Commands

const TCollection_AsciiStringCommand (const Standard_Integer num) const
 Returns a recorded Command, given its rank (from 1)

IFSelect_ReturnStatus RecordItem (const Handle< Standard_Transient > &item)
 Allows to associate a Transient Value with the last execution
as a partial result
Returns RetDone if item is not Null, RetFail if item is Null
Remark : it is nullified for each Perform

Handle_Standard_Transient RecordedItem () const
 Returns the Transient Object which was recorded with the
current Line Command. If none was, returns a Null Handle

void Clear ()
 Clears the recorded informations (commands, objects)

IFSelect_ReturnStatus ReadScript (const Standard_CString file="")
 Reads commands from a Script File, named <file>. By default
(file = ""), reads from standard input with a prompt
Else (reading from a file), the read commands are displayed
onto standard output. Allows nested reads. Reading is stopped
either by command x or exit, or by reaching end of file
Return Value follows the rules of Do : RetEnd for normal end,
RetFail if script could not be opened

IFSelect_ReturnStatus Perform ()
 Executes the Command, itself (for built-in commands, which
have priority) or by using the list of Activators.
The value returned is : RetVoid if nothing done (void command)
RetDone if execution OK, RetEnd if END OF SESSION, RetError if
command unknown or incorrect, RetFail if error on execution
If execution is OK and RecordMode is set, this Command Line is
recorded to the list (see below).

IFSelect_ReturnStatus ExecuteAlias (const TCollection_AsciiString &aliasname)
 Executes the Commands, except that the command name (word 0)
is aliased. The rest of the command line is unchanged
If <alias> is empty, Executes with no change

Error status is returned if the alias is unknown as command

IFSelect_ReturnStatus Execute (const TCollection_AsciiString &command)
 Sets the Command then tries to execute it. Return value :
same as for Perform

IFSelect_ReturnStatus ExecuteCounter (const Handle< IFSelect_SignCounter > &counter, const Standard_Integer numword, const IFSelect_PrintCount mode=IFSelect_CountByItem)
 Executes a Counter in a general way
If <numword> is greater than count of command words, it counts
all the model. Else it considers the word <numword> as the
identifier of a Selection
<mode> gives the mode of printing results, default is
CountByItem

Standard_Integer Number (const Standard_CString val) const
 Interprets a string value as an entity number :
if it gives an integer, returns its value
else, considers it as ENtityLabel (preferably case sensitive)
in case of failure, returns 0

IFSelect_ReturnStatus Do (const Standard_Integer number, const Handle< IFSelect_SessionPilot > &session)
 Processes specific commands, which are :
x or exit for end of session
? or help for help messages
xcommand to control command lines (Record Mode, List, Clear,
File Output ...)
xsource to execute a command file (no nesting allowed),
in case of error, source is stopped and keyword recovers
xstep is a simple prefix (useful in a wider environment, to
avoid conflicts on command names)
xset control commands which create items with names

Standard_CString Help (const Standard_Integer number) const
 Help for specific commands (apart from general command help)


Detailed Description


Constructor & Destructor Documentation

IFSelect_SessionPilot::IFSelect_SessionPilot ( const Standard_CString  prompt = "")

Member Function Documentation

Standard_CString IFSelect_SessionPilot::Arg ( const Standard_Integer  num) const
void IFSelect_SessionPilot::Clear ( )
const TCollection_AsciiString& IFSelect_SessionPilot::Command ( const Standard_Integer  num) const
const TCollection_AsciiString& IFSelect_SessionPilot::CommandLine ( ) const
Standard_CString IFSelect_SessionPilot::CommandPart ( const Standard_Integer  numarg = 0) const
IFSelect_ReturnStatus IFSelect_SessionPilot::Do ( const Standard_Integer  number,
const Handle< IFSelect_SessionPilot > &  session 
) [virtual]

Implements IFSelect_Activator.

IFSelect_ReturnStatus IFSelect_SessionPilot::Execute ( const TCollection_AsciiString command)
IFSelect_ReturnStatus IFSelect_SessionPilot::ExecuteAlias ( const TCollection_AsciiString aliasname)
IFSelect_ReturnStatus IFSelect_SessionPilot::ExecuteCounter ( const Handle< IFSelect_SignCounter > &  counter,
const Standard_Integer  numword,
const IFSelect_PrintCount  mode = IFSelect_CountByItem 
)
Standard_CString IFSelect_SessionPilot::Help ( const Standard_Integer  number) const [virtual]

Implements IFSelect_Activator.

Handle_IFSelect_WorkLibrary IFSelect_SessionPilot::Library ( ) const
Standard_Integer IFSelect_SessionPilot::NbCommands ( ) const
Standard_Integer IFSelect_SessionPilot::NbWords ( ) const
Standard_Integer IFSelect_SessionPilot::Number ( const Standard_CString  val) const
IFSelect_ReturnStatus IFSelect_SessionPilot::Perform ( )
IFSelect_ReturnStatus IFSelect_SessionPilot::ReadScript ( const Standard_CString  file = "")
Handle_Standard_Transient IFSelect_SessionPilot::RecordedItem ( ) const
IFSelect_ReturnStatus IFSelect_SessionPilot::RecordItem ( const Handle< Standard_Transient > &  item)
Standard_Boolean IFSelect_SessionPilot::RecordMode ( ) const
Standard_Boolean IFSelect_SessionPilot::RemoveWord ( const Standard_Integer  num)
Handle_IFSelect_WorkSession IFSelect_SessionPilot::Session ( ) const
void IFSelect_SessionPilot::SetCommandLine ( const TCollection_AsciiString command)
void IFSelect_SessionPilot::SetLibrary ( const Handle< IFSelect_WorkLibrary > &  WL)
void IFSelect_SessionPilot::SetRecordMode ( const Standard_Boolean  mode)
void IFSelect_SessionPilot::SetSession ( const Handle< IFSelect_WorkSession > &  WS)
const TCollection_AsciiString& IFSelect_SessionPilot::Word ( const Standard_Integer  num) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines