CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_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, VENDOR_TYPE >:

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

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 &instances,::CCM_DDS::ReadInfoSeq &infos)
void	set_impl (DataReader_type *reader, ConditionManager_type *condition_manager)
time_out
Accessors for time_out
virtual ::DDS::Duration_t	time_out (void)
virtual void	time_out (const ::DDS::Duration_t &time_out)
max_delivered_data
Accessors for max_delivered_data
virtual ::CCM_DDS::DataNumber_t	max_delivered_data (void)
virtual void	max_delivered_data (::CCM_DDS::DataNumber_t max_delivered_data)
Protected Member Functions
DataReader_type *	impl (void)
::DDS::ReturnCode_t	get (typename DDS_TYPE::dds_seq_type &data, typename DDS_TYPE::sampleinfo_seq_type &sample_info, const DDS_Long &max_samples)
Protected Attributes
DataReader_type *	reader_
ConditionManager_type *	condition_manager_
::DDS_Duration_t	time_out_
::CCM_DDS::DataNumber_t	max_delivered_data_
Private Types
typedef CIAO::DDS4CCM::CCM_DDS_ReadCondition_T < DDS_TYPE, CCM_TYPE, VENDOR_TYPE >	ReadCondition_type
typedef CIAO::DDS4CCM::DataReader_T < DDS_TYPE, CCM_TYPE, VENDOR_TYPE >	DataReader_type
typedef CIAO::DDS4CCM::ConditionManager_T < DDS_TYPE, CCM_TYPE, VENDOR_TYPE >	ConditionManager_type

---

Detailed Description

template<typename DDS_TYPE, typename CCM_TYPE, DDS4CCM_Vendor VENDOR_TYPE>
class CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_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).

---

Member Typedef Documentation

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

typedef CIAO::DDS4CCM::ConditionManager_T<DDS_TYPE, CCM_TYPE, VENDOR_TYPE> CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::ConditionManager_type [private]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

typedef CIAO::DDS4CCM::DataReader_T<DDS_TYPE, CCM_TYPE, VENDOR_TYPE> CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::DataReader_type [private]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

typedef CIAO::DDS4CCM::CCM_DDS_ReadCondition_T<DDS_TYPE, CCM_TYPE, VENDOR_TYPE> CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::ReadCondition_type [private]

---

Constructor & Destructor Documentation

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

void

)

Constructor.

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

DDS::ReturnCode_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::get	(	typename DDS_TYPE::dds_seq_type &	data,
		typename DDS_TYPE::sampleinfo_seq_type &	sample_info,
		const DDS_Long &	max_samples
	)		[protected]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

bool CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::get_many	(	typename CCM_TYPE::seq_type &	instances,
		::CCM_DDS::ReadInfoSeq &	infos
	)		[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 , DDS4CCM_Vendor VENDOR_TYPE>

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

(

void

)

[protected]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

void

)

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

::CCM_DDS::DataNumber_t

max_delivered_data )

[virtual]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

void CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::set_impl	(	DataReader_type *	reader,
		ConditionManager_type *	condition_manager
	)

Set the actual pointer to DDS Datareader

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

void

)

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

(

const ::DDS::Duration_t &

time_out )

[virtual]

---

Member Data Documentation

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

ConditionManager_type* CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::condition_manager_ [protected]

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

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

template<typename DDS_TYPE , typename CCM_TYPE , DDS4CCM_Vendor VENDOR_TYPE>

::DDS_Duration_t CIAO::DDS4CCM::DDS_CCM::Getter_Base_T< DDS_TYPE, CCM_TYPE, VENDOR_TYPE >::time_out_ [protected]

---

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

• Getter_T.h
• Getter_T.cpp