Orocos Real-Time Toolkit  2.6.0
Public Member Functions | Static Public Attributes
RTT::dev::PulseTrainGeneratorInterface Class Reference

A generic interface to a pulsetraingenerator for simulation of encoder like behaviour. More...

#include <rtt/extras/dev/PulseTrainGeneratorInterface.hpp>

Inheritance diagram for RTT::dev::PulseTrainGeneratorInterface:
RTT::dev::NameServerRegistrator< PulseTrainGeneratorInterface * >

List of all members.

Public Member Functions

 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 pulsePeriodSet (psecs picos)=0
 Set Pulse Period.
virtual bool start ()=0
 Start the pulse train generation.
virtual bool stop ()=0
 Stop the pulse train generation.

Static Public Attributes

static NameServer
< PulseTrainGeneratorInterface * > 
nameserver
 The NameServer of this interface.

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

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.


Member Function Documentation

virtual bool RTT::dev::PulseTrainGeneratorInterface::pulsePeriodSet ( psecs  picos) [pure virtual]

Set Pulse Period.

Parameters:
picosPulse 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:
picosPulse Width expressed in (integer) picoseconds
Returns:
true when succeeded
Precondition:
PulseWidth should be smaller than PulsePeriod

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: