ex2b::CPulsarControl Class Reference
[Example 2b, Nodes]
A custom node type that encapsulates the attributes and operations necessary for feedback control of the pulsar rate.
More...
Inherits fsf::CNode.
Collaboration diagram for ex2b::CPulsarControl:
Public Member Functions | |
Creators | |
| CPulsarControl () | |
| Default constructor. | |
| CPulsarControl (CNode *pParent, Time tTime=0) | |
| 2-parameter constructor: parent and timestamp | |
| CPulsarControl (const std::string &strName, CNode *pParent=NULL, Time tTime=0) | |
| 3-parameter constructor: name, parent and timestamp | |
| CPulsarControl (const CPulsarControl &rhs) | |
| Copy constructor. | |
| virtual CNode * | clone () |
| Cloning: necessary for run-time polymorphism. | |
Manipulators | |
| CPulsarControl & | operator= (const CPulsarControl &rhs) |
| Assignment operator. | |
| void | setTargetInterval (fsf::Time t) |
| Sets this node's target interval attribute value. | |
| void | setLastTime (fsf::Time t) |
| Sets this node's last recorded time stamp attribute value. | |
| fsf::Time | stepControl (double dMeasuredTime) |
| Computes a pulsar delay value based on the target interval, the last recorded time stamp and the measured time stamp argument. | |
Accessors | |
| virtual void | getTypeID (std::string &str) const |
| Returns this node type's factory mapping key. | |
| fsf::Time | getTargetInterval () const |
| Gets this node's target interval attribute value. | |
| fsf::Time | getLastTime () const |
| Gets this node's last recorded time stamp attribute value. | |
Detailed Description
A custom node type that encapsulates the attributes and operations necessary for feedback control of the pulsar rate.Constructor & Destructor Documentation
| ex2b::CPulsarControl::CPulsarControl | ( | ) | [inline] |
Default constructor.
2-parameter constructor: parent and timestamp
| ex2b::CPulsarControl::CPulsarControl | ( | const std::string & | strName, | |
| CNode * | pParent = NULL, |
|||
| Time | tTime = 0 | |||
| ) | [inline] |
3-parameter constructor: name, parent and timestamp
| ex2b::CPulsarControl::CPulsarControl | ( | const CPulsarControl & | rhs | ) |
Copy constructor.
Member Function Documentation
| virtual CNode* ex2b::CPulsarControl::clone | ( | ) | [inline, virtual] |
Cloning: necessary for run-time polymorphism.
| fsf::Time ex2b::CPulsarControl::getLastTime | ( | ) | const [inline] |
Gets this node's last recorded time stamp attribute value.
| fsf::Time ex2b::CPulsarControl::getTargetInterval | ( | ) | const [inline] |
Gets this node's target interval attribute value.
| virtual void ex2b::CPulsarControl::getTypeID | ( | std::string & | str | ) | const [inline, virtual] |
| CPulsarControl & ex2b::CPulsarControl::operator= | ( | const CPulsarControl & | rhs | ) |
Assignment operator.
| void ex2b::CPulsarControl::setLastTime | ( | fsf::Time | t | ) | [inline] |
Sets this node's last recorded time stamp attribute value.
| void ex2b::CPulsarControl::setTargetInterval | ( | fsf::Time | t | ) | [inline] |
Sets this node's target interval attribute value.
| fsf::Time ex2b::CPulsarControl::stepControl | ( | double | dMeasuredTime | ) | [inline] |
Computes a pulsar delay value based on the target interval, the last recorded time stamp and the measured time stamp argument.
Updates last recorded time stamp.
The documentation for this class was generated from the following file:
