This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here
Constructors:
Proc_cmd( ) | |
~Proc_cmd( ) |
Methods:
clone( ) | create copy of object |
name( ) | get field name |
is_command( ) | validate command string |
Data Members:
static const std::string PSTAT_HALT_COMMAND; // PSTAT HALT command static const std::string PSTAT_SUSPEND_COMMAND; // PSTAT SUSPEND command static const std::string PSTAT_RESUME_COMMAND; // PSTAT RESUME command static const std::string PSTAT_REINIT_COMMAND; // PSTAT REINIT command
Description
Besides being empty (all padding), an object of this type only can contain the following commands:
Proc_cmd::PSTAT_HALT_COMMAND Proc_cmd::PSTAT_SUSPEND_COMMAND Proc_cmd::PSTAT_RESUME_COMMAND Proc_cmd::PSTAT_REINIT_COMMAND
Derived from
See Also:
Proc_cmd::Proc_cmd - The Proc_cmd constructor.
Synopsis
Proc_cmd::Proc_cmd( const string& s) // I - command string Proc_cmd::Proc_cmd( const Proc_cmd& di) // I - object to initialize from
Description
The constructor creates a new Proc_cmd object, initialized by the calling argument (if provided). Only the following commands are permitted:
Proc_cmd::PSTAT_HALT_COMMAND Proc_cmd::PSTAT_SUSPEND_COMMAND Proc_cmd::PSTAT_RESUME_COMMAND Proc_cmd::PSTAT_REINIT_COMMAND
Exceptions Thrown
Bad_val<string> | - if supplied command is invalid; Bad_val.arg contains the calling argument |
Proc_cmd::~Proc_cmd - The Proc_cmd destructor.
Synopsis
Proc_cmd::~Proc_cmd()
Description
This method destroys the object.
Exceptions Thrown
Proc_cmd::clone - Create a copy of this object.
Synopsis
Field* Proc_cmd::clone() const
Description
This method creates a new Proc_cmd object, initialized by this object, off the heap and returns a pointer to the new object. The client should delete the returned object when it is no longer needed.
Returns
A pointer to the new Proc_cmd object initialized by this object.
Exceptions Thrown
Proc_cmd::is_command - Check if argument is a valid command.
Synopsis
bool Proc_cmd::is_command( const string& s) // I - command string const
Description
This method searches the PSTAT_COMMANDS string for a match to the calling argument. If found, the command is valid.
Returns
true - if command is validfalse - if command is invalid
Exceptions Thrown
Proc_cmd::name - Get the field name
Synopsis
string Proc_cmd::name() const
Description
This method returns the name of the field, "COMMAND".
Returns
string field name
Exceptions Thrown
Copyright © 1997-2000 The Association of Universities for
Research in Astronomy, Inc. All Rights Reserved.
For more information, contact opushelp@stsci.edu
Last modified: 25 April 2000