Public Types | Public Member Functions | Public Attributes | List of all members
Writer< T, PortType > Class Template Reference
Inheritance diagram for Writer< T, PortType >:
Inheritance graph
[legend]

Public Types

typedef Adaptor< SampleType, PortType > AdaptorType
 
typedef CopyAndAssignmentCounted< T > SampleType
 
- 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 {
  Init, PreOperational, FatalError, Exception,
  Stopped, Running, RunTimeError
}
 

Public Member Functions

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

Public Attributes

AdaptorType::OutputPort output_port
 
SampleType sample
 
Timer timer
 
std::map< WriteStatus, Timertimer_by_status
 

Additional Inherited Members

- 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 void cleanupHook ()
 
virtual bool configureHook ()
 
virtual void errorHook ()
 
virtual void exception ()
 
virtual void exceptionHook ()
 
virtual void fatal ()
 
virtual bool startHook ()
 
virtual void stopHook ()
 
- Protected Attributes inherited from ReaderWriterTaskContextBase
std::size_t desired_number_of_cycles_
 
std::string exception_reason_
 
Condition finished_
 
Mutex mutex_
 
std::size_t number_of_cycles_
 
- 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
 

Detailed Description

template<typename T, PortTypes PortType>
class Writer< T, PortType >

Definition at line 830 of file dataflow_performance_test.cpp.

Member Typedef Documentation

template<typename T , PortTypes PortType>
typedef Adaptor<SampleType,PortType> Writer< T, PortType >::AdaptorType

Definition at line 834 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
typedef CopyAndAssignmentCounted<T> Writer< T, PortType >::SampleType

Definition at line 833 of file dataflow_performance_test.cpp.

Constructor & Destructor Documentation

template<typename T , PortTypes PortType>
Writer< T, PortType >::Writer ( const std::string &  name,
std::size_t  index,
std::size_t  sample_size = 1,
bool  keep_last_written_value = false 
)
inline

Definition at line 840 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
Writer< T, PortType >::~Writer ( )
inline

Definition at line 857 of file dataflow_performance_test.cpp.

Member Function Documentation

template<typename T , PortTypes PortType>
bool Writer< T, PortType >::breakUpdateHook ( )
inlinevirtual

Implement this function if your code might block for long times inside the updateHook() function. Insert in this hook the code to wake up that code or signal it otherwise that updateHook() is requested to return (for example by setting a flag). The method returns false by default.

Returns
true if well received and updateHook() will soon return. False otherwise.

Reimplemented from RTT::base::TaskCore.

Definition at line 879 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
void Writer< T, PortType >::updateHook ( )
inlinevirtual

Function where the user must insert his 'application' code. When the ExecutionEngine's Activity is a periodic, this function is called by the ExecutionEngine in each periodic step after all messages are processed. When it is executed by a non periodic activity, this function is called after a message is received and executed. It should not loop forever, since no commands or events are processed when this function executes. The default implementation is an empty function.

Reimplemented from RTT::base::TaskCore.

Definition at line 863 of file dataflow_performance_test.cpp.

Member Data Documentation

template<typename T , PortTypes PortType>
AdaptorType::OutputPort Writer< T, PortType >::output_port

Definition at line 835 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
SampleType Writer< T, PortType >::sample

Definition at line 836 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
Timer Writer< T, PortType >::timer

Definition at line 837 of file dataflow_performance_test.cpp.

template<typename T , PortTypes PortType>
std::map<WriteStatus, Timer> Writer< T, PortType >::timer_by_status

Definition at line 838 of file dataflow_performance_test.cpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:46