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

RTM::OutPortAny< T > Class Template Reference

#include <RtcOutPort.h>

Inheritance diagram for RTM::OutPortAny< T >:

RTM::OutPortBase List of all members.

Public Member Functions

 OutPortAny (const char *name, T &value, int bufsize=DEFAULT_BUFFER_SIZE)
 A constructor.
 OutPortAny (const char *name, int bufsize=DEFAULT_BUFFER_SIZE)
 A constructor.
virtual ~OutPortAny ()
 A destructor.
CORBA::Any * get () throw (CORBA::SystemException)
 [CORBA interface] Get current data of OutPort
RtmRes push (InPort_ptr inport, std::string subsid)
 Push current data to subscribers.
virtual void initBuffer (T &value)
 Initialize ring buffer value of OutPort.
virtual void write ()
 Write into current OutPort from bound T-type data.
virtual void write (long sec, long nsec)
virtual void write_pm ()
 Write into current OutPort from bound T-type data.
virtual void write (T value)
 Writing a argument value to OutPort buffer.
virtual void operator<< (T &value)
 Writing a argument value to OutPort buffer.
virtual RtmRes subscribe (SubscriptionProfile &subs) throw (CORBA::SystemException, RTM::PortBase::InvalidSubscription)
 CORBA interface Return type code of port value. Subscribe this OutPort.
virtual RtmRes notify_subscribe (SubscriptionProfile &subs) throw (CORBA::SystemException, RTM::PortBase::InvalidSubscription)
 Subscribe this OutPort.
virtual RtmRes unsubscribe (const char *id) throw (CORBA::SystemException, RTM::PortBase::NoSubscription)
 Unsubscribe this OutPort.
virtual RtmRes notify_unsubscribe (const char *id) throw (CORBA::SystemException, RTM::PortBase::NoSubscription)
 Unsubscribe this OutPort.
virtual PortProfile * profile () throw (CORBA::SystemException)
 Get InPort list of current subscriber [CORBA interface] Get OutPort profile.
virtual SubscriptionList * subscriptions ()
 [CORBA interface] Get Subscription list
bool createSubscriber (SubscriptionProfile &subscription)
virtual void updateall ()
 Update current OutPort to to subscriber.
virtual void disconnect_all ()
 Disconnect all subscribers.
virtual const char * name ()
 Get OutPort name.
virtual OutPort_ptr getObjRef ()
virtual void setObjRef (OutPort_ptr objref)

Protected Types

typedef std::list< SubscriberBase
* >::iterator 
Subs_it
 Subscriber list.

Protected Member Functions

virtual RtmRes unsubscribeNoLocked (const char *id) throw (CORBA::SystemException, RTM::PortBase::NoSubscription)

Protected Attributes

Subscribers m_Subscribers
PortProfile m_Profile
 OutPort profile.
OutPort_var m_thisObjRef
 object reference of OutPort itself

template<class T>
class RTM::OutPortAny< T >


Member Typedef Documentation

typedef std::list<SubscriberBase*>::iterator RTM::OutPortBase::Subs_it [protected, inherited]
 

Subscriber list.


Constructor & Destructor Documentation

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

A constructor.

Setting channel name and registering channel value.

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

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

A constructor.

Setting channel name and registering channel value.

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

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

A destructor.


Member Function Documentation

bool RTM::OutPortBase::createSubscriber SubscriptionProfile &  subscription  )  [inherited]
 

virtual void RTM::OutPortBase::disconnect_all  )  [virtual, inherited]
 

Disconnect all subscribers.

template<class T>
CORBA::Any* RTM::OutPortAny< T >::get  )  throw (CORBA::SystemException) [inline, virtual]
 

[CORBA interface] Get current data of OutPort

Implements RTM::OutPortBase.

virtual OutPort_ptr RTM::OutPortBase::getObjRef  )  [virtual, inherited]
 

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

Initialize ring buffer value of OutPort.

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

Get OutPort name.

virtual RtmRes RTM::OutPortBase::notify_subscribe SubscriptionProfile &  subs  )  throw (CORBA::SystemException, RTM::PortBase::InvalidSubscription) [virtual, inherited]
 

Subscribe this OutPort.

virtual RtmRes RTM::OutPortBase::notify_unsubscribe const char *  id  )  throw (CORBA::SystemException, RTM::PortBase::NoSubscription) [virtual, inherited]
 

Unsubscribe this OutPort.

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

Writing a argument value to OutPort buffer.

Calling this method, argument value "T& value" is transferred to OutPort.

Parameters:
value type-T value write into OutPort buffer

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

Get InPort list of current subscriber [CORBA interface] Get OutPort profile.

template<class T>
RtmRes RTM::OutPortAny< T >::push InPort_ptr  inport,
std::string  subsid
[inline, virtual]
 

Push current data to subscribers.

Implements RTM::OutPortBase.

virtual void RTM::OutPortBase::setObjRef OutPort_ptr  objref  )  [virtual, inherited]
 

virtual RtmRes RTM::OutPortBase::subscribe SubscriptionProfile &  subs  )  throw (CORBA::SystemException, RTM::PortBase::InvalidSubscription) [virtual, inherited]
 

CORBA interface Return type code of port value. Subscribe this OutPort.

virtual SubscriptionList* RTM::OutPortBase::subscriptions  )  [virtual, inherited]
 

[CORBA interface] Get Subscription list

virtual RtmRes RTM::OutPortBase::unsubscribe const char *  id  )  throw (CORBA::SystemException, RTM::PortBase::NoSubscription) [virtual, inherited]
 

Unsubscribe this OutPort.

virtual RtmRes RTM::OutPortBase::unsubscribeNoLocked const char *  id  )  throw (CORBA::SystemException, RTM::PortBase::NoSubscription) [protected, virtual, inherited]
 

virtual void RTM::OutPortBase::updateall  )  [virtual, inherited]
 

Update current OutPort to to subscriber.

template<class T>
virtual void RTM::OutPortAny< T >::write value  )  [inline, virtual]
 

Writing a argument value to OutPort buffer.

Calling this method, argument value "T& value" is transferred to OutPort.

Parameters:
value type-T value write into OutPort buffer

template<class T>
virtual void RTM::OutPortAny< T >::write long  sec,
long  nsec
[inline, virtual]
 

template<class T>
virtual void RTM::OutPortAny< T >::write  )  [inline, virtual]
 

Write into current OutPort from bound T-type data.

template<class T>
virtual void RTM::OutPortAny< T >::write_pm  )  [inline, virtual]
 

Write into current OutPort from bound T-type data.

Implements RTM::OutPortBase.


Member Data Documentation

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

OutPort profile.

Subscribers RTM::OutPortBase::m_Subscribers [protected, inherited]
 

OutPort_var RTM::OutPortBase::m_thisObjRef [protected, inherited]
 

object reference of OutPort itself


The documentation for this class was generated from the following file:
Generated on Sat Oct 28 02:28:17 2006 for OpenRTM by  doxygen 1.4.1