This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here
Constructors:
Obs_stat( ) | |
~Obs_stat( ) |
Methods:
clone( ) | creates copy of this object |
name( ) | gets the field name |
set_position( ) | sets a stage status |
get_position( ) | gets a stage status |
Description
Obs_stat objects store the status characters for each processing stage for the element that the OSF is tracking. The status for stage 1 is stored in the first character (index 0), and so on.
Derived from
See Also:
Obs_stat::Obs_stat - The Obs_stat constructor.
Synopsis
Obs_stat::Obs_stat( const string& s) // I - status string Obs_stat::Obs_stat( const Obs_stat& di) // I - object to initialize from
Description
This method constructs a new Obs_stat object, optionally initialized by the passed-in status string.
Exceptions Thrown
Obs_stat::~Obs_stat - The Obs_stat destructor.
Synopsis
Obs_stat::~Obs_stat()
Description
This method destroys the object.
Exceptions Thrown
Obs_stat::clone - Create a copy of this object.
Synopsis
Field* Obs_stat::clone() const
Description
This method reates a new Obs_stat 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_stat object initialized by this object.
Exceptions Thrown
Obs_stat::set_position - Set a stage status value.
Synopsis
void Obs_stat::set_position( const int p, // I - position in status string const char c) // I - character to set
Description
This method sets the indicated position in the status string to the indicated character. The integer argument should indicate the stage number (not the string character positions) which is indexed from 1.
Exceptions Thrown
Bad_val<int> | - if position is out of range; Bad_val.arg contains the calling argument |
Example
Obs_stat* ostat = new Obs_stat; ostat->set_position(3, 'w');
Obs_stat::get_position - Get stage status value.
Synopsis
char Obs_stat::get_position( const int p) // I - stage number const
Description
This method retrieves the status character value from the status string for the indicated stage. The integer argument should be the stage number (not the status string character position) which is indexed from 1.
Returns
status value character for the stage
Exceptions Thrown
Bad_val<int> | - if position is out of range; Bad_val.arg contains the calling argument |
Example
Obs_stat* ostat = new Obs_stat; char stat = ostat->get_position(3);
Obs_stat::name - Get the field name
Synopsis
string Obs_stat::name() const
Description
This method returns the name of the field, "STATUS".
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