This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here
Constructors:
Obs_cmd( ) | |
~Obs_cmd( ) |
Methods:
clone( ) | creates a copy of this object |
name( ) | gets the field name |
is_command( ) | validates a command string |
Data Members:
static const std::string OSF_HALT_COMMAND; // OSF HALT command static const std::string OSF_SUSPEND_COMMAND; // OSF SUSPEND command
Description
Obs_cmd objects hold commands issued to the OSF. Besides being empty (all padding), an object of this type only can contain the commands:
Obs_cmd::OSF_HALT_COMMAND Obs_cmd::OSF_SUSPEND_COMMAND
Derived from
See Also:
Obs_cmd::Obs_cmd - The Obs_cmd constructor.
Synopsis
Obs_cmd::Obs_cmd( const string& s) // I - command string Obs_cmd::Obs_cmd( const Obs_cmd& di) // I - object to initialize from
Description
This method constructs a new Obs_cmd object, and assigns it the value of the calling argument after validation. The calling argument can be one of the following commands only:
Obs_cmd::OSF_SUSPEND_COMMAND Obs_cmd::OSF_HALT_COMMAND
Exceptions Thrown
Bad_val<string> | - if the supplied command string is invalid; Bad_val.arg contains the calling argument |
Obs_cmd::~Obs_cmd - The Obs_cmd destructor.
Synopsis
Obs_cmd::~Obs_cmd()
Description
This method destroys the object.
Exceptions Thrown
Obs_cmd::clone - Create a copy of this object.
Synopsis
Field* Obs_cmd::clone() const
Description
This method creates a new Obs_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 Obs_cmd object initialized by this object.
Exceptions Thrown
Obs_cmd::is_command - Check if the argument is a valid command.
Synopsis
bool Obs_cmd::is_command( const string& s) // I - the command string const
Description
This method searches the OSF_COMMANDS string for a match to the argument.
Returns
true - if the command is validfalse - if command is invalid
Exceptions Thrown
Obs_cmd::name - Get the field name
Synopsis
string Obs_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