RTT::PulseTrainGeneratorInterface Class Reference

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

#include <rtt/dev/PulseTrainGeneratorInterface.hpp>

Inheritance diagram for RTT::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 47 of file PulseTrainGeneratorInterface.hpp.

---

Constructor & Destructor Documentation

RTT::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 57 of file PulseTrainGeneratorInterface.hpp.

---

Member Function Documentation

virtual bool RTT::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::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

---

Member Data Documentation

NameServer<PulseTrainGeneratorInterface*> RTT::PulseTrainGeneratorInterface::nameserver [static]

The NameServer of this interface.

See also:

NameServer

Definition at line 71 of file PulseTrainGeneratorInterface.hpp.

---

The documentation for this class was generated from the following file:

• rtt/dev/PulseTrainGeneratorInterface.hpp