[OPUS]

OPUS Applications Programmer's Interface

The definitive guide for programming your applications to access the OPUS blackboards directly is here. The remainder of this document consists of links to the OPUS class library documentation.


Absolute_time - A field object that represents an absolute, wall-clock time.
Absolute_time_bb - A blackboard whose entries are absolute, wall-clock times.
Bb_params_db - An object that provides access to certain user- defined parameters of OSF and PSTAT entries.
Blackboard - OPUS blackboard abstract base class
Com_arg - A field object containing a calling argument to a function.
Com_label - A field object containing an identifying label for the Command object to which it belongs.
Command - An entry object that is used on the command blackboard.
Command_bb - A blackboard object with entries that map to callable functions.
Command_event - An event object created in response to a command blackboard event
Dangle - A field object that encapsulates the dangle portion of a file specification.
Data_id - A field object that stores the DATA_ID portion of an OSF.
Dataset - A field object that stores the DATASET portion of an OSF.
Dcf_num - A field object that stores the DCF_NUM portion of an OSF.
Delta_time - A field object that represents a period of time.
Directory - A field object that encapsulates the path portion of a file specification.
Entry - OPUS blackboard entry base class
Event - OPUS Event Base Class
Event_journal - Maintains event journals for class Opus_env.
Extension - A field object that encapsulates the extension portion of a file specification.
Field - OPUS entry field base class
File_entry - An entry object that is used on the files blackboard.
File_event - An event object created in response to a files blackboard event.
File_osf - A file name-based implementation of an Osf object.
File_osf_bb - A file name-based implementation of an Osf_bb object.
File_osf_lock - Opus_lock object for file name-based OSF's.
File_pstat - A file name-based implementation of a Pstat object.
File_pstat_bb - A file name-based implementation of a Pstat_bb object.
File_pstat_lock - Opus_lock object for file name-based PSTAT's.
Files_bb - A blackboard object that is an interface to the file system.
Halt_event - An event object created in response to a HALT command issued on the application's PSTAT
Internal_event - An object that is thrown by the blackboard polling functions when an internally handled event occurs.
Ioavail_event - An internally handled event generated when a process exits IOWAIT state.
Low_store_event - An Event object generated when disk stores are low.
Msg - The API message reporting class
Node - A field object that stores the NODE portion of a PSTAT.
Null_lock - A non-functional lock object for a lockable resource that requires no locking.
Num_in_str - A helper class that aids encapsulation of numbers in string objects.
Obs_cmd - A field object that stores the COMMAND portion of an OSF.
Obs_stat - A field object that stores the STATUS portion of an OSF.
Ofile - An object for resolving directory stretches.
Opus_env - OPUS Environment/Interface Object
Opus_lock - An abstract base class for OPUS resource locks.
Opus_lock_file - A file-based file lock
Opus_pid - An OPUS process identifier object.
Opus_polymorph - Abstract base class that imposes a string representation method on its descendants.
Opus_time_stamp - A base class for Start_time and Time_stamp objects.
Oresource - OPUS Oresource File Class
Osf - A base class for all OPUS OSF blackboard entries.
Osf_bb - An abstract base class for all OSF blackboard implementations.
Osf_event - An event object created in response to an OSF blackboard event.
Osf_lock - Abstract base class for specialized locks on OSF's.
Path - A field object that stores the PATH portion of an OSF.
Pid - A field object that stores the PID portion of a PSTAT.
Pipeline - OPUS Pipeline Class
Proc_cmd - A field object that stores the COMMAND portion of a PSTAT.
Proc_stat - A field object that stores the STATUS portion of a PSTAT.
Process - A field object that stores the PROCESS portion of a PSTAT.
Pstat - A base class for all OPUS PSTAT implementations.
Pstat_bb - An abstract base class for all PSTAT blackboard implementations.
Pstat_event_bb - A blackboard that stores a PSTAT against which PSTAT-related triggers poll.
Pstat_lock - Abstract base class for specialized locks on PSTAT's.
Reinit_event - An event object generated when PSTAT_REINIT_COMMAND is placed in the application's PSTAT Proc_cmd field.
Relative_time_bb - A blackboard for marking elapsed times.
Resume_event - An internally handled event generated when a PSTAT_RESUME_COMMAND is issued in the application's PSTAT.
Rootname - A field object that stores the root name portion of a full file specification.
Start_time - A field object that stores the START_TIME portion of a PSTAT.
Str_to_num - Class to convert strings to different types
Suspend_event - An internal event generated when a PSTAT_SUSPEND_COMMAND is placed in the application's PSTAT COMMAND field.
Suspended_event - An internally handled event object generated when the process is suspended (contains Proc_stat::SUSPENDED in its STATUS field).
System_time - A class for accessing the system clock.
Time_entry - An entry object used both by the absolute and relative time blackboards.
Time_event - An event object generated on one of the time blackboards indicating that a timer has expired
Time_stamp - A field object that stores the TIME_STAMP portion of an OSF.
Trigger - Defines the conditions for triggering an event on a blackboard.

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: 10 October 2003