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

RTM::OutPortBase Class Reference

Output port base class. More...

#include <RtcOutPortBase.h>

Inheritance diagram for RTM::OutPortBase:

RTM::OutPortAny< T > List of all members.

Public Member Functions

 OutPortBase ()
 A constructor of OutPortBase class.
virtual ~OutPortBase ()
 A destructor of OutPortBase class.
virtual CORBA::Any * get ()=0 throw (CORBA::SystemException)
 [CORBA interface] Get OutPort current value
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 RtmRes push (InPort_ptr inport, std::string subsid)=0
 Push current OutPort value to subscriber.
virtual void updateall ()
 Update current OutPort to to subscriber.
virtual void disconnect_all ()
 Disconnect all subscribers.
virtual const char * name ()
 Get OutPort name.
virtual void write_pm ()=0
 Write into current OutPort from bound T-type data.
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

Classes

struct  Subscribers

Detailed Description

Output port base class.

The base class of OutPort<T> s which are implementations of OutPort This class provides CORBA interface implementation.


Member Typedef Documentation

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

Subscriber list.


Constructor & Destructor Documentation

RTM::OutPortBase::OutPortBase  )  [inline]
 

A constructor of OutPortBase class.

Constructor of OutPortBase.

virtual RTM::OutPortBase::~OutPortBase  )  [inline, virtual]
 

A destructor of OutPortBase class.

Destructor of OutPortBase.


Member Function Documentation

bool RTM::OutPortBase::createSubscriber SubscriptionProfile &  subscription  ) 
 

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

Disconnect all subscribers.

virtual CORBA::Any* RTM::OutPortBase::get  )  throw (CORBA::SystemException) [pure virtual]
 

[CORBA interface] Get OutPort current value

Implemented in RTM::OutPortAny< T >, RTM::OutPortAny< TimedState >, and RTM::OutPortAny< TimedString >.

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

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

Get OutPort name.

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

Subscribe this OutPort.

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

Unsubscribe this OutPort.

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

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

virtual RtmRes RTM::OutPortBase::push InPort_ptr  inport,
std::string  subsid
[pure virtual]
 

Push current OutPort value to subscriber.

Implemented in RTM::OutPortAny< T >, RTM::OutPortAny< TimedState >, and RTM::OutPortAny< TimedString >.

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

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

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

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

[CORBA interface] Get Subscription list

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

Unsubscribe this OutPort.

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

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

Update current OutPort to to subscriber.

virtual void RTM::OutPortBase::write_pm  )  [pure virtual]
 

Write into current OutPort from bound T-type data.

Pure virtual method.

Implemented in RTM::OutPortAny< T >, RTM::OutPortAny< TimedState >, and RTM::OutPortAny< TimedString >.


Member Data Documentation

PortProfile RTM::OutPortBase::m_Profile [protected]
 

OutPort profile.

Subscribers RTM::OutPortBase::m_Subscribers [protected]
 

OutPort_var RTM::OutPortBase::m_thisObjRef [protected]
 

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