fsf::CActivePulse Class Reference
The active pulse class. More...
#include <FsfPulse.h>
Inherits fsf::CPulse.
Collaboration diagram for fsf::CActivePulse:
Public Member Functions | |
Creators | |
| CActivePulse () | |
| 0-parameter constructor | |
| CActivePulse (const std::string &strName, Time tTime=0) | |
| 2-parameter constructor: name and timestamp | |
| CActivePulse (const CActivePulse &rhs) | |
| Copy constructor. | |
| CActivePulse & | operator= (const CActivePulse &rhs) |
| Assignment operator. | |
| virtual CNode * | clone () |
| Cloning: necessary for run-time polymorphism. | |
Accessors | |
| virtual void | getTypeID (std::string &str) |
| Gets the factory mapping key. | |
| int | getNbPaths () |
| Gets the number of stream paths along which this pulse is currently active. | |
Manipulators | |
| int | incNbPaths (int nNbPaths=1) |
| Increments the number of paths along which this pulse is currently active (thread safe). | |
| int | decNbPaths () |
| Decrements the number of paths along which this pulse is currently active (thread safe). | |
Protected Attributes | |
| CMutex | m_csNbPaths |
| A mutex for the number of paths. | |
| int | m_nNbPaths |
| The number of stream paths along which this pulse is active. | |
Detailed Description
The active pulse class.Constructor & Destructor Documentation
| fsf::CActivePulse::CActivePulse | ( | ) | [inline] |
0-parameter constructor
| fsf::CActivePulse::CActivePulse | ( | const std::string & | strName, | |
| Time | tTime = 0 | |||
| ) | [inline] |
2-parameter constructor: name and timestamp
| fsf::CActivePulse::CActivePulse | ( | const CActivePulse & | rhs | ) | [inline] |
Copy constructor.
Member Function Documentation
| virtual CNode* fsf::CActivePulse::clone | ( | ) | [inline, virtual] |
| int fsf::CActivePulse::decNbPaths | ( | ) | [inline] |
Decrements the number of paths along which this pulse is currently active (thread safe).
| int fsf::CActivePulse::getNbPaths | ( | ) | [inline] |
Gets the number of stream paths along which this pulse is currently active.
| virtual void fsf::CActivePulse::getTypeID | ( | std::string & | str | ) | [inline, virtual] |
| int fsf::CActivePulse::incNbPaths | ( | int | nNbPaths = 1 |
) | [inline] |
Increments the number of paths along which this pulse is currently active (thread safe).
| CActivePulse & CActivePulse::operator= | ( | const CActivePulse & | rhs | ) |
Assignment operator.
Member Data Documentation
CMutex fsf::CActivePulse::m_csNbPaths [protected] |
A mutex for the number of paths.
int fsf::CActivePulse::m_nNbPaths [protected] |
The number of stream paths along which this pulse is active.
The documentation for this class was generated from the following files:
