CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
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-2020 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 
53  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read ( DDS_DynamicDataReader dr,
54  DDS_DynamicDataSeq * received_data,
55  DDS_SampleInfoSeq * sample_infos,
56  int max_samples,
57  DDS_SampleStateMask sample_states,
58  DDS_ViewStateMask view_states,
59  DDS_InstanceStateMask instance_states);
60 
65  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take ( DDS_DynamicDataReader dr,
66  DDS_DynamicDataSeq * received_data,
67  DDS_SampleInfoSeq * sample_infos,
68  int max_samples,
69  DDS_SampleStateMask sample_states,
70  DDS_ViewStateMask view_states,
71  DDS_InstanceStateMask instance_states);
76  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_w_condition ( DDS_DynamicDataReader dr,
77  DDS_DynamicDataSeq * received_data,
78  DDS_SampleInfoSeq * sample_infos,
79  int max_samples,
80  DDS_ReadCondition a_condition);
81 
86  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_w_condition ( DDS_DynamicDataReader dr,
87  DDS_DynamicDataSeq * received_data,
88  DDS_SampleInfoSeq * sample_infos,
89  int max_samples,
90  DDS_ReadCondition a_condition);
91 
96  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_sample ( DDS_DynamicDataReader dr,
97  DDS_DynamicData received_data,
98  DDS_SampleInfo * sample_info);
99 
104  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_sample ( DDS_DynamicDataReader dr,
105  DDS_DynamicData received_data,
106  DDS_SampleInfo * sample_info);
107 
112  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_instance ( DDS_DynamicDataReader dr,
113  DDS_DynamicDataSeq * received_data,
114  DDS_SampleInfoSeq * sample_infos,
115  int max_samples,
116  DDS_InstanceHandle_t a_handle,
117  DDS_SampleStateMask sample_states,
118  DDS_ViewStateMask view_states,
119  DDS_InstanceStateMask instance_states);
120 
125  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_instance ( DDS_DynamicDataReader dr,
126  DDS_DynamicDataSeq * received_data,
127  DDS_SampleInfoSeq * sample_infos,
128  int max_samples,
129  DDS_InstanceHandle_t a_handle,
130  DDS_SampleStateMask sample_states,
131  DDS_ViewStateMask view_states,
132  DDS_InstanceStateMask instance_states);
133 
138  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance ( DDS_DynamicDataReader dr,
139  DDS_DynamicDataSeq * received_data,
140  DDS_SampleInfoSeq * sample_infos,
141  int max_samples,
142  DDS_InstanceHandle_t previous_handle,
143  DDS_SampleStateMask sample_states,
144  DDS_ViewStateMask view_states,
145  DDS_InstanceStateMask instance_states);
150  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance ( DDS_DynamicDataReader dr,
151  DDS_DynamicDataSeq * received_data,
152  DDS_SampleInfoSeq * sample_infos,
153  int max_samples,
154  DDS_InstanceHandle_t previous_handle,
155  DDS_SampleStateMask sample_states,
156  DDS_ViewStateMask view_states,
157  DDS_InstanceStateMask instance_states);
158 
163  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_read_next_instance_w_condition( DDS_DynamicDataReader dr,
164  DDS_DynamicDataSeq * received_data,
165  DDS_SampleInfoSeq * sample_infos,
166  int max_samples,
167  DDS_InstanceHandle_t previous_handle,
168  DDS_ReadCondition a_condition);
173  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_take_next_instance_w_condition( DDS_DynamicDataReader dr,
174  DDS_DynamicDataSeq * received_data,
175  DDS_SampleInfoSeq * sample_infos,
176  int max_samples,
177  DDS_InstanceHandle_t previous_handle,
178  DDS_ReadCondition a_condition);
182  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_return_loan ( DDS_DynamicDataReader dr,
183  DDS_DynamicDataSeq * received_data,
184  DDS_SampleInfoSeq * sample_infos);
185 
190  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataReader_get_key_value ( DDS_DynamicDataReader dr,
191  DDS_DynamicData key_holder,
192  DDS_InstanceHandle_t handle);
193 
197  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataReader_lookup_instance ( DDS_DynamicDataReader dr,
198  DDS_DynamicData instance_data);
199 
200 
201  /******************************/
202  /* DDS_DynamicDataWriter API */
203  /******************************/
212  typedef DDS_DataWriter DDS_DynamicDataWriter;
213 
217  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance(DDS_DynamicDataWriter dw,
218  const DDS_DynamicData instance_data);
219 
223  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_register_instance_w_timestamp(DDS_DynamicDataWriter dw,
224  const DDS_DynamicData instance_data,
225  const DDS_Time_t source_timestamp);
226 
230  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance(DDS_DynamicDataWriter dw,
231  const DDS_DynamicData instance_data,
232  const DDS_InstanceHandle_t handle);
233 
237  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_unregister_instance_w_timestamp(DDS_DynamicDataWriter dw,
238  const DDS_DynamicData instance_data,
239  const DDS_InstanceHandle_t handle,
240  const DDS_Time_t source_timestamp);
241 
245  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_write(DDS_DynamicDataWriter dw,
246  const DDS_DynamicData instance_data,
247  const DDS_InstanceHandle_t handle);
248 
252  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_write_w_timestamp(DDS_DynamicDataWriter dw,
253  const DDS_DynamicData instance_data,
254  const DDS_InstanceHandle_t handle,
255  const DDS_Time_t source_timestamp);
256 
260  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_dispose(DDS_DynamicDataWriter dw,
261  const DDS_DynamicData instance_data,
262  const DDS_InstanceHandle_t instance_handle);
263 
267  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_dispose_w_timestamp(DDS_DynamicDataWriter dw,
268  const DDS_DynamicData instance_data,
269  const DDS_InstanceHandle_t instance_handle,
270  const DDS_Time_t source_timestamp);
271 
276  COREDX_C_ADD_API DDS_ReturnCode_t DDS_DynamicDataWriter_get_key_value( DDS_DynamicDataWriter dw,
277  DDS_DynamicData key_holder,
278  const DDS_InstanceHandle_t handle);
279 
283  COREDX_C_ADD_API DDS_InstanceHandle_t DDS_DynamicDataWriter_lookup_instance(DDS_DynamicDataWriter dw,
284  const DDS_DynamicData instance_data);
285 
286 #ifdef __cplusplus
287 }
288 #endif /* __cplusplus */
289 
290 
291 #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:160
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.
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-2020 Twin Oaks Computing, Inc
Castle Rock, CO 80104
All rights reserved.