CoreDX DDS C Reference Manual
xtypes.h
Go to the documentation of this file.
1 /*****************************************************************
2  *
3  * file: xtypes.h
4  * desc: Provides the CoreDX DDS X-Types Dynamic Type API.
5  *
6  *****************************************************************
7  *
8  * Copyright(C) 2013-2016 Twin Oaks Computing, Inc
9  * All rights reserved. Castle Rock, CO 80108
10  *
11  *****************************************************************
12  *
13  * This software has been provided pursuant to a License Agreement
14  * containing restrictions on its use. This software contains
15  * valuable trade secrets and proprietary information of
16  * Twin Oaks Computing, Inc and is protected by law. It may not be
17  * copied or distributed in any form or medium, disclosed to third
18  * parties, reverse engineered or used in any manner not provided
19  * for in said License Agreement except with the prior written
20  * authorization from Twin Oaks Computing, Inc.
21  *
22  *****************************************************************/
23 #ifndef DDS_XTYPES_H
24 #define DDS_XTYPES_H
25 
26 #include <dds/xtypes_typeobject.h>
27 #include <dds/xtypes_dtype.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif /* __cplusplus */
32 
37  /******************************/
38  /* DDS_DynamicDataReader API */
39  /******************************/
47  typedef DDS_DataReader DDS_DynamicDataReader;
48  DECLARE_SEQ( DDS_DynamicData, DDS_DynamicDataSeq );
49 
54  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read ( DDS_DynamicDataReader dr,
55  DDS_DynamicDataSeq * received_data,
56  DDS_SampleInfoSeq * sample_infos,
57  int max_samples,
58  DDS_SampleStateMask sample_states,
59  DDS_ViewStateMask view_states,
60  DDS_InstanceStateMask instance_states);
61 
66  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take ( DDS_DynamicDataReader dr,
67  DDS_DynamicDataSeq * received_data,
68  DDS_SampleInfoSeq * sample_infos,
69  int max_samples,
70  DDS_SampleStateMask sample_states,
71  DDS_ViewStateMask view_states,
72  DDS_InstanceStateMask instance_states);
77  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_w_condition ( DDS_DynamicDataReader dr,
78  DDS_DynamicDataSeq * received_data,
79  DDS_SampleInfoSeq * sample_infos,
80  int max_samples,
81  DDS_ReadCondition a_condition);
82 
87  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_w_condition ( DDS_DynamicDataReader dr,
88  DDS_DynamicDataSeq * received_data,
89  DDS_SampleInfoSeq * sample_infos,
90  int max_samples,
91  DDS_ReadCondition a_condition);
92 
97  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_sample ( DDS_DynamicDataReader dr,
98  DDS_DynamicData received_data,
99  DDS_SampleInfo * sample_info);
100 
105  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_sample ( DDS_DynamicDataReader dr,
106  DDS_DynamicData received_data,
107  DDS_SampleInfo * sample_info);
108 
113  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_instance ( DDS_DynamicDataReader dr,
114  DDS_DynamicDataSeq * received_data,
115  DDS_SampleInfoSeq * sample_infos,
116  int max_samples,
117  DDS_InstanceHandle_t a_handle,
118  DDS_SampleStateMask sample_states,
119  DDS_ViewStateMask view_states,
120  DDS_InstanceStateMask instance_states);
121 
126  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_instance ( DDS_DynamicDataReader dr,
127  DDS_DynamicDataSeq * received_data,
128  DDS_SampleInfoSeq * sample_infos,
129  int max_samples,
130  DDS_InstanceHandle_t a_handle,
131  DDS_SampleStateMask sample_states,
132  DDS_ViewStateMask view_states,
133  DDS_InstanceStateMask instance_states);
134 
139  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance ( DDS_DynamicDataReader dr,
140  DDS_DynamicDataSeq * received_data,
141  DDS_SampleInfoSeq * sample_infos,
142  int max_samples,
143  DDS_InstanceHandle_t previous_handle,
144  DDS_SampleStateMask sample_states,
145  DDS_ViewStateMask view_states,
146  DDS_InstanceStateMask instance_states);
151  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance ( DDS_DynamicDataReader dr,
152  DDS_DynamicDataSeq * received_data,
153  DDS_SampleInfoSeq * sample_infos,
154  int max_samples,
155  DDS_InstanceHandle_t previous_handle,
156  DDS_SampleStateMask sample_states,
157  DDS_ViewStateMask view_states,
158  DDS_InstanceStateMask instance_states);
159 
164  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance_w_condition( DDS_DynamicDataReader dr,
165  DDS_DynamicDataSeq * received_data,
166  DDS_SampleInfoSeq * sample_infos,
167  int max_samples,
168  DDS_InstanceHandle_t previous_handle,
169  DDS_ReadCondition a_condition);
174  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance_w_condition( DDS_DynamicDataReader dr,
175  DDS_DynamicDataSeq * received_data,
176  DDS_SampleInfoSeq * sample_infos,
177  int max_samples,
178  DDS_InstanceHandle_t previous_handle,
179  DDS_ReadCondition a_condition);
183  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_return_loan ( DDS_DynamicDataReader dr,
184  DDS_DynamicDataSeq * received_data,
185  DDS_SampleInfoSeq * sample_infos);
186 
191  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_get_key_value ( DDS_DynamicDataReader dr,
192  DDS_DynamicData key_holder,
193  DDS_InstanceHandle_t handle);
194 
198  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataReader_lookup_instance ( DDS_DynamicDataReader dr,
199  DDS_DynamicData instance_data);
200 
201 
202  /******************************/
203  /* DDS_DynamicDataWriter API */
204  /******************************/
213  typedef DDS_DataWriter DDS_DynamicDataWriter;
214 
218  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance(DDS_DynamicDataWriter dw,
219  const DDS_DynamicData instance_data);
220 
224  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance_w_timestamp(DDS_DynamicDataWriter dw,
225  const DDS_DynamicData instance_data,
226  const DDS_Time_t source_timestamp);
227 
231  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance(DDS_DynamicDataWriter dw,
232  const DDS_DynamicData instance_data,
233  const DDS_InstanceHandle_t handle);
234 
238  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance_w_timestamp(DDS_DynamicDataWriter dw,
239  const DDS_DynamicData instance_data,
240  const DDS_InstanceHandle_t handle,
241  const DDS_Time_t source_timestamp);
242 
246  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_write(DDS_DynamicDataWriter dw,
247  const DDS_DynamicData instance_data,
248  const DDS_InstanceHandle_t handle);
249 
253  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_write_w_timestamp(DDS_DynamicDataWriter dw,
254  const DDS_DynamicData instance_data,
255  const DDS_InstanceHandle_t handle,
256  const DDS_Time_t source_timestamp);
257 
261  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_dispose(DDS_DynamicDataWriter dw,
262  const DDS_DynamicData instance_data,
263  const DDS_InstanceHandle_t instance_handle);
264 
268  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_dispose_w_timestamp(DDS_DynamicDataWriter dw,
269  const DDS_DynamicData instance_data,
270  const DDS_InstanceHandle_t instance_handle,
271  const DDS_Time_t source_timestamp);
272 
277  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_get_key_value( DDS_DynamicDataWriter dw,
278  DDS_DynamicData key_holder,
279  const DDS_InstanceHandle_t handle);
280 
284  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_lookup_instance(DDS_DynamicDataWriter dw,
285  const DDS_DynamicData instance_data);
286 
287 #ifdef __cplusplus
288 };
289 #endif /* __cplusplus */
290 
291 
292 #endif
DDS_DynamicDataReader::DDS_DynamicDataReader_read_w_condition
DDS_ReturnCode_t DDS_DynamicDataReader_read_w_condition(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_ReadCondition a_condition)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_read_next_instance_w_condition
DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance_w_condition(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_ReadCondition a_condition)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader
Provides a DataReader interface that is tailored to support reading an X-Types defined DynamicType da...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_register_instance
DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data)
This operation registers a DDS_DynamicData data value.
DDS_DynamicDataReader::DDS_DynamicDataReader_return_loan
DDS_ReturnCode_t DDS_DynamicDataReader_return_loan(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos)
This operation returns DDS_DynamicData data values to the DataReader.
DDS_ReadCondition
A DDS_ReadCondition is a specialized DDS_Condition associated with a DDS_DataReader.
DDS_DataReader
The DDS_DataReader entity allows the application to subscribe to and read data.
DDS_DynamicDataReader::DDS_DynamicDataReader_take_next_instance
DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_get_key_value
DDS_ReturnCode_t DDS_DynamicDataWriter_get_key_value(DDS_DynamicDataWriter dw, DDS_DynamicData key_holder, const DDS_InstanceHandle_t handle)
This routine will populate the data structure indicated by key_holder with the key infomation identif...
DDS_ReturnCode_t
int DDS_ReturnCode_t
Definition: dds_types.h:56
DDS_DataWriter
The DDS_DataWriter entity provides an interface for the application to publish (write) data...
DDS_DynamicDataReader::DDS_DynamicDataReader_take_instance
DDS_ReturnCode_t DDS_DynamicDataReader_take_instance(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t a_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_unregister_instance_w_timestamp
DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance_w_timestamp(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t handle, const DDS_Time_t source_timestamp)
This operation unregisters a DDS_DynamicData data value.
DDS_Time_t
Definition: dds_types.h:72
DDS_DynamicDataWriter::DDS_DynamicDataWriter_unregister_instance
DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t handle)
This operation unregisters a DDS_DynamicData data value.
DDS_DynamicDataWriter::DDS_DynamicDataWriter_write_w_timestamp
DDS_ReturnCode_t DDS_DynamicDataWriter_write_w_timestamp(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t handle, const DDS_Time_t source_timestamp)
This operation publishes a DDS_DynamicData data value.
DDS_DynamicDataWriter::DDS_DynamicDataWriter_register_instance_w_timestamp
DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance_w_timestamp(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_Time_t source_timestamp)
This operation registers a DDS_DynamicData data value.
DDS_DynamicDataReader::DDS_DynamicDataReader_take_w_condition
DDS_ReturnCode_t DDS_DynamicDataReader_take_w_condition(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_ReadCondition a_condition)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_get_key_value
DDS_ReturnCode_t DDS_DynamicDataReader_get_key_value(DDS_DynamicDataReader dr, DDS_DynamicData key_holder, DDS_InstanceHandle_t handle)
This routine will populate the data structure indicated by key_holder with the key infomation identif...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_lookup_instance
DDS_InstanceHandle_t DDS_DynamicDataWriter_lookup_instance(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data)
Returns the handle that identifies the data instance provided in instance_data.
DDS_SampleInfo
The SampleInfo structure contains information associated with each sample.
Definition: dds_types.h:159
DDS_DynamicDataReader::DDS_DynamicDataReader_take
DDS_ReturnCode_t DDS_DynamicDataReader_take(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_take_next_sample
DDS_ReturnCode_t DDS_DynamicDataReader_take_next_sample(DDS_DynamicDataReader dr, DDS_DynamicData received_data, DDS_SampleInfo *sample_info)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_dispose
DDS_ReturnCode_t DDS_DynamicDataWriter_dispose(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t instance_handle)
This operation disposes a DDS_DynamicData data value.
DECLARE_SEQ
DECLARE_SEQ(DDS_DynamicTypeMember, DDS_DynamicTypeMemberSeq)
A DDS_DynamicTypeMemberSeq instance is a sequence of DDS_DynamicTypeMember&#39;s.
DDS_DynamicDataReader::DDS_DynamicDataReader_lookup_instance
DDS_InstanceHandle_t DDS_DynamicDataReader_lookup_instance(DDS_DynamicDataReader dr, DDS_DynamicData instance_data)
Returns the handle that identifies the data instance provided in instance_data.
DDS_DynamicDataWriter
Provides a DataWriter interface that is tailored to support writing an X-Types defined DynamicType da...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_write
DDS_ReturnCode_t DDS_DynamicDataWriter_write(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t handle)
This operation publishes a DDS_DynamicData data value.
DDS_InstanceHandle_t
DDS_HANDLE_TYPE_NATIVE DDS_InstanceHandle_t
Definition: dds_types.h:53
DDS_DynamicData
A DDS_DynamicData object represents an individual data sample. It provides reflective getters and set...
DDS_DynamicDataReader::DDS_DynamicDataReader_read_next_sample
DDS_ReturnCode_t DDS_DynamicDataReader_read_next_sample(DDS_DynamicDataReader dr, DDS_DynamicData received_data, DDS_SampleInfo *sample_info)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_read
DDS_ReturnCode_t DDS_DynamicDataReader_read(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataWriter::DDS_DynamicDataWriter_dispose_w_timestamp
DDS_ReturnCode_t DDS_DynamicDataWriter_dispose_w_timestamp(DDS_DynamicDataWriter dw, const DDS_DynamicData instance_data, const DDS_InstanceHandle_t instance_handle, const DDS_Time_t source_timestamp)
This operation disposes a DDS_DynamicData data value.
DDS_DynamicDataReader::DDS_DynamicDataReader_read_next_instance
DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_take_next_instance_w_condition
DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance_w_condition(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_ReadCondition a_condition)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
DDS_DynamicDataReader::DDS_DynamicDataReader_read_instance
DDS_ReturnCode_t DDS_DynamicDataReader_read_instance(DDS_DynamicDataReader dr, DDS_DynamicDataSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t a_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DDS_DynamicData data values (with associated DDS_SampleInfo) within the DataR...
© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.