CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE > Class Template Reference

Templated base class for the Getter port. More...

#include <Getter_T.h>

Inheritance diagram for CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >:

[legend]

Collaboration diagram for CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >:

[legend]

List of all members.

Public Member Functions
	Getter_Base_T (void)
	Constructor.
virtual	~Getter_Base_T (void)
	Destructor.
virtual bool	get_many (typename CCM_TYPE::seq_type::_out_type instances,::CCM_DDS::ReadInfoSeq_out infos)
virtual ::DDS::Duration_t	time_out (void)
virtual void	time_out (const ::DDS::Duration_t &time_out)
virtual ::CCM_DDS::DataNumber_t	max_delivered_data (void)
virtual void	max_delivered_data (::CCM_DDS::DataNumber_t max_delivered_data)
void	set_impl (CCM_DDS_DataReader_i *reader)
DDS_ReturnCode_t	passivate (void)
DDS_ReturnCode_t	remove_conditions (void)
Protected Member Functions
void	create_conditions ()
bool	wait (DDSConditionSeq &active_conditions)
DDS_TYPE::data_reader *	impl (void)
Protected Attributes
CCM_DDS_DataReader_i *	reader_
DDSQueryCondition *	condition_
::DDS::Duration_t	time_out_
::CCM_DDS::DataNumber_t	max_delivered_data_
DDSWaitSet *	ws_
DDSReadCondition *	rd_condition_

---

Detailed Description

template<typename DDS_TYPE, typename CCM_TYPE>
class CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >

Templated base class for the Getter port.

Spec: Get operations are performed with the following parameters

• SampleStateMask: NO_READ,
• ViewStateMask: NEW or NOT_NEW,
• InstanceStateMask: ALIVE or NOT_ALIVE,
• Through the query (if any) of the Reader associated to the port,
• Within the time limit specified in time_out.

All methods return a boolean as result indicating whether actual data are provided (TRUE) or if the time-out occurred (FALSE).

---

Constructor & Destructor Documentation

template<typename DDS_TYPE , typename CCM_TYPE >

CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::Getter_Base_T

(

void

)

[inline]

Constructor.

template<typename DDS_TYPE , typename CCM_TYPE >

CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::~Getter_Base_T

(

void

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<typename DDS_TYPE , typename CCM_TYPE >

void CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::create_conditions

(

)

[inline, protected]

template<typename DDS_TYPE , typename CCM_TYPE >

bool CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::get_many	(	typename CCM_TYPE::seq_type::_out_type	instances,
		::CCM_DDS::ReadInfoSeq_out	infos
	)			[inline, virtual]

Spec : get_many returns all the available samples in the limits set by the attribute max_delivered_data. In case there are more available samples, the first max_delivered_data are returned. The default value for that attribute is UNLIMITED (0)

template<typename DDS_TYPE , typename CCM_TYPE >

DDS_TYPE::data_reader * CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::impl

(

void

)

[inline, protected]

template<typename DDS_TYPE , typename CCM_TYPE >

void CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::max_delivered_data

(

::CCM_DDS::DataNumber_t

max_delivered_data

)

[inline, virtual]

template<typename DDS_TYPE , typename CCM_TYPE >

CCM_DDS::DataNumber_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::max_delivered_data

(

void

)

[inline]

template<typename DDS_TYPE , typename CCM_TYPE >

DDS_ReturnCode_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::passivate

(

void

)

[inline]

template<typename DDS_TYPE , typename CCM_TYPE >

DDS_ReturnCode_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::remove_conditions

(

void

)

[inline]

template<typename DDS_TYPE , typename CCM_TYPE >

void CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::set_impl

(

CCM_DDS_DataReader_i *

reader

)

[inline]

Set the actual pointer to DDS Datareader

template<typename DDS_TYPE , typename CCM_TYPE >

void CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::time_out

(

const ::DDS::Duration_t &

time_out

)

[inline, virtual]

template<typename DDS_TYPE , typename CCM_TYPE >

DDS::Duration_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::time_out

(

void

)

[inline]

template<typename DDS_TYPE , typename CCM_TYPE >

bool CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::wait

(

DDSConditionSeq &

active_conditions

)

[inline, protected]

---

Member Data Documentation

template<typename DDS_TYPE , typename CCM_TYPE >

DDSQueryCondition* CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::condition_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE >

::CCM_DDS::DataNumber_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::max_delivered_data_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE >

DDSReadCondition* CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::rd_condition_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE >

CCM_DDS_DataReader_i* CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::reader_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE >

::DDS::Duration_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::time_out_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE >

DDSWaitSet* CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE >::ws_ [protected]

---

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

• Getter_T.h
• Getter_T.cpp