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

Constructors:

Low_store_event( )
~Low_store_event( )

Methods:

clone( )	returns a copy of this object and sets the event trigger name and triggering entries
add_callback( )	no-op
process( )	no-op
pstat_mesg( )	gets the Proc_stat object with which the process' PSTAT status field can be updated to indicate this event has occurred

Description

This Event object is created when disk space required by the application falls below a specified minimum. The event is generated during polling of the command blackboard, and is internally handled by Opus_env.

Derived from

Event

See Also:

• Event
• Command_bb
• Internal_event
• Opus_commands
• "OPUS API Blackboard and Support Classes Design Document"

Low_store_event::Low_store_event - The Low_store_event constructor.

Synopsis

Low_store_event::Low_store_event(
                                 Blackboard* bbrd) // I - pointer to the
                                                   //     command blackboard

Low_store_event::Low_store_event(
                                 Blackboard* bbrd,        // I - pointer to
                                                          //     the command
                                                          //     blackboard
                                 const string& s,         // I - Trigger 
                                                          //     name
                                 const vector<Entry*>& v) //   - triggers

Description

These methods create either a Low_store_event object to be used as a factory or in response to an actual event. In the former case, only the blackboard on which this event occurs need be specified-- the object can then be used to create clones whenever a real event occurs. In the case of a real event, the trigger name and the vector of entry objects that are responsible for the event also are specified.

Warning: no checks are made that the correct blackboard type and entry types are used as calling arguments.

Exceptions Thrown

none

Low_store_event::Low_store_event - The Low_store_event destructor.

Synopsis

Low_store_event::~Low_store_event() 

Description

This method destroys the object.

Exceptions Thrown

none

Low_store_event::clone - Create a copy of this object.

Synopsis

Event* Low_store_event::clone() const

Event* Low_store_event::clone(
                              const string& s,         // I - Trigger 
                                                       //     name
                              const vector<Entry*>& v) // I - triggers
                              const

Description

These methods create a new Low_store_event object off the heap using the constructor with the same signature. The version taking triggering entries throws an Internal_event object. The caller should delete the new object when it is no longer needed.

Returns

    A pointer to the new Low_store_event object.

Exceptions Thrown

Internal_event

- if the clone method containing triggering entries is used

Low_store_event::pstat_mesg - Get the Proc_stat object for updating the application's PSTAT status field.

Synopsis

Proc_stat* Low_store_event::pstat_mesg() const

Description

This method returns a Proc_stat object containing the string Proc_stat::IOWAIT. The caller should delete the Proc_stat object when it is no longer needed.

Returns

    A pointer to a Proc_stat object initialized with the string
    Proc_stat::IOWAIT.

Exceptions Thrown

none

Low_store_event::add_callback - Register the callback funtion for event processing.

Synopsis

void Low_store_event::add_callback(
                                   void (*pf)(const string&, // I - pointer
                                                             //     to the
                                                             //     callback
                                                             //     function
                                              Event*, const Opus_env&))

Description

This event type is internally handled by Opus_env, so no callback function is called by the process method. A callback function can be assigned using this method, but it will never be called.

Exceptions Thrown

none

Low_store_event::process - Process the Event.

Synopsis

void Low_store_event::process(
                              const Opus_env& oenv) // I - Opus_env object

Description

No processing of this event type is supported (these events are internally handled by Opus_env).

Exceptions Thrown

none

For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000