<<interface>> Instantiates DataReader < DDS::KeyedString >. More...

#include <managed_keyedstringSupport.h>

Inheritance diagram for DDS::KeyedStringDataReader:

Public Member Functions
System::String ^	get_key_value (DDS::InstanceHandle_t% handle)
	<<extension>> Retrieve the instance `key` that corresponds to an instance `handle`. More...

InstanceHandle_t	lookup_instance (System::String^ key)
	<<extension>> Retrieve the instance `handle` that corresponds to an instance `key`. More...

Public Member Functions inherited from DDS::TypedDataReader< KeyedString^>
DDS::Ext::LoanedSamples< KeyedString^ > ^	read ()
	Reads all the samples. More...

void	read (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data samples from the DDS::DataReader. More...

DDS::Ext::LoanedSamples< KeyedString^ > ^	take ()
	Takes all the samples. More...

void	take (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data-samples from the DDS::DataReader. More...

DDS::Selector< KeyedString^ > ^	select ()
	Get a Selector to perform data selections, such as per-instance selection or content filtering. More...

void	read_w_condition (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
	Accesses via DDS::TypedDataReader::read the samples that match the criteria specified in the DDS::ReadCondition. More...

void	take_w_condition (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
	Analogous to DDS::TypedDataReader::read_w_condition except it accesses samples via the DDS::TypedDataReader::take operation. More...

void	read_next_sample (KeyedString^ received_data, DDS::SampleInfo^ sample_info)
	Copies the next not-previously-accessed data value from the DDS::DataReader. More...

void	take_next_sample (KeyedString^ received_data, DDS::SampleInfo^ sample_info)
	Copies the next not-previously-accessed data value from the DDS::DataReader. More...

void	read_instance (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% a_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data samples from the DDS::DataReader. More...

void	take_instance (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% a_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data samples from the DDS::DataReader. More...

void	read_next_instance (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data samples from the DDS::DataReader. More...

void	take_next_instance (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Access a collection of data samples from the DDS::DataReader. More...

void	read_next_instance_w_condition (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, DDS::ReadCondition^ condition)
	Accesses via DDS::TypedDataReader::read_next_instance the samples that match the criteria specified in the DDS::ReadCondition. More...

void	take_next_instance_w_condition (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, DDS::ReadCondition^ condition)
	Accesses via DDS::TypedDataReader::take_next_instance the samples that match the criteria specified in the DDS::ReadCondition. More...

void	return_loan (DDS::LoanableSequence< KeyedString^ >^ received_data, DDS::SampleInfoSeq^ info_seq)
	Indicates to the DDS::DataReader that the application is done accessing the collection of `received_data` and `info_seq` obtained by some earlier invocation of read or take on the DDS::DataReader. More...

void	get_key_value (KeyedString^ key_holder, DDS::InstanceHandle_t% handle)
	Retrieve the instance `key` that corresponds to an instance `handle`. More...

DDS::InstanceHandle_t	lookup_instance (KeyedString^ key_holder)
	Retrieves the instance `handle` that corresponds to an instance `key_holder`. More...

Public Member Functions inherited from DDS::DataReader
ReadCondition ^	create_readcondition (System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Creates a DDS::ReadCondition. More...

ReadCondition ^	create_readcondition_w_params (ReadConditionParams ^ params)
	<<extension>> Creates a DDS::ReadCondition with parameters. More...

QueryCondition ^	create_querycondition (System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states, System::String^ query_expression, StringSeq^ query_parameters)
	Creates a DDS::QueryCondition. More...

QueryCondition ^	create_querycondition_w_params (QueryConditionParams ^ params)
	<<extension>> Creates a DDS::QueryCondition with parameters. More...

void	delete_readcondition (ReadCondition^% condition)
	Deletes a DDS::ReadCondition or DDS::QueryCondition attached to the DDS::DataReader. More...

void	delete_contained_entities ()
	Deletes all the entities that were created by means of the "create" operations on the DDS::DataReader. More...

void	wait_for_historical_data (Duration_t% max_wait)
	Waits until all "historical" data is received for DDS::DataReader entities that have a non-VOLATILE Durability Qos kind. More...

void	acknowledge_sample (SampleInfo ^ sample_info, AckResponseData_t ^ response_data)
	<<extension>> Acknowledges a single sample explicitly. More...

void	acknowledge_sample (SampleInfo ^ sample_info)
	<<extension>> Acknowledges a single sample explicitly. More...

void	acknowledge_all (AckResponseData_t ^ response_data)
	<<extension>> Acknowledges all previously accessed samples. More...

void	acknowledge_all ()
	<<extension>> Acknowledges all previously accessed samples. More...

void	get_matched_publications (InstanceHandleSeq^ publication_handles)
	Retrieves the list of publications currently "associated" with this DDS::DataReader. More...

void	get_matched_publication_data (PublicationBuiltinTopicData^ publication_data, InstanceHandle_t% publication_handle)
	Retrieves the information on a publication that is currently "associated" with the DDS::DataReader. More...

bool	is_matched_publication_alive (InstanceHandle_t% publication_handle)
	Check if a publication currently matched with a DataReader is alive. More...

void	get_matched_publication_participant_data (ParticipantBuiltinTopicData^ participant_data, InstanceHandle_t% publication_handle)
	<<extension>> Retrieves the information on the discovered DDS::DomainParticipant associated with the publication that is currently matching with the DDS::DataReader. More...

ITopicDescription ^	get_topicdescription ()
	Returns the ITopicDescription associated with the DDS::DataReader. More...

Subscriber ^	get_subscriber ()
	Returns the DDS::Subscriber to which the DDS::DataReader belongs. More...

void	get_sample_rejected_status (SampleRejectedStatus% status)
	Accesses the SAMPLE_REJECTED_STATUS communication status. More...

void	get_liveliness_changed_status (LivelinessChangedStatus% status)
	Accesses the LIVELINESS_CHANGED_STATUS communication status. More...

void	get_requested_deadline_missed_status (RequestedDeadlineMissedStatus% status)
	Accesses the REQUESTED_DEADLINE_MISSED_STATUS communication status. More...

void	get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus^ status)
	Accesses the REQUESTED_INCOMPATIBLE_QOS_STATUS communication status. More...

void	get_sample_lost_status (SampleLostStatus% status)
	Accesses the SAMPLE_LOST_STATUS communication status. More...

void	get_subscription_matched_status (SubscriptionMatchedStatus% status)
	Accesses the SUBSCRIPTION_MATCHED_STATUS communication status. More...

virtual void	get_datareader_cache_status (DataReaderCacheStatus% status)
	<<extension>> Gets the datareader cache status for this reader. More...

virtual void	get_datareader_protocol_status (DataReaderProtocolStatus% status)
	<<extension>> Gets the datareader protocol status for this reader. More...

virtual void	get_matched_publication_datareader_protocol_status (DataReaderProtocolStatus% status, InstanceHandle_t% publication_handle)
	<<extension>> Gets the datareader protocol status for this reader, per matched publication identified by the publication_handle. More...

void	set_qos (DataReaderQos^ qos)
	Sets the reader QoS. More...

void	set_qos_with_profile (System::String^ library_name, System::String^ profile_name)
	<<extension>> Changes the QoS of this reader using the input XML QoS profile. More...

void	get_qos (DataReaderQos^ qos)
	Gets the reader QoS. More...

void	set_listener (DataReaderListener^ l, StatusMask mask)
	Sets the reader listener. More...

DataReaderListener ^	get_listener ()
	Gets the reader listener. More...

TopicQuery ^	create_topic_query (TopicQuerySelection^ selection)
	Creates a DDS::TopicQuery. More...

void	delete_topic_query (TopicQuery^% query)
	Deletes a DDS::TopicQuery. More...

TopicQuery ^	lookup_topic_query (GUID_t% guid)
	Retrieves an existing DDS::TopicQuery. More...

template<typename T >
void	read_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Reads data samples, if any are available. More...

template<typename T >
void	take_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Takes data samples, if any are available. More...

template<typename T >
void	read_w_condition_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
	Reads data samples, if any are available. More...

template<typename T >
void	take_w_condition_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
	Takes data samples, if any are available. More...

void	read_next_sample_untyped (System::Object^ received_data, DDS::SampleInfo^ sample_info)
	Reads data samples, if any are available. More...

void	take_next_sample_untyped (System::Object^ received_data, DDS::SampleInfo^ sample_info)
	Takes data samples, if any are available. More...

template<typename T >
void	read_instance_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% a_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Reads data samples, if any are available. More...

template<typename T >
void	take_instance_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% a_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Takes data samples, if any are available. More...

template<typename T >
void	read_next_instance_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Reads data samples, if any are available. More...

template<typename T >
void	take_next_instance_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
	Takes data samples, if any are available. More...

template<typename T >
void	read_next_instance_w_condition_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, DDS::ReadCondition^ condition)
	Reads data samples, if any are available. More...

template<typename T >
void	take_next_instance_w_condition_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::InstanceHandle_t% previous_handle, DDS::ReadCondition^ condition)
	Takes data samples, if any are available. More...

template<typename T >
void	return_loan_untyped (DDS::LoanableSequence< T >^ received_data, DDS::SampleInfoSeq^ info_seq)
	Returns loaned sample data and meta-data. More...

void	get_key_value_untyped (System::Object^ key_holder, DDS::InstanceHandle_t% handle)
	Fills in the key fields of the given data sample. More...

DDS::InstanceHandle_t	lookup_instance_untyped (System::Object^ key_holder)

virtual void	enable () override
	Enables the DDS::Entity. More...

virtual StatusCondition ^	get_statuscondition () override
	Allows access to the DDS::StatusCondition associated with the DDS::Entity. More...

virtual StatusMask	get_status_changes () override
	Retrieves the list of communication statuses in the DDS::Entity that are triggered. More...

virtual InstanceHandle_t	get_instance_handle () override
	Allows access to the DDS::InstanceHandle_t associated with the DDS::Entity. More...

Additional Inherited Members
Properties inherited from DDS::DataReader
static TopicQuerySelection^	TOPIC_QUERY_SELECTION_USE_READER_CONTENT_FILTER `[get]`
	Special value for creating a DDS::TopicQuery that applies the same filter as the DataReader's DDS::ContentFilteredTopic. More...

static TopicQuerySelection^	TOPIC_QUERY_SELECTION_SELECT_ALL `[get]`
	Special value for creating a DDS::TopicQuery that selects all the samples in a DDS::DataWriter cache. More...

Detailed Description

<<interface>> Instantiates DataReader < DDS::KeyedString >.

See also: DDS::TypedDataReader; DDS::DataReader

Member Function Documentation

◆ get_key_value()

System::String ^ DDS::KeyedStringDataReader::get_key_value ( DDS::InstanceHandle_t% handle )

inline

<<extension>> Retrieve the instance key that corresponds to an instance handle.

See also: DDS::TypedDataReader::get_key_value

◆ lookup_instance()

InstanceHandle_t DDS::KeyedStringDataReader::lookup_instance ( System::String^ key )

inline

<<extension>> Retrieve the instance handle that corresponds to an instance key.

See also: DDS::TypedDataReader::lookup_instance

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_key_value()

◆ lookup_instance()