[OPUS]

Osf - A base class for all OPUS OSF blackboard entries.


Availability:

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

Constructors:
Osf( )
~Osf( )

Methods:
search_mask( ) fill non-unique Field's with search character
mask( ) fill non-unique Field's with pad character fill non-unique Field's with provided character
search_fill_all( ) fill all Field's with search characters

Description

Class Osf defines an OSF object for OPUS applications. OSF entries contain the following field objects:

       Dataset, Obs_stat, Data_id, Dcf_num, Obs_cmd, and Time_stamp.
Of these objects, the Dataset and Data_id combination constitute a unique OSF on the OSF blackboard.

Clients of the OAPI should refer to any specific OSF implementation through a pointer to this type. The actual OSF will be a more derived type that handles the specifics for some storage medium. By referring to all OSF's through a pointer to this type, OAPI client code isolates itself from the implementation details.

Derived from

Entry

See Also:


Osf::Osf - The Osf constructor.

Synopsis


Osf::Osf() : Entry()

Osf::Osf(
         const Osf& o) // I - Osf to initialize from

Description

This method constructs objects of type Dataset, Obs_stat, Data_id, Dcf_num, Obs_cmd, and Time_stamp and adds them to the object. The default constructor for Time_stamp initializes the object with the current system time.

Exceptions Thrown

none


Osf::~Osf - The Entry destructor.

Synopsis


Osf::~Osf()

Description

This method destroys the object.

Exceptions Thrown

none


Osf::mask - Fill non-unique OSF fields with indicated character.

Synopsis


void Osf::mask()

void Osf::mask(
               const char c) // I - character to fill with

Description

All fields other than those that determine the uniqueness of an Osf entry are filled out with the argument by this method.

Exceptions Thrown

none


OPUS API index · STScI Home Page · Search · Topics · Index

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