Class Definition File | ODDSEMgr.idl | |
Class C++ Binding | ODDSEMgr.xh | |
Class Hierarchy |
SOMObject ODDSEventMgr | |
Description | The ODDSEventMgr class is the base class for managing events. It supplies methods for handling the events for an event set. This class is intended to be subclassed, but it provides methods that the containing object could invoke events generically. The actual method call should be defined in the subclass. The responsibilities of the event class are:
| |
Constructor | This constructor should be used instead of the default constructor to set the guid. | |
Signature |
| |
Parameters |
| |
Methods | The methods defined by the ODDSConnection class include: | |
Overridden Methods | There are no methods overridden by the ODDSEventMgr class. |
This method verifies that the ID of the sink matches the ID of the event manager and adds a reference to the sink to the event manager sink list.
Signature
long AddSink (ODDSSink *sink) |
Parameters
Returns
Remarks
This method verifies that the ID of the sink matches the ID of the event manager and adds a reference to the sink to the event manager sink list. A sink object can only be added to the event manager sink list once.
Exception Handling
Related Methods
This method accesses sinks connected to the event manager.
Signature
long CreateSinkEnum (ODDSSinkEnum **sink) |
Parameters
Returns
Remarks
This method returns an object that can be used to access the sinks connected to this event manager.
Exception Handling
This method invokes ODDSSink's FireEvent on the next sink in the enumerator.
Signature
long FireEvent (ODDSSinkEnum *sink, string eventName, _IDL_SEQUENCE_any *inputParms, long *result) |
Parameters
Returns
Remarks
This method invokes ODDSSink's FireEvent on the next sink in the enumerator. If all sinks have been previously called, returns an error.
Exception Handling
Related Methods
This method sets up a sink enumerator for calling sinks to notify them of an event.
Signature
long PrepareEventFiring (long *numberOfSinks, ODDSSinkEnum **sinks) |
Parameters
Returns
Remarks
This method sets up a sink enumerator for calling sinks to notify them of an event. Each subsequent call to FireEvent will increment the enumerator's cursor to notify the next sink.
Exception Handling
Related Methods
This method removes a reference to the sink from the event manager sink list.
Signature
long RemoveSink (ODGUID *id) |
Parameters
Returns
Remarks
This method removes the reference to the sink form the event manager sink list.
Exception Handling
Related Methods
This method determines if a sink is connected to an event manager sink list.
Signature
Boolean SinkIsConnected (ODDSSink *sink) |
Parameters
Returns
Remarks
This method determines if the sink is on the event manager sink list. If the sink is connected, returns a Boolean true; otherwise, returns a Boolean false.
Exception Handling
Related Methods
This method frees the event enumerator obtained by the PrepareEventFiring method.
Signature
long StopEventFiring (ODDSSinkEnum *sink) |
Parameters
Returns
Remarks
This method frees the sink enumerator obtained by the PrepareEventFiring method.
Exception Handling
Related Methods