This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here

Constructors:

Methods:

get_id( )	get the ID for the named field
get_size( )	get the size for the named field
is_unique( )	does the field uniquely identify the named entry?
get_template( )	get the string template for the named entry

Description

This class abstracts provides an interface to user-defined values for the fields which constitute PSTAT's and OSF's, the string templates for those entries, and the fields to be considered unique to both.

See Also:

• Field
• Osf
• Time_stamp
• "OPUS API Blackboard and Support Classes Design Document"

Bb_params_db::get_id - Get a PSTAT or OSF field ID.

Synopsis

int Bb_params_db::get_id(
                         const char* f) // I - Field name

int Bb_params_db::get_id(
                         const string& f) // I - Field name

Description

This method returns the ID of the named field.

Returns

    Field ID

Exceptions Thrown

No_entry	- if file does not exist
Corrupt	- if Oresource file is corrupt
Io_error	- if file error encountered loading file
No_entry	- if no value is found for that key
Not_ready	- if file not loaded
Bad_val	- value cannot be expressed as desired type.
Corrupt<string>	- if the template definitions are not parsable; Corrupt.arg contains the bad value
Bad_val<string>	- if no ID matching the supplied name is found; Bad_val.arg contains the calling argument

Bb_params_db::get_size - Get a PSTAT or OSF field size.

Synopsis

int Bb_params_db::get_size(
                           const char* f) // I - Field name

int Bb_params_db::get_size(
                           const string& f) // I - Field name

Description

This method returns the size of the named field.

Returns

    Field ID

Exceptions Thrown

No_entry	- if no value is found for that key
Not_ready	- if file not loaded
Bad_val	- value cannot be expressed as desired type.
No_entry	- if file does not exist
Corrupt	- if Oresource file is corrupt
Io_error	- if file error encountered loading file
No_entry	- if no value is found for that key
Not_ready	- if file not loaded
Bad_val	- value cannot be expressed as desired type.
Corrupt<string>	- if the template definitions are not parsable; Corrupt.arg contains the bad value
Bad_val<string>	- if no size matching the supplied name is found; Bad_val.arg contains the calling argument

Bb_params_db::is_unique - Indicates whether the indicated field is a unique identifier for the specified entry.

Synopsis

bool Bb_params_db::is_unique(
                             const char* prefix, // I - blackboard type
                             const int i)        // I - Field ID

bool Bb_params_db::is_unique(
                             const string& prefix, // I - blackboard type
                             const int idx)        // I - Field ID

Description

This method specifies whether the field of the indicated ID is a unique identifier of the indicatred entry. That is, is the field used to determine if one entry is identical to another.

Returns

    true  if the field is a unique identifier of the named entry
    false if the field is not a unique identifier of the named entry

Exceptions Thrown

No_entry	- if file does not exist
Corrupt	- if Oresource file is corrupt
Io_error	- if file error encountered loading file
No_entry	- if no value is found for that key
Not_ready	- if file not loaded
Bad_val	- value cannot be expressed as desired type.
Corrupt<string>	- if the template definitions are not parsable; Corrupt.arg contains the bad value

Bb_params_db::get_template - Get a PSTAT or OSF string template.

Synopsis

string Bb_params_db::get_template(
                                  const char* bb) // I - blackboard name

string Bb_params_db::get_template(
                                  const string& bb) // I - blackboard name

Description

This method returns the template for the entry.

Returns

    string entry template

Exceptions Thrown

No_entry	- if file does not exist
Corrupt	- if Oresource file is corrupt
Io_error	- if file error encountered loading file
No_entry	- if no value is found for that key
Not_ready	- if file not loaded
Bad_val	- value cannot be expressed as desired type.
Corrupt<string>	- if the template definitions are not parsable; Corrupt.arg contains the bad value
Bad_val<string>	- if no template matching the supplied name is found; Bad_val.arg contains the calling argument

For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000