RTI Connext .Net APIs  Version 5.2.0
 All Classes Namespaces Functions Variables Enumerations Properties Groups Pages
DDS::KeyedStringDataReader Class Reference

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

#include <managed_keyedstringSupport.h>

Inheritance diagram for DDS::KeyedStringDataReader:
DDS::TypedDataReader< T > DDS::DataReader DDS::DomainEntity DDS::Entity

Public Member Functions

System::String^ get_key_value (DDS::InstanceHandle_t% handle)
 <<extension>> Retrieve the instance key that corresponds to an instance handle.
 
InstanceHandle_t lookup_instance (System::String^ key)
 <<extension>> Retrieve the instance handle that corresponds to an instance key.
 
- Public Member Functions inherited from DDS::TypedDataReader< T >
void read (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)
 Access a collection of data samples from the DDS::DataReader.
 
void take (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)
 Access a collection of data-samples from the DDS::DataReader.
 
void read_w_condition (DDS::LoanableSequence< T >^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.
 
void take_w_condition (DDS::LoanableSequence< T >^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.
 
void read_next_sample (T received_data, DDS::SampleInfo^ sample_info)
 Copies the next not-previously-accessed data value from the DDS::DataReader.
 
void take_next_sample (T received_data, DDS::SampleInfo^ sample_info)
 Copies the next not-previously-accessed data value from the DDS::DataReader.
 
void read_instance (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)
 Access a collection of data samples from the DDS::DataReader.
 
void take_instance (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)
 Access a collection of data samples from the DDS::DataReader.
 
void read_next_instance (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)
 Access a collection of data samples from the DDS::DataReader.
 
void take_next_instance (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)
 Access a collection of data samples from the DDS::DataReader.
 
void read_next_instance_w_condition (DDS::LoanableSequence< T >^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.
 
void take_next_instance_w_condition (DDS::LoanableSequence< T >^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.
 
void return_loan (DDS::LoanableSequence< T >^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.
 
void get_key_value (T key_holder, DDS::InstanceHandle_t% handle)
 Retrieve the instance key that corresponds to an instance handle.
 
DDS::InstanceHandle_t lookup_instance (T key_holder)
 Retrieves the instance handle that corresponds to an instance key_holder.
 
- Public Member Functions inherited from DDS::DataReader
ReadConditioncreate_readcondition (System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states)
 Creates a DDS::ReadCondition.
 
QueryConditioncreate_querycondition (System::UInt32 sample_states, System::UInt32 view_states, System::UInt32 instance_states, System::String^ query_expression, StringSeq^ query_parameters)
 Creates a DDS::QueryCondition.
 
void delete_readcondition (ReadCondition^ %condition)
 Deletes a DDS::ReadCondition or DDS::QueryCondition attached to the DDS::DataReader.
 
void delete_contained_entities ()
 Deletes all the entities that were created by means of the "create" operations on the DDS::DataReader.
 
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.
 
void acknowledge_sample (SampleInfo^ sample_info, AckResponseData_t^ response_data)
 Acknowledge a single sample explicitly.
 
void acknowledge_sample (SampleInfo^ sample_info)
 Acknowledge a single sample explicitly.
 
void acknowledge_all (AckResponseData_t^ response_data)
 Acknowledge all previously accessed samples.
 
void acknowledge_all ()
 Acknowledge all previously accessed samples.
 
void get_matched_publications (InstanceHandleSeq^ publication_handles)
 Retrieve the list of publications currently "associated" with this DDS::DataReader.
 
void get_matched_publication_data (PublicationBuiltinTopicData^ publication_data, InstanceHandle_t% publication_handle)
 This operation retrieves the information on a publication that is currently "associated" with the DDS::DataReader.
 
void get_matched_publication_participant_data (ParticipantBuiltinTopicData^ participant_data, InstanceHandle_t% publication_handle)
 <<extension>> This operation retrieves the information on the discovered DDS::DomainParticipant associated with the publication that is currently matching with the DDS::DataReader.
 
ITopicDescriptionget_topicdescription ()
 Returns the ::DDS::TopicDescription associated with the DDS::DataReader.
 
Subscriberget_subscriber ()
 Returns the DDS::Subscriber to which the DDS::DataReader belongs.
 
void get_sample_rejected_status (SampleRejectedStatus% status)
 Accesses the ::DDS::StatusKind::SAMPLE_REJECTED_STATUS communication status.
 
void get_liveliness_changed_status (LivelinessChangedStatus% status)
 Accesses the ::DDS::StatusKind::LIVELINESS_CHANGED_STATUS communication status.
 
void get_requested_deadline_missed_status (RequestedDeadlineMissedStatus% status)
 Accesses the ::DDS::StatusKind::REQUESTED_DEADLINE_MISSED_STATUS communication status.
 
void get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus^ status)
 Accesses the ::DDS::StatusKind::REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.
 
void get_sample_lost_status (SampleLostStatus% status)
 Accesses the ::DDS::StatusKind::SAMPLE_LOST_STATUS communication status.
 
void get_subscription_matched_status (SubscriptionMatchedStatus% status)
 Accesses the ::DDS::StatusKind::SUBSCRIPTION_MATCHED_STATUS communication status.
 
virtual void get_datareader_cache_status (DataReaderCacheStatus% status)
 <<extension>> Get the datareader cache status for this reader.
 
virtual void get_datareader_protocol_status (DataReaderProtocolStatus% status)
 <<extension>> Get the datareader protocol status for this reader.
 
virtual void get_matched_publication_datareader_protocol_status (DataReaderProtocolStatus% status, InstanceHandle_t% publication_handle)
 <<extension>> Get the datareader protocol status for this reader, per matched publication identified by the publication_handle.
 
void set_qos (DataReaderQos^ qos)
 Sets the reader QoS.
 
void set_qos_with_profile (System::String^ library_name, System::String^ profile_name)
 <<extension>> Change the QoS of this reader using the input XML QoS profile.
 
void get_qos (DataReaderQos^ qos)
 Gets the reader QoS.
 
void set_listener (DataReaderListener^ l, StatusMask mask)
 Sets the reader listener.
 
DataReaderListenerget_listener ()
 Get the reader listener.
 
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)
 Read data samples, if any are available.
 
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)
 Take data samples, if any are available.
 
template<typename T >
void read_w_condition_untyped (DDS::LoanableSequence< T >^received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
 Read data samples, if any are available.
 
template<typename T >
void take_w_condition_untyped (DDS::LoanableSequence< T >^received_data, DDS::SampleInfoSeq^ info_seq, System::Int32 max_samples, DDS::ReadCondition^ condition)
 Take data samples, if any are available.
 
void read_next_sample_untyped (System::Object^ received_data, DDS::SampleInfo^ sample_info)
 Read data samples, if any are available.
 
void take_next_sample_untyped (System::Object^ received_data, DDS::SampleInfo^ sample_info)
 Take data samples, if any are available.
 
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)
 Read data samples, if any are available.
 
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)
 Take data samples, if any are available.
 
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)
 Read data samples, if any are available.
 
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)
 Take data samples, if any are available.
 
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)
 Read data samples, if any are available.
 
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)
 Take data samples, if any are available.
 
template<typename T >
void return_loan_untyped (DDS::LoanableSequence< T >^received_data, DDS::SampleInfoSeq^ info_seq)
 Return loaned sample data and meta-data.
 
void get_key_value_untyped (System::Object^ key_holder, DDS::InstanceHandle_t% handle)
 Fill in the key fields of the given data sample.
 
DDS::InstanceHandle_t lookup_instance_untyped (System::Object^ key_holder)
 
virtual void enable () override
 Enables the DDS::Entity.
 
virtual StatusConditionget_statuscondition () override
 Allows access to the DDS::StatusCondition associated with the DDS::Entity.
 
virtual StatusMask get_status_changes () override
 Retrieves the list of communication statuses in the DDS::Entity that are triggered.
 
virtual InstanceHandle_t get_instance_handle () override
 Allows access to the DDS::InstanceHandle_t associated with the DDS::Entity.
 

Detailed Description

Member Function Documentation

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
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

RTI Connext .Net APIs Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc