Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

RTM::InPortAny< T > Class Template Reference

OutPort template class. More...

#include <RtcInPort.h>

Inheritance diagram for RTM::InPortAny< T >:

RTM::InPortBase List of all members.

Public Member Functions

 InPortAny (const char *name, T &value, int bufsize=64)
 A constructor.

 InPortAny (const char *name, int bufsize=64)
 A constructor.

virtual ~InPortAny ()
 A destructor.

virtual void put (const CORBA::Any &value) throw (RTM::InPort::Disconnected, CORBA::SystemException)
 [CORBA interface] Put data on InPort

virtual void initBuffer (T &value)
 Initialize ring buffer value of InPort.

virtual void read_pm ()
 Read into bound T-type data from current InPort.

virtual T read ()
 Read into bound T-type data from current InPort.

virtual bool operator>> (T &rhs)
 Read from InPort buffer to type-T variable.

virtual bool isNew ()
 Check the newest data is new data to be read.

virtual int getNewDataLen ()
 Get number of new data to be read.

virtual std::vector< T > getNewList ()
 Get new data to be read.

virtual std::vector< T > getNewListReverse ()
 Get new data to be read.

virtual PortProfile * profile () throw (CORBA::SystemException)
 [CORBA interface] Get InPort profile

const char * name ()
 Get InPort name.


Protected Attributes

PortProfile m_Profile
 InPort profile.


Detailed Description

template<class T>
class RTM::InPortAny< T >

OutPort template class.

This class template provides interfaces to input port. Component developer can define input value, which act as input port from other components, using this template. This is class template. This class have to be incarnated class as port value types. This value types are previously define RtComponent IDL. ex. type T: TimedFload, TimedLong etc...


Constructor & Destructor Documentation

template<class T>
RTM::InPortAny< T >::InPortAny const char *  name,
T &  value,
int  bufsize = 64
[inline]
 

A constructor.

Setting channel name and registering channel value.

Parameters:
name A name of the InPort. This name is referred by InPortBase::name().
value A channel value related with the channel.
bufsize Buffer length of internal ring buffer of InPort

template<class T>
RTM::InPortAny< T >::InPortAny const char *  name,
int  bufsize = 64
[inline]
 

A constructor.

Setting channel name and registering channel value.

Parameters:
name A name of the InPort. This name is referred by InPortBase::name().
bufsize Buffer length of internal ring buffer of InPort

template<class T>
virtual RTM::InPortAny< T >::~InPortAny  )  [inline, virtual]
 

A destructor.


Member Function Documentation

template<class T>
virtual int RTM::InPortAny< T >::getNewDataLen  )  [inline, virtual]
 

Get number of new data to be read.

template<class T>
virtual std::vector<T> RTM::InPortAny< T >::getNewList  )  [inline, virtual]
 

Get new data to be read.

template<class T>
virtual std::vector<T> RTM::InPortAny< T >::getNewListReverse  )  [inline, virtual]
 

Get new data to be read.

template<class T>
virtual void RTM::InPortAny< T >::initBuffer T &  value  )  [inline, virtual]
 

Initialize ring buffer value of InPort.

template<class T>
virtual bool RTM::InPortAny< T >::isNew  )  [inline, virtual]
 

Check the newest data is new data to be read.

const char* RTM::InPortBase::name  )  [inline, inherited]
 

Get InPort name.

template<class T>
virtual bool RTM::InPortAny< T >::operator>> T &  rhs  )  [inline, virtual]
 

Read from InPort buffer to type-T variable.

Parameters:
rhs type-T variable which is wrote from InPort buffer

virtual PortProfile* RTM::InPortBase::profile  )  throw (CORBA::SystemException) [virtual, inherited]
 

[CORBA interface] Get InPort profile

template<class T>
virtual void RTM::InPortAny< T >::put const CORBA::Any &  value  )  throw (RTM::InPort::Disconnected, CORBA::SystemException) [inline, virtual]
 

[CORBA interface] Put data on InPort

Implements RTM::InPortBase.

template<class T>
virtual T RTM::InPortAny< T >::read  )  [inline, virtual]
 

Read into bound T-type data from current InPort.

template<class T>
virtual void RTM::InPortAny< T >::read_pm  )  [inline, virtual]
 

Read into bound T-type data from current InPort.

Implements RTM::InPortBase.


Member Data Documentation

PortProfile RTM::InPortBase::m_Profile [protected, inherited]
 

InPort profile.


The documentation for this class was generated from the following file:
Generated on Wed Apr 6 14:22:24 2005 for OpenRTM by doxygen 1.3.6