Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OCL::TimerComponent Class Reference

A Component interface to the Real-Time types::Toolkit's timer. It must be configured with a Activity which will emit the timeout event of this component. More...

#include <TimerComponent.hpp>

Inheritance diagram for OCL::TimerComponent:
Inheritance graph
[legend]

Classes

struct  TimeoutCatcher
 

Public Member Functions

 TimerComponent (std::string name="os::Timer")
 
virtual ~TimerComponent ()
 
- Public Member Functions inherited from RTT::TaskContext
bool addAttribute (const std::string &name, T &attr)
 
bool addAttribute (base::AttributeBase &a)
 
bool addAttribute (base::AttributeBase &a)
 
bool addAttribute (const std::string &name, T &attr)
 
bool addConstant (const std::string &name, const T &attr)
 
bool addConstant (const std::string &name, const T &attr)
 
base::InputPortInterfaceaddEventPort (const std::string &name, base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::InputPortInterfaceaddEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
Operation< Signature > & addOperation (Operation< Signature > &op)
 
Operation< Signature > & addOperation (Operation< Signature > &op)
 
Operation< typename internal::GetSignature< Func >::Signature > & addOperation (const std::string name, Func func, Service *serv, ExecutionThread et=ClientThread)
 
Operation< Signature > & addOperation (const std::string name, Signature *func, ExecutionThread et=ClientThread)
 
Operation< typename internal::GetSignature< Func >::Signature > & addOperation (const std::string name, Func func, Service *serv, ExecutionThread et=ClientThread)
 
Operation< Signature > & addOperation (const std::string name, Signature *func, ExecutionThread et=ClientThread)
 
virtual bool addPeer (TaskContext *peer, std::string alias="")
 
virtual bool addPeer (TaskContext *peer, std::string alias="")
 
base::PortInterfaceaddPort (const std::string &name, base::PortInterface &port)
 
base::PortInterfaceaddPort (base::PortInterface &port)
 
Property< T > & addProperty (const std::string &name, T &attr)
 
bool addProperty (base::PropertyBase &pb)
 
Property< T > & addProperty (const std::string &name, T &attr)
 
bool addProperty (base::PropertyBase &pb)
 
ConfigurationInterfaceattributes ()
 
ConfigurationInterfaceattributes ()
 
virtual void clear ()
 
virtual bool connectPeers (TaskContext *peer)
 
virtual bool connectPeers (TaskContext *peer)
 
virtual bool connectPorts (TaskContext *peer)
 
virtual bool connectServices (TaskContext *peer)
 
virtual bool connectServices (TaskContext *peer)
 
virtual void disconnect ()
 
virtual void disconnect ()
 
virtual void disconnectPeers (const std::string &name)
 
virtual void disconnectPeers (const std::string &name)
 
base::ActivityInterfacegetActivity ()
 
T * getActivity ()
 
base::AttributeBasegetAttribute (const std::string &name) const
 
base::AttributeBasegetAttribute (const std::string &name) const
 
virtual const std::string & getName () const
 
OperationInterfacePartgetOperation (std::string name)
 
OperationInterfacePartgetOperation (std::string name)
 
virtual TaskContextgetPeer (const std::string &peer_name) const
 
virtual TaskContextgetPeer (const std::string &peer_name) const
 
virtual PeerList getPeerList () const
 
virtual PeerList getPeerList () const
 
base::PortInterfacegetPort (const std::string &name) const
 
base::PropertyBasegetProperty (const std::string &name) const
 
base::PropertyBasegetProperty (const std::string &name) const
 
boost::shared_ptr< ServiceType > getProvider (const std::string &name)
 
boost::shared_ptr< ServiceType > getProvider (const std::string &name)
 
virtual bool hasPeer (const std::string &peer_name) const
 
virtual bool hasPeer (const std::string &peer_name) const
 
bool loadService (const std::string &service_name)
 
bool loadService (const std::string &service_name)
 
OperationInterfaceoperations ()
 
OperationInterfaceoperations ()
 
DataFlowInterfaceports ()
 
const DataFlowInterfaceports () const
 
PropertyBagproperties ()
 
PropertyBagproperties ()
 
Service::shared_ptr provides (const std::string &service_name)
 
Service::shared_ptr provides ()
 
Service::shared_ptr provides ()
 
Service::shared_ptr provides (const std::string &service_name)
 
virtual bool ready ()
 
virtual void removePeer (const std::string &name)
 
virtual void removePeer (TaskContext *peer)
 
virtual void removePeer (TaskContext *peer)
 
virtual void removePeer (const std::string &name)
 
ServiceRequester::shared_ptr requires (const std::string &service_name)
 
ServiceRequester::shared_ptr requires (const std::string &service_name)
 
ServiceRequester::shared_ptr requires ()
 
ServiceRequester::shared_ptr requires ()
 
bool setActivity (base::ActivityInterface *new_act)
 
virtual bool start ()
 
virtual bool stop ()
 
 TaskContext (const std::string &name, TaskState initial_state=Stopped)
 
virtual ~TaskContext ()
 
- Public Member Functions inherited from RTT::base::TaskCore
virtual bool activate ()
 
virtual bool activate ()
 
virtual bool cleanup ()
 
virtual bool cleanup ()
 
virtual bool configure ()
 
virtual bool configure ()
 
const ExecutionEngineengine () const
 
ExecutionEngineengine ()
 
virtual void error ()
 
virtual void error ()
 
virtual unsigned getCpuAffinity () const
 
virtual unsigned getCpuAffinity () const
 
unsigned int getCycleCounter () const
 
unsigned int getIOCounter () const
 
virtual Seconds getPeriod () const
 
virtual Seconds getPeriod () const
 
virtual TaskState getTargetState () const
 
virtual TaskState getTaskState () const
 
unsigned int getTimeOutCounter () const
 
unsigned int getTriggerCounter () const
 
virtual bool inException () const
 
virtual bool inException () const
 
virtual bool inFatalError () const
 
virtual bool inFatalError () const
 
virtual bool inRunTimeError () const
 
virtual bool inRunTimeError () const
 
virtual bool isActive () const
 
virtual bool isActive () const
 
virtual bool isConfigured () const
 
virtual bool isConfigured () const
 
virtual bool isRunning () const
 
virtual bool isRunning () const
 
virtual bool recover ()
 
virtual bool recover ()
 
virtual bool setCpuAffinity (unsigned cpu)
 
virtual bool setCpuAffinity (unsigned cpu)
 
virtual bool setPeriod (Seconds s)
 
virtual bool setPeriod (Seconds s)
 
 TaskCore (TaskState initial_state=Stopped, const std::string &name=std::string())
 
virtual bool trigger ()
 
virtual bool trigger ()
 
virtual bool update ()
 
virtual bool update ()
 
virtual ~TaskCore ()
 

Protected Member Functions

bool isTimerExpired (RTT::os::Timer::TimerId id) const
 
bool startHook ()
 
void stopHook ()
 
void updateHook ()
 
bool wait (RTT::os::Timer::TimerId id, double seconds)
 
bool waitFor (RTT::os::Timer::TimerId id)
 
- Protected Member Functions inherited from RTT::TaskContext
virtual void dataOnPortCallback (base::PortInterface *port)
 
virtual bool dataOnPortHook (base::PortInterface *port)
 
void forceActivity (base::ActivityInterface *new_act)
 
- Protected Member Functions inherited from RTT::base::TaskCore
virtual bool breakUpdateHook ()
 
virtual void cleanupHook ()
 
virtual bool configureHook ()
 
virtual void errorHook ()
 
virtual void exception ()
 
virtual void exceptionHook ()
 
virtual void fatal ()
 

Protected Attributes

OutputPort< RTT::os::Timer::TimerIdmtimeoutEvent
 
TimeoutCatcher mtimer
 
std::vector< OutputPort< RTT::os::Timer::TimerId > * > port_timers
 
RTT::Operation< bool(RTT::os::Timer::TimerId, double)> waitCommand
 
RTT::Operation< bool(RTT::os::Timer::TimerId)> waitForCommand
 
- Protected Attributes inherited from RTT::base::TaskCore
ExecutionEngineee
 
unsigned int mCycleCounter
 
unsigned int mIOCounter
 
std::string mName
 
TaskState mTaskState
 
unsigned int mTimeOutCounter
 
unsigned int mTriggerCounter
 
bool mTriggerOnStart
 

Additional Inherited Members

- Public Types inherited from RTT::TaskContext
typedef std::vector< std::string > PeerList
 
typedef boost::function< void(base::PortInterface *)> SlotFunction
 
- Public Types inherited from RTT::base::TaskCore
enum  TaskState
 
- Public Attributes inherited from RTT::base::TaskCore
 Exception
 
 FatalError
 
 Init
 
 PreOperational
 
 Running
 
 RunTimeError
 
 Stopped
 

Detailed Description

A Component interface to the Real-Time types::Toolkit's timer. It must be configured with a Activity which will emit the timeout event of this component.

Definition at line 21 of file TimerComponent.hpp.

Constructor & Destructor Documentation

OCL::TimerComponent::TimerComponent ( std::string  name = "os::Timer")

Set up a component for timing events.

Definition at line 14 of file TimerComponent.cpp.

OCL::TimerComponent::~TimerComponent ( )
virtual

Definition at line 40 of file TimerComponent.cpp.

Member Function Documentation

bool OCL::TimerComponent::isTimerExpired ( RTT::os::Timer::TimerId  id) const
protected

Command Condition: return true if id expired.

Definition at line 71 of file TimerComponent.cpp.

bool OCL::TimerComponent::startHook ( )
protectedvirtual

This hook will check if a Activity has been properly setup.

Reimplemented from RTT::base::TaskCore.

Definition at line 46 of file TimerComponent.cpp.

void OCL::TimerComponent::stopHook ( )
protectedvirtual

Reimplemented from RTT::base::TaskCore.

Definition at line 56 of file TimerComponent.cpp.

void OCL::TimerComponent::updateHook ( )
protectedvirtual

Reimplemented from RTT::base::TaskCore.

Definition at line 51 of file TimerComponent.cpp.

bool OCL::TimerComponent::wait ( RTT::os::Timer::TimerId  id,
double  seconds 
)
protected

Command Implementation: arm and wait until a timer expires.

Definition at line 61 of file TimerComponent.cpp.

bool OCL::TimerComponent::waitFor ( RTT::os::Timer::TimerId  id)
protected

Command Implementation: wait until a timer expires.

Definition at line 66 of file TimerComponent.cpp.

Member Data Documentation

OutputPort<RTT::os::Timer::TimerId> OCL::TimerComponent::mtimeoutEvent
protected

Definition at line 43 of file TimerComponent.hpp.

TimeoutCatcher OCL::TimerComponent::mtimer
protected

Definition at line 44 of file TimerComponent.hpp.

std::vector<OutputPort<RTT::os::Timer::TimerId>* > OCL::TimerComponent::port_timers
protected

Definition at line 42 of file TimerComponent.hpp.

RTT::Operation<bool(RTT::os::Timer::TimerId, double)> OCL::TimerComponent::waitCommand
protected

Command: arm and wait until a timer expires.

Definition at line 62 of file TimerComponent.hpp.

RTT::Operation<bool(RTT::os::Timer::TimerId)> OCL::TimerComponent::waitForCommand
protected

Command: wait until a timer expires.

Definition at line 57 of file TimerComponent.hpp.


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


ocl
Author(s): OCL Development Team
autogenerated on Wed Jun 26 2019 19:26:27