CoreDX DDS C Reference Manual
dds_dtype_dr.h
Go to the documentation of this file.
1 /*****************************************************************
2  *
3  * file: dds_dtype_dr.h
4  * desc: This file provides the CoreDX DDS Dynamic Type DataReader.
5  *
6  *****************************************************************
7  *
8  * Copyright(C) 2010-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 COREDX_DYNTYPE_DATAREADER_H
24 #define COREDX_DYNTYPE_DATAREADER_H
25 
26 #include <dds/dds.h>
27 #include <dds/dds_typesupport.h>
28 #include <dds/dds_dtype.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
33 
38  /******************************/
39  /* DynamicType DataReader API */
40  /******************************/
48  typedef DDS_DataReader CDX_DynamicTypeDataReader;
49 
54  COREDX_C_ADD_API DDS_ReturnCode_t CDX_DynamicTypeDataReader_read ( DDS_DataReader dr,
55  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_take ( DDS_DataReader dr,
67  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_read_w_condition ( DDS_DataReader dr,
78  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_take_w_condition ( DDS_DataReader dr,
88  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_read_next_sample ( DDS_DataReader dr,
98  CDX_DynamicType received_data,
99  DDS_SampleInfo * sample_info);
100 
105  COREDX_C_ADD_API DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_next_sample ( DDS_DataReader dr,
106  CDX_DynamicType received_data,
107  DDS_SampleInfo * sample_info);
108 
113  COREDX_C_ADD_API DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_instance ( DDS_DataReader dr,
114  CDX_DynamicTypePtrSeq * 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);
125  COREDX_C_ADD_API DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_instance ( DDS_DataReader dr,
126  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_read_next_instance ( DDS_DataReader dr,
139  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_take_next_instance ( DDS_DataReader dr,
151  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_read_next_instance_w_condition( DDS_DataReader dr,
164  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_take_next_instance_w_condition( DDS_DataReader dr,
174  CDX_DynamicTypePtrSeq * 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 CDX_DynamicTypeDataReader_return_loan ( DDS_DataReader dr,
183  CDX_DynamicTypePtrSeq * received_data,
184  DDS_SampleInfoSeq * sample_infos);
185 
190  COREDX_C_ADD_API DDS_ReturnCode_t CDX_DynamicTypeDataReader_get_key_value ( DDS_DataReader dr,
191  CDX_DynamicType key_holder,
192  DDS_InstanceHandle_t handle);
196  COREDX_C_ADD_API DDS_InstanceHandle_t CDX_DynamicTypeDataReader_lookup_instance ( DDS_DataReader dr,
197  CDX_DynamicType instance_data);
198 
199 #ifdef __cplusplus
200 };
201 #endif /* __cplusplus */
202 
203 
204 #endif
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take_instance
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_instance(DDS_DataReader dr, CDX_DynamicTypePtrSeq *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 DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicType
CDX_DynamicType is an object that enhances CoreDX DDS with the facilities to process dynamic data typ...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_lookup_instance
DDS_InstanceHandle_t CDX_DynamicTypeDataReader_lookup_instance(DDS_DataReader dr, CDX_DynamicType instance_data)
Returns the handle that identifies the data instance provided in instance_data.
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read_next_instance
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_next_instance(DDS_DataReader dr, CDX_DynamicTypePtrSeq *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 DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
DDS_ReadCondition
A DDS_ReadCondition is a specialized DDS_Condition associated with a DDS_DataReader.
CDX_DynamicTypeDataReader
Provides a DataReader interface that is tailored to support reading a DynamicType data type...
DDS_DataReader
The DDS_DataReader entity allows the application to subscribe to and read data.
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take_w_condition
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_w_condition(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_ReadCondition a_condition)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
DDS_ReturnCode_t
int DDS_ReturnCode_t
Definition: dds_types.h:56
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read_w_condition
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_w_condition(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_ReadCondition a_condition)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_return_loan
DDS_ReturnCode_t CDX_DynamicTypeDataReader_return_loan(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos)
This operation returns DynamicType data values to the DataReader.
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read_next_sample
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_next_sample(DDS_DataReader dr, CDX_DynamicType received_data, DDS_SampleInfo *sample_info)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
DDS_SampleInfo
The SampleInfo structure contains information associated with each sample.
Definition: dds_types.h:159
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_get_key_value
DDS_ReturnCode_t CDX_DynamicTypeDataReader_get_key_value(DDS_DataReader dr, CDX_DynamicType key_holder, DDS_InstanceHandle_t handle)
This routine will populate the data structure indicated by key_holder with the key infomation identif...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take_next_instance
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_next_instance(DDS_DataReader dr, CDX_DynamicTypePtrSeq *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 DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
DDS_InstanceHandle_t
DDS_HANDLE_TYPE_NATIVE DDS_InstanceHandle_t
Definition: dds_types.h:53
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take_next_instance_w_condition
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_next_instance_w_condition(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_ReadCondition a_condition)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read_next_instance_w_condition
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_next_instance_w_condition(DDS_DataReader dr, CDX_DynamicTypePtrSeq *received_data, DDS_SampleInfoSeq *sample_infos, int max_samples, DDS_InstanceHandle_t previous_handle, DDS_ReadCondition a_condition)
This operation accesses DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_read_instance
DDS_ReturnCode_t CDX_DynamicTypeDataReader_read_instance(DDS_DataReader dr, CDX_DynamicTypePtrSeq *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 DynamicType data values (with associated DDS_SampleInfo) within the DataReade...
CDX_DynamicTypeDataReader::CDX_DynamicTypeDataReader_take_next_sample
DDS_ReturnCode_t CDX_DynamicTypeDataReader_take_next_sample(DDS_DataReader dr, CDX_DynamicType received_data, DDS_SampleInfo *sample_info)
This operation accessesDynamicType data values (with associated DDS_SampleInfo) within the DataReader...
© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.