IEcSetOutputDirEventObserver Interface Reference

Observer interface for receiving Set Output Directory events from External Controllers. More...

#include <MpiAPI.h>

Inheritance diagram for IEcSetOutputDirEventObserver:

IEventObserver

List of all members.

Public Member Functions

virtual TEventType Type ()
 Returns the event type supported by the observer.
virtual BitSet EventDataTypes ()
 Returns the data items to provide with the event when it occurs.
virtual void HandleEvent (SSetOutputDirEventData &data)=0
 Event Handler.


Detailed Description

The Set Output Directory event is sent when the output file destination is changed by the loaded External Control module. The directory specified in the event data will be used by the Martini runtime for writing log messages.

The data items supported by this event are specified by the default implementation of the EventDataTypes method


Member Function Documentation

virtual TEventType Type (  )  [inline, virtual]

Returns the MPI event type requested by the observer. Implemented for each observer interface class. MPI clients that implement event-specific observer classes must not override this method.

Returns:
the MPI event type

Implements IEventObserver.

virtual BitSet EventDataTypes (  )  [inline, virtual]

Specifies the data items to provide with the event when it occurs. Data items are specified as a combination of TDataRequestType constants OR'ed together. By default, an event-specific observer interface returns the maximum possible data items that can be returned with that event. MPI clients can override this method to specify a subset of those data items to be returned with the event.

Returns:
a combination of bits, each represents a data item to provide when the event occurs.

Implements IEventObserver.

virtual void HandleEvent ( SSetOutputDirEventData data  )  [pure virtual]

Set Output Directory event handler

Parameters:
[in] data event data.


The documentation for this interface was generated from the following file:


Generated on Thu Mar 6 15:08:07 2008 for Martini by doxygen 1.5.5