tecplot::toolbox::StateChangeNotifierInterface Class Reference
#include <StateChangeNotifierInterface.h>
Inheritance diagram for tecplot::toolbox::StateChangeNotifierInterface:
Public Member Functions | |
| virtual void | addListener (StateChangeListenerInterface *listener)=0 |
| Register a listener with the StateChangeNotifier. | |
| virtual void | removeListener (StateChangeListenerInterface *listener)=0 |
| Remove a listener from the StateChangeNotifier. | |
| virtual bool | isListening (StateChangeListenerInterface *listener)=0 |
| Checks to see if a particular listener is registered with the StateChangeNotifier. | |
| virtual bool | setMode (StateChangeMode_e mode)=0 |
| Sets the mode in which state changes are propagated to the registered listeners. | |
| virtual StateChangeMode_e | mode ()=0 |
| virtual | ~StateChangeNotifierInterface () |
Constructor & Destructor Documentation
| virtual tecplot::toolbox::StateChangeNotifierInterface::~StateChangeNotifierInterface | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual void tecplot::toolbox::StateChangeNotifierInterface::addListener | ( | StateChangeListenerInterface * | listener | ) | [pure virtual] |
Register a listener with the StateChangeNotifier.
- Note:
- Tecplot must be locked when calling this method. Override lockStart and lockFinish methods to provide locking as a convenience.
- Parameters:
-
listener Pointer to the listener class that has implemented the StateChangeListenerInterface
- Exceptions:
-
OutOfMemoryException OutOfMemoryException is thrown if listener could not be added.
Implemented in tecplot::toolbox::StateChangeNotifier.
| virtual void tecplot::toolbox::StateChangeNotifierInterface::removeListener | ( | StateChangeListenerInterface * | listener | ) | [pure virtual] |
Remove a listener from the StateChangeNotifier.
- Note:
- Tecplot must be locked when calling this method. Override lockStart and lockFinish methods to provide locking as a convenience.
- Parameters:
-
listener Pointer to the listener class that has implemented the StateChangeListenerInterface
Implemented in tecplot::toolbox::StateChangeNotifier.
| virtual bool tecplot::toolbox::StateChangeNotifierInterface::isListening | ( | StateChangeListenerInterface * | listener | ) | [pure virtual] |
Checks to see if a particular listener is registered with the StateChangeNotifier.
- Parameters:
-
listener Pointer to the listener class that has implemented the StateChangeListenerInterface
- Returns:
- true if the listener is registered, false otherwise.
Implemented in tecplot::toolbox::StateChangeNotifier.
| virtual bool tecplot::toolbox::StateChangeNotifierInterface::setMode | ( | StateChangeMode_e | mode | ) | [pure virtual] |
Sets the mode in which state changes are propagated to the registered listeners.
- Note:
- Tecplot must be locked when calling this method. Override lockStart and lockFinish methods to provide locking as a convenience.
- Parameters:
-
mode Mode you want state changes propagated to your listeners. Choose either StateChangeMode_v80, StateChangeMode_v100, or StateChangeMode_v113. See the section "Sending State Changes" in the "ADK User's Manual" for a complete description of the differences between these options.
- Returns:
- Returns true is successful, false otherwise
Implemented in tecplot::toolbox::StateChangeNotifier.
| virtual StateChangeMode_e tecplot::toolbox::StateChangeNotifierInterface::mode | ( | ) | [pure virtual] |
- Returns:
- The current mode for which the listeners are registerd to receive the state change notifications.
Implemented in tecplot::toolbox::StateChangeNotifier.
