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

Constructors:

Resume_event( )
~Resume_event( )

Methods:

clone( )	create copy of object
add_callback( )	assign Event callback
process( )	process this Event
pstat_mesg( )	get PSTAT status

Description

An internally handled PSTAT Event that is generated when the application's PSTAT contains a Proc_cmd set to the value PSTAT_RESUME_COMMAND. When a Resume_event is generated, the Opus_env object catches the exception and completes processing.

Derived from

Event

See Also:

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

Resume_event::Resume_event - The Resume_event constructor.

Synopsis

Resume_event::Resume_event(
                           Blackboard* bbrd) // I - pointer to PSTAT
                                             //     Blackboard

Resume_event::Resume_event(
                           Blackboard* bbrd,        // I - pointer to PSTAT
                                                    //     Blackboard
                           const string& s,         // I - Trigger name
                           const vector<Entry*>& v) // I - applications's
                                                    //     PSTAT

Description

These methods create either a Resume_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

Resume_event::~Resume_event - The Resume_event destructor.

Synopsis

Resume_event::~Resume_event()

Description

This method destroys the object.

Exceptions Thrown

none

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

Synopsis

Event* Resume_event::clone() const

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

Description

These methods create a new Resume_event object off the heap using the constructor with the same signature. The caller should delete the new object when it is no longer needed.

Returns

    A pointer to the new Resume_event object.

Exceptions Thrown

Internal_event

- if the clone method containing triggering entries is used

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

Synopsis

Proc_stat* Resume_event::pstat_mesg() const

Description

This method creates a new Proc_stat object containing Proc_stat::IDLE. The caller should delete the Proc_stat object when it is no longer needed.

Returns

    A pointer to the Proc_stat object.

Exceptions Thrown

none

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

Synopsis

void Resume_event::add_callback(
                                void (*pf)(const string&, // I - callback
                                           Event*, const Opus_env&))

Description

This method takes a function pointer that will serve as a callback function for all events of this type. The callback function foo must have a signature and return type of

     void foo(const string&, Event*, const Opus_env&) 

Exceptions Thrown

none

Resume_event::process - Process the event.

Synopsis

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

Description

No processing of this Event is required-- this method simply returns without doing anything.

Exceptions Thrown

none

For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000