System CATCallbackManager
Usage: you must use this class as is. You should never derive it.
public class CATCallbackManager
Class that manages the callbacks of a given event publisher.
Role: A callback manager attached to a given event publisher dispatches
the events that this event publisher publishes to all the subscribers.
This consists in calling the methods declared by the event subscribers while subscribing.
Constructor and Destructor Index
- o
~CATCallbackManager()
-
Method Index
- o
DispatchCallbacks(CATNotification*,void*)
- Dispatches the event published to all the subscribers.
- o
DispatchCallbacks(CATCallbackEvent,CATNotification*,void*)
- Dispatches the event published to all the event subscribers.
- o
HasClients(CATCallbackEvent)
- Checks whether the callback manager manages a subscriber list for a given event.
- o
RemoveAllCallbacks()
- Removes all the callbacks.
- o
RemoveCallbacksOnEvent(CATCallbackEvent)
- Removes all the callbacks added by all the subscribers for a given event.
Constructor and Destructor
o ~CATCallbackManager
| public ~CATCallbackManager( | ) |
-
Methods
o DispatchCallbacks
| public DispatchCallbacks( | | iPublishedNotification | =NULL, |
| | iEventPublisher | = NULL) |
-
Dispatches the event published to all the subscribers.
- Parameters:
-
- iNotification
- The notification that stands for the event
- iPublishingObject
- The event publisher
o DispatchCallbacks
| public DispatchCallbacks( | | iPublishedEvent, |
| | iPublishedNotification | =NULL, |
| | iEventPublisher | =NULL) |
-
Dispatches the event published to all the event subscribers.
Role: This method calls all the callback methods declared
by all the subscribers that
subscribe to the event publisher for the given notification.
- Parameters:
-
- iEvent
- The event which occurs
- iNotification
- The associated notification
- iEventPublisher
- The event publisher
o HasClients
| public HasClients( | | iEvent) |
-
Checks whether the callback manager manages a subscriber list for a given event.
- Parameters:
-
- iEvent
- The event in question
- Returns:
- Legal values: -1 if a subscriber list is found and 0 otherwise.
o RemoveAllCallbacks
| public RemoveAllCallbacks( | ) |
-
Removes all the callbacks.
Role: Removes all the callbacks managed by the callback manager
and added to its event publisher.
o RemoveCallbacksOnEvent
| public RemoveCallbacksOnEvent( | | iEvent) |
-
Removes all the callbacks added by all the subscribers for a given event.
- Parameters:
-
- iEvent
- The event for which the callbacks must be removed
This object is included in the file: CATCallbackManager.h
If needed, your Imakefile.mk should include the module: JS0GROUP
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.