DDS4CCM: CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE > Class Template Reference

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

#include <Getter_T.h>

Inheritance diagram for CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >:

Inheritance graph

Collaboration diagram for CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >:

Collaboration graph

List of all members.

Public Member Functions
	Getter_Base_T (void)
	Constructor.
virtual	~Getter_Base_T (void)
	Destructor.
virtual bool	get_many (SEQ_VALUE_TYPE &instances,::CCM_DDS::ReadInfoSeq &infos)
void	set_dds_reader (::DDS::DataReader_ptr reader,::CIAO::DDS4CCM::ConditionManager *condition_manager)
::DDS::DataReader_ptr	get_dds_reader (void)
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
TYPED_DDS_READER::_ptr_type	dds_reader (void)
get
Generic helper methods which perform the actual DDS reading.
::DDS::ReturnCode_t	get (SEQ_VALUE_TYPE &data,::DDS::SampleInfoSeq &sample_info, const ::CORBA::Long &max_samples)
::DDS::ReturnCode_t	get (SEQ_VALUE_TYPE &data,::DDS::SampleInfoSeq &sample_info, const ::CORBA::Long &max_samples,::DDS::QueryCondition_ptr qc)
::DDS::ReturnCode_t	get (SEQ_VALUE_TYPE &data,::DDS::SampleInfoSeq &sample_info, const ::CORBA::Long &max_samples,::DDS::ReadCondition_ptr rd)
Protected Attributes
TYPED_DDS_READER::_var_type	dds_reader_
::CIAO::DDS4CCM::ConditionManager *	condition_manager_
::DDS::Duration_t	time_out_
::CCM_DDS::DataNumber_t	max_delivered_data_

Detailed Description

template<typename GETTER_TYPE, typename TYPED_DDS_READER, typename VALUE_TYPE, typename SEQ_VALUE_TYPE>
class CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >

Templated base class for the Getter port.

, VALUE_TYPE, SEQ_VALUE_TYPE>

    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 GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::Getter_Base_T ( void )

Constructor.

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::~Getter_Base_T ( void )

virtual

Destructor.

Member Function Documentation

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

TYPED_DDS_READER::_ptr_type CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::dds_reader ( void )

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

DDS::ReturnCode_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::get	(	SEQ_VALUE_TYPE &	data,
		::DDS::SampleInfoSeq &	sample_info,
		const ::CORBA::Long &	max_samples
	)

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

DDS::ReturnCode_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::get	(	SEQ_VALUE_TYPE &	data,
		::DDS::SampleInfoSeq &	sample_info,
		const ::CORBA::Long &	max_samples,
		::DDS::QueryCondition_ptr	qc
	)

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

DDS::ReturnCode_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::get	(	SEQ_VALUE_TYPE &	data,
		::DDS::SampleInfoSeq &	sample_info,
		const ::CORBA::Long &	max_samples,
		::DDS::ReadCondition_ptr	rd
	)

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

DDS::DataReader_ptr CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::get_dds_reader ( void )

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

bool CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::get_many	(	SEQ_VALUE_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 GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

CCM_DDS::DataNumber_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::max_delivered_data ( void )

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

void CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::max_delivered_data ( ::CCM_DDS::DataNumber_t max_delivered_data )

virtual

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

void CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::set_dds_reader	(	::DDS::DataReader_ptr	reader,
		::CIAO::DDS4CCM::ConditionManager *	condition_manager
	)

Set the actual pointer to DDS Datareader

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

DDS::Duration_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::time_out ( void )

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

void CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::time_out ( const ::DDS::Duration_t & time_out )

virtual

Member Data Documentation

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

::CIAO::DDS4CCM::ConditionManager* CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::condition_manager_

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

TYPED_DDS_READER::_var_type CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::dds_reader_

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

::CCM_DDS::DataNumber_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::max_delivered_data_

protected

template<typename GETTER_TYPE , typename TYPED_DDS_READER , typename VALUE_TYPE , typename SEQ_VALUE_TYPE >

::DDS::Duration_t CIAO::DDS4CCM::Getter_Base_T< GETTER_TYPE, TYPED_DDS_READER, VALUE_TYPE, SEQ_VALUE_TYPE >::time_out_

protected

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