fsf::CBarrier Class Reference
[Nodes]
The barrier synchronization node.
More...
#include <FsfBarrier.h>
Inherits fsf::CNode.
Collaboration diagram for fsf::CBarrier:
Public Member Functions | |
Creators | |
| CBarrier () | |
| 0-parameter constructor | |
| CBarrier (CNode *pParent, Time tTime=0) | |
| 2-parameter constructor: parent and timestamp | |
| CBarrier (const std::string &strName, CNode *pParent=NULL, Time tTime=0) | |
| 3-parameter constructor: name, parent and timestamp | |
| CBarrier (CActiveFilterBase *pFilter, Time tTimeOut=DEFAULT_TIME_OUT, CNode *pParent=NULL, Time tTime=0) | |
| 4-parameter constructor: active filter, timeout duration, parent and timestamp | |
| CBarrier (const std::string &strName, CActiveFilterBase *pFilter=NULL, Time tTimeOut=DEFAULT_TIME_OUT, CNode *pParent=NULL, Time tTime=0) | |
| 5-parameter constructor: name, active filter, timeout duration, parent and timestamp | |
| CBarrier (const CBarrier &rhs) | |
| Copy constructor. | |
| virtual | ~CBarrier () |
| Virtual destructor. | |
| virtual CNode * | clone () const |
| Cloning: necessary for run-time polymorphism. | |
Manipulators | |
| CBarrier & | operator= (const CBarrier &rhs) |
| Assignment operator. | |
| void | setFilter (CActiveFilterBase *pFilter) |
| Sets the active filter. | |
| void | setTimeOut (Time tTime) |
| Sets timeout duration. | |
| bool | filter (CActivePulse *pPulse) |
| Checks the pulse argument against this barrier's active filter. | |
| CActiveFilterBase * | getFilter () |
Gets a pointer to active filter Should really be an accessor (const). | |
Accessors | |
| virtual void | getTypeID (std::string &str) const |
| Returns factory mapping key. | |
| Time | getTimeOut () const |
| Gets timeout duration. | |
Detailed Description
The barrier synchronization node.Constructor & Destructor Documentation
| fsf::CBarrier::CBarrier | ( | ) | [inline] |
0-parameter constructor
2-parameter constructor: parent and timestamp
| fsf::CBarrier::CBarrier | ( | const std::string & | strName, | |
| CNode * | pParent = NULL, |
|||
| Time | tTime = 0 | |||
| ) | [inline] |
3-parameter constructor: name, parent and timestamp
| CBarrier::CBarrier | ( | CActiveFilterBase * | pFilter, | |
| Time | tTimeOut = DEFAULT_TIME_OUT, |
|||
| CNode * | pParent = NULL, |
|||
| Time | tTime = 0 | |||
| ) |
4-parameter constructor: active filter, timeout duration, parent and timestamp
| CBarrier::CBarrier | ( | const std::string & | strName, | |
| CActiveFilterBase * | pFilter = NULL, |
|||
| Time | tTimeOut = DEFAULT_TIME_OUT, |
|||
| CNode * | pParent = NULL, |
|||
| Time | tTime = 0 | |||
| ) |
5-parameter constructor: name, active filter, timeout duration, parent and timestamp
| CBarrier::CBarrier | ( | const CBarrier & | rhs | ) |
Copy constructor.
| CBarrier::~CBarrier | ( | ) | [virtual] |
Virtual destructor.
Member Function Documentation
| virtual CNode* fsf::CBarrier::clone | ( | ) | const [inline, virtual] |
| bool CBarrier::filter | ( | CActivePulse * | pPulse | ) |
Checks the pulse argument against this barrier's active filter.
| CActiveFilterBase * CBarrier::getFilter | ( | ) |
Gets a pointer to active filter Should really be an accessor (const).
Creates a copy for editing.
| Time fsf::CBarrier::getTimeOut | ( | ) | const [inline] |
Gets timeout duration.
| virtual void fsf::CBarrier::getTypeID | ( | std::string & | str | ) | const [inline, virtual] |
| void CBarrier::setFilter | ( | CActiveFilterBase * | pFilter | ) |
Sets the active filter.
Replaces with a new version.
Replaces the current filter with a clone of the argument.
| void fsf::CBarrier::setTimeOut | ( | Time | tTime | ) | [inline] |
Sets timeout duration.
The documentation for this class was generated from the following files:
