InstantIO::Slot Class Reference
Abstract ancestor of all In- and OutSlots. More...
#include <InstantIO/Slot.h>
Public Types | |
| enum | Direction { In, Out } |
Enumeration of direction values. More... | |
Public Member Functions | |
| virtual | ~Slot () |
| This destroys the Slot object. | |
| const std::string & | getDescription () const |
| Returns the description of the Slot. | |
| virtual const char * | getTypeName () const =0 |
| Returns a human-readable string that describes the type that can be sent to or received from this Slot. | |
| virtual const std::type_info & | getTypeID () const =0 |
| Returns the RTTI type info object that describes the type that can be sent to or received from this Slot. | |
| virtual Direction | getDirection () const =0 |
| Returns the direction of the Slot (In or Out). | |
Protected Member Functions | |
| Slot (const std::string &description=std::string()) | |
| Creates a new Slot object. | |
| void | listenersLock () const |
| Locks the set of Listeners. | |
| void | listenersUnlock () const |
| Unlocks the set of Listeners. | |
| void | lock () const |
| Locks the data value and the vector of connected Slots. | |
| void | unlock () const |
| Unlocks the data value and the vector of connected Slots. | |
Protected Attributes | |
| std::string | description_ |
| The description of this OutSlot. | |
| Medusa::Mutex * | listenerMutex_ |
| Mutex that locks the set of Listeners. | |
| Medusa::Mutex * | mutex_ |
| Mutex that locks the data value and the vector of connected Slots. | |
Detailed Description
Abstract ancestor of all In- and OutSlots.
Applications do not use this class directly, instead they use one of its descendants (InSlot or OutSlot).
Member Enumeration Documentation
Enumeration of direction values.
Constructor & Destructor Documentation
| InstantIO::Slot::Slot | ( | const std::string & | description = std::string() |
) | [explicit, protected] |
Creates a new Slot object.
- Parameters:
-
description The description of this Slot. This information is not used by the InstantIO system directly, instead it is displayed for information purposes in user interfaces used to configure the InstantIO system.
Member Function Documentation
| const std::string& InstantIO::Slot::getDescription | ( | ) | const [inline] |
Returns the description of the Slot.
The description is not used by the InstantIO system directly, instead it is displayed for information purposes in user interfaces used to configure the InstantIO system.
- Returns:
- The description string.
| virtual const char* InstantIO::Slot::getTypeName | ( | ) | const [pure virtual] |
Returns a human-readable string that describes the type that can be sent to or received from this Slot.
This information is not used by the InstantIO system directly, instead it is displayed for information purposes in user interfaces used to configure the InstantIO system.
- Returns:
- A string that describes the type that can be sent to or received from this Slot.
Implemented in InstantIO::InSlot< T >, and InstantIO::OutSlot< T >.
| virtual const std::type_info& InstantIO::Slot::getTypeID | ( | ) | const [pure virtual] |
Returns the RTTI type info object that describes the type that can be sent to or received from this Slot.
- Returns:
- The RTTI type info object.
Implemented in InstantIO::InSlot< T >, and InstantIO::OutSlot< T >.
| virtual Direction InstantIO::Slot::getDirection | ( | ) | const [pure virtual] |
Returns the direction of the Slot (In or Out).
- Returns:
- The direction
Implemented in InstantIO::BasicInSlot, and InstantIO::BasicOutSlot.
The documentation for this class was generated from the following file:
