OpenDDS  Snapshot(2023/04/28-20:55)
Typedefs | Functions | Variables
IDLTemplate.txt File Reference

Typedefs

typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> TypeSupport
 
typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> out string encoded
 
typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> out string in OpenDDS::DCPS::RepresentationFormat format
 

Functions

::DDS::ReturnCode_t encode_to_bytes (in<%SCOPED%> sample, out ::DDS::OctetSeq encoded, in OpenDDS::DCPS::RepresentationFormat format)
 
::DDS::ReturnCode_t decode_from_string (in string encoded, out<%SCOPED%> sample, in OpenDDS::DCPS::RepresentationFormat format)
 
::DDS::ReturnCode_t decode_from_bytes (in ::DDS::OctetSeq encoded, out<%SCOPED%> sample, in OpenDDS::DCPS::RepresentationFormat format)
 
::DDS::InstanceHandle_t register_instance_w_timestamp (in<%SCOPED%> instance, in ::DDS::Time_t timestamp)
 
::DDS::ReturnCode_t unregister_instance (in<%SCOPED%> instance, in ::DDS::InstanceHandle_t handle)
 
::DDS::ReturnCode_t unregister_instance_w_timestamp (in<%SCOPED%> instance, in ::DDS::InstanceHandle_t handle, in ::DDS::Time_t timestamp)
 
::DDS::ReturnCode_t write (in<%SCOPED%> instance_data, in ::DDS::InstanceHandle_t handle)
 
::DDS::ReturnCode_t write_w_timestamp (in<%SCOPED%> instance_data, in ::DDS::InstanceHandle_t handle, in ::DDS::Time_t source_timestamp)
 
::DDS::ReturnCode_t dispose (in<%SCOPED%> instance_data, in ::DDS::InstanceHandle_t instance_handle)
 
::DDS::ReturnCode_t dispose_w_timestamp (in<%SCOPED%> instance_data, in ::DDS::InstanceHandle_t instance_handle, in ::DDS::Time_t source_timestamp)
 
::DDS::ReturnCode_t get_key_value (inout<%SCOPED%> key_holder, in ::DDS::InstanceHandle_t handle)
 
::DDS::InstanceHandle_t lookup_instance (in<%SCOPED%> instance_data)
 
::DDS::ReturnCode_t take (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq, in long max_samples, in ::DDS::SampleStateMask sample_states, in ::DDS::ViewStateMask view_states, in ::DDS::InstanceStateMask instance_states)
 
::DDS::ReturnCode_t read_w_condition (inout<%TYPE%><%SEQ%> data_values, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t take_w_condition (inout<%TYPE%><%SEQ%> data_values, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t read_next_sample (inout<%SCOPED%> received_data, inout ::DDS::SampleInfo sample_info)
 
::DDS::ReturnCode_t take_next_sample (inout<%SCOPED%> received_data, inout ::DDS::SampleInfo sample_info)
 
::DDS::ReturnCode_t read_instance (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::SampleStateMask sample_states, in ::DDS::ViewStateMask view_states, in ::DDS::InstanceStateMask instance_states)
 
::DDS::ReturnCode_t take_instance (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::SampleStateMask sample_states, in ::DDS::ViewStateMask view_states, in ::DDS::InstanceStateMask instance_states)
 
::DDS::ReturnCode_t read_instance_w_condition (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t take_instance_w_condition (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t read_next_instance (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::SampleStateMask sample_states, in ::DDS::ViewStateMask view_states, in ::DDS::InstanceStateMask instance_states)
 
::DDS::ReturnCode_t take_next_instance (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq, in long max_samples, in ::DDS::InstanceHandle_t a_handle, in ::DDS::SampleStateMask sample_states, in ::DDS::ViewStateMask view_states, in ::DDS::InstanceStateMask instance_states)
 
::DDS::ReturnCode_t read_next_instance_w_condition (inout<%TYPE%><%SEQ%> data_values, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::InstanceHandle_t previous_handle, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t take_next_instance_w_condition (inout<%TYPE%><%SEQ%> data_values, inout ::DDS::SampleInfoSeq sample_infos, in long max_samples, in ::DDS::InstanceHandle_t previous_handle, in ::DDS::ReadCondition a_condition)
 
::DDS::ReturnCode_t return_loan (inout<%TYPE%><%SEQ%> received_data, inout ::DDS::SampleInfoSeq info_seq)
 

Variables

local interface<%TYPE%> DataWriter
 
local interface<%TYPE%> DataReader
 
local interface<%TYPE%> inout ::DDS::SampleInfoSeq info_seq
 
local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long max_samples
 
local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask sample_states
 
local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask in ::DDS::ViewStateMask view_states
 
local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask in ::DDS::ViewStateMask in ::DDS::InstanceStateMask instance_states
 

Typedef Documentation

◆ encoded

typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> out string encoded

Definition at line 4 of file IDLTemplate.txt.

◆ format

typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> out string in OpenDDS::DCPS::RepresentationFormat format

Definition at line 4 of file IDLTemplate.txt.

◆ TypeSupport

typedef sequence<<%SCOPED%><%TYPE%><%SEQ%> local interface<%TYPE%> TypeSupport

Support topic registration for <TYPE%> data type.

See the DDS specification, OMG formal/2015-04-10, for a description of this interface.

Definition at line 4 of file IDLTemplate.txt.

Function Documentation

◆ decode_from_bytes()

::DDS::ReturnCode_t decode_from_bytes ( in ::DDS::OctetSeq  encoded,
out<%SCOPED%>  sample,
in OpenDDS::DCPS::RepresentationFormat  format 
)

◆ decode_from_string()

::DDS::ReturnCode_t decode_from_string ( in string  encoded,
out<%SCOPED%>  sample,
in OpenDDS::DCPS::RepresentationFormat  format 
)

◆ dispose()

::DDS::ReturnCode_t dispose ( in<%SCOPED%>  instance_data,
in ::DDS::InstanceHandle_t  instance_handle 
)

Referenced by OpenDDS::DCPS::DataWriterImpl::data_allocator().

◆ dispose_w_timestamp()

::DDS::ReturnCode_t dispose_w_timestamp ( in<%SCOPED%>  instance_data,
in ::DDS::InstanceHandle_t  instance_handle,
in ::DDS::Time_t  source_timestamp 
)

Referenced by OpenDDS::XTypes::DynamicDataWriterImpl::dispose(), OpenDDS::DCPS::DataWriterImpl_T< MessageType >::dispose(), and OpenDDS::DCPS::DataWriterImpl::get_value_dispatcher().

◆ encode_to_bytes()

::DDS::ReturnCode_t encode_to_bytes ( in<%SCOPED%>  sample,
out ::DDS::OctetSeq  encoded,
in OpenDDS::DCPS::RepresentationFormat  format 
)

◆ get_key_value()

DDS::ReturnCode_t get_key_value ( inout<%SCOPED%>  key_holder,
in ::DDS::InstanceHandle_t  handle 
)

Referenced by OpenDDS::XTypes::DynamicDataReaderImpl::get_key_value(), OpenDDS::DCPS::DataWriterImpl::get_value_dispatcher(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::marshal(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i().

◆ lookup_instance()

DDS::InstanceHandle_t lookup_instance ( in<%SCOPED%>  instance_data)

Referenced by OpenDDS::DCPS::DataWriterImpl::get_value_dispatcher(), OpenDDS::XTypes::DynamicDataReaderImpl::lookup_instance(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance_generic(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::marshal(), OpenDDS::DCPS::DataReaderImpl::ownership_manager(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data().

◆ read_instance()

::DDS::ReturnCode_t read_instance ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::SampleStateMask  sample_states,
in ::DDS::ViewStateMask  view_states,
in ::DDS::InstanceStateMask  instance_states 
)

◆ read_instance_w_condition()

::DDS::ReturnCode_t read_instance_w_condition ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::ReadCondition  a_condition 
)

◆ read_next_instance()

::DDS::ReturnCode_t read_next_instance ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::SampleStateMask  sample_states,
in ::DDS::ViewStateMask  view_states,
in ::DDS::InstanceStateMask  instance_states 
)

◆ read_next_instance_w_condition()

::DDS::ReturnCode_t read_next_instance_w_condition ( inout<%TYPE%><%SEQ%>  data_values,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::InstanceHandle_t  previous_handle,
in ::DDS::ReadCondition  a_condition 
)

◆ read_next_sample()

::DDS::ReturnCode_t read_next_sample ( inout<%SCOPED%>  received_data,
inout ::DDS::SampleInfo  sample_info 
)

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::marshal(), and OpenDDS::XTypes::DynamicDataReaderImpl::read_next_sample().

◆ read_w_condition()

::DDS::ReturnCode_t read_w_condition ( inout<%TYPE%><%SEQ%>  data_values,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::ReadCondition  a_condition 
)

◆ register_instance_w_timestamp()

::DDS::InstanceHandle_t register_instance_w_timestamp ( in<%SCOPED%>  instance,
in ::DDS::Time_t  timestamp 
)

Referenced by OpenDDS::DCPS::DataWriterImpl::get_value_dispatcher(), OpenDDS::XTypes::DynamicDataWriterImpl::register_instance(), and OpenDDS::DCPS::DataWriterImpl_T< MessageType >::register_instance().

◆ return_loan()

::DDS::ReturnCode_t return_loan ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq 
)

◆ take()

::DDS::ReturnCode_t take ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq,
in long  max_samples,
in ::DDS::SampleStateMask  sample_states,
in ::DDS::ViewStateMask  view_states,
in ::DDS::InstanceStateMask  instance_states 
)

◆ take_instance()

::DDS::ReturnCode_t take_instance ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::SampleStateMask  sample_states,
in ::DDS::ViewStateMask  view_states,
in ::DDS::InstanceStateMask  instance_states 
)

◆ take_instance_w_condition()

::DDS::ReturnCode_t take_instance_w_condition ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::ReadCondition  a_condition 
)

◆ take_next_instance()

::DDS::ReturnCode_t take_next_instance ( inout<%TYPE%><%SEQ%>  received_data,
inout ::DDS::SampleInfoSeq  info_seq,
in long  max_samples,
in ::DDS::InstanceHandle_t  a_handle,
in ::DDS::SampleStateMask  sample_states,
in ::DDS::ViewStateMask  view_states,
in ::DDS::InstanceStateMask  instance_states 
)

◆ take_next_instance_w_condition()

::DDS::ReturnCode_t take_next_instance_w_condition ( inout<%TYPE%><%SEQ%>  data_values,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::InstanceHandle_t  previous_handle,
in ::DDS::ReadCondition  a_condition 
)

◆ take_next_sample()

::DDS::ReturnCode_t take_next_sample ( inout<%SCOPED%>  received_data,
inout ::DDS::SampleInfo  sample_info 
)

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::marshal(), and OpenDDS::XTypes::DynamicDataReaderImpl::take_next_sample().

◆ take_w_condition()

::DDS::ReturnCode_t take_w_condition ( inout<%TYPE%><%SEQ%>  data_values,
inout ::DDS::SampleInfoSeq  sample_infos,
in long  max_samples,
in ::DDS::ReadCondition  a_condition 
)

◆ unregister_instance()

::DDS::ReturnCode_t unregister_instance ( in<%SCOPED%>  instance,
in ::DDS::InstanceHandle_t  handle 
)

◆ unregister_instance_w_timestamp()

::DDS::ReturnCode_t unregister_instance_w_timestamp ( in<%SCOPED%>  instance,
in ::DDS::InstanceHandle_t  handle,
in ::DDS::Time_t  timestamp 
)

Referenced by OpenDDS::DCPS::DataWriterImpl::get_value_dispatcher(), OpenDDS::XTypes::DynamicDataWriterImpl::unregister_instance(), and OpenDDS::DCPS::DataWriterImpl_T< MessageType >::unregister_instance().

◆ write()

::DDS::ReturnCode_t write ( in<%SCOPED%>  instance_data,
in ::DDS::InstanceHandle_t  handle 
)

Referenced by OpenDDS::DCPS::DataWriterImpl::data_allocator(), value_writer_generator::gen_enum(), value_writer_generator::gen_struct(), value_writer_generator::gen_union(), OpenDDS::DCPS::ReplayerImpl::participant(), OpenDDS::DCPS::RtpsSampleHeader::populate_inline_qos(), OpenDDS::DCPS::RtpsSampleHeader::split(), and OpenDDS::DCPS::ValueDispatcher::~ValueDispatcher().

◆ write_w_timestamp()

::DDS::ReturnCode_t write_w_timestamp ( in<%SCOPED%>  instance_data,
in ::DDS::InstanceHandle_t  handle,
in ::DDS::Time_t  source_timestamp 
)

Referenced by OpenDDS::DCPS::DataWriterImpl::get_type_support(), OpenDDS::XTypes::DynamicDataWriterImpl::write(), and OpenDDS::DCPS::DataWriterImpl_T< MessageType >::write().

Variable Documentation

◆ DataReader

local interface<%TYPE%> DataReader

DataReader interface for <TYPE%> data type.

See the DDS specification, OMG formal/2015-04-10, for a description of this interface.

Definition at line 72 of file IDLTemplate.txt.

◆ DataWriter

local interface<%TYPE%> DataWriter

DataWriter interface for <TYPE%> data type.

See the DDS specifications, OMG formal/2015-04-10 and formal/07-01-01, for a description of this interface.

Definition at line 18 of file IDLTemplate.txt.

Referenced by OpenDDS::FaceTSS::send_message().

◆ info_seq

local interface<%TYPE%> inout ::DDS::SampleInfoSeq info_seq

Definition at line 72 of file IDLTemplate.txt.

Referenced by OpenDDS::DCPS::MultiTopicDataReader_T< Sample, TypedDataReader >::MultiTopicDataReader_T().

◆ instance_states

local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask in ::DDS::ViewStateMask in ::DDS::InstanceStateMask instance_states

Definition at line 72 of file IDLTemplate.txt.

Referenced by OpenDDS::DCPS::MultiTopicDataReader_T< Sample, TypedDataReader >::MultiTopicDataReader_T(), OpenDDS::DCPS::MultiTopicDataReaderBase::MultiTopicDataReaderBase(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_instance_i(), OpenDDS::DCPS::DataReaderImpl::set_instance_state(), and OpenDDS::DCPS::DataReaderImpl::update_lookup_maps().

◆ max_samples

local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long max_samples

Definition at line 72 of file IDLTemplate.txt.

Referenced by OpenDDS::DCPS::Qos_Helper::consistent(), OpenDDS::DCPS::MultiTopicDataReader_T< Sample, TypedDataReader >::MultiTopicDataReader_T(), dds::operator!=(), OpenDDS::DCPS::InternalDataReader< T >::Instance::read(), QOS_DwDrTp_Base_T< XML_QOS_TYPE, DDS_QOS_TYPE >::read_qos(), QOS_DwTp_Base_T< XML_QOS_TYPE, DDS_QOS_TYPE >::read_qos(), and OpenDDS::DCPS::InternalDataReader< T >::Instance::take().

◆ sample_states

local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask sample_states

Definition at line 72 of file IDLTemplate.txt.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::matches(), OpenDDS::DCPS::MultiTopicDataReader_T< Sample, TypedDataReader >::MultiTopicDataReader_T(), OpenDDS::DCPS::MultiTopicDataReaderBase::MultiTopicDataReaderBase(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_next_sample(), OpenDDS::DCPS::DataReaderImpl::set_instance_state(), OpenDDS::DCPS::ReceivedDataElementList::size(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_next_sample(), and OpenDDS::DCPS::DataReaderImpl::update_lookup_maps().

◆ view_states

local interface<%TYPE%> inout ::DDS::SampleInfoSeq in long in ::DDS::SampleStateMask in ::DDS::ViewStateMask view_states

Definition at line 72 of file IDLTemplate.txt.

Referenced by OpenDDS::DCPS::MultiTopicDataReader_T< Sample, TypedDataReader >::MultiTopicDataReader_T(), OpenDDS::DCPS::MultiTopicDataReaderBase::MultiTopicDataReaderBase(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_instance_i(), OpenDDS::DCPS::DataReaderImpl::set_instance_state(), and OpenDDS::DCPS::DataReaderImpl::update_lookup_maps().

Generated by   doxygen 1.8.13