A generic interface to a pulsetraingenerator for simulation of encoder like behaviour. More...
#include <PulseTrainGeneratorInterface.hpp>
Public Member Functions | |
| virtual bool | pulsePeriodSet (psecs picos)=0 |
| Set Pulse Period. | |
| PulseTrainGeneratorInterface (const std::string &name) | |
| Create a PulseTrainGeneratorInterface with a name. | |
| PulseTrainGeneratorInterface () | |
| Create a not nameserved PulseTrainGeneratorInterface instance. | |
| virtual bool | pulseWidthSet (psecs picos)=0 |
| Set Pulse Width. | |
| virtual bool | start ()=0 |
| Start the pulse train generation. | |
| virtual bool | stop ()=0 |
| Stop the pulse train generation. | |
| virtual | ~PulseTrainGeneratorInterface () |
Static Public Attributes | |
| static NameServer < PulseTrainGeneratorInterface * > | nameserver |
Detailed Description
A generic interface to a pulsetraingenerator for simulation of encoder like behaviour.
Definition at line 48 of file PulseTrainGeneratorInterface.hpp.
Constructor & Destructor Documentation
| RTT::dev::PulseTrainGeneratorInterface::PulseTrainGeneratorInterface | ( | const std::string & | name | ) | [inline] |
Create a PulseTrainGeneratorInterface with a name.
When name is not "", and unique, it can be retrieved through PulseTrainGeneratorInterface::nameserver .
Definition at line 58 of file PulseTrainGeneratorInterface.hpp.
Create a not nameserved PulseTrainGeneratorInterface instance.
Definition at line 65 of file PulseTrainGeneratorInterface.hpp.
| virtual RTT::dev::PulseTrainGeneratorInterface::~PulseTrainGeneratorInterface | ( | ) | [inline, virtual] |
Definition at line 74 of file PulseTrainGeneratorInterface.hpp.
Member Function Documentation
| virtual bool RTT::dev::PulseTrainGeneratorInterface::pulsePeriodSet | ( | psecs | picos | ) | [pure virtual] |
Set Pulse Period.
- Parameters:
-
picos Pulse Period expressed in (integer) picoseconds
- Returns:
- true when succeeded
- Precondition:
- PulseWidth should be smaller than PulsePeriod
| virtual bool RTT::dev::PulseTrainGeneratorInterface::pulseWidthSet | ( | psecs | picos | ) | [pure virtual] |
Set Pulse Width.
- Parameters:
-
picos Pulse Width expressed in (integer) picoseconds
- Returns:
- true when succeeded
- Precondition:
- PulseWidth should be smaller than PulsePeriod
| virtual bool RTT::dev::PulseTrainGeneratorInterface::start | ( | ) | [pure virtual] |
Start the pulse train generation.
| virtual bool RTT::dev::PulseTrainGeneratorInterface::stop | ( | ) | [pure virtual] |
Stop the pulse train generation.
Member Data Documentation
The NameServer of this interface.
- See also:
- NameServer
Definition at line 72 of file PulseTrainGeneratorInterface.hpp.
The documentation for this class was generated from the following files: