Documentation to serialize DynamicData to JSON (#844)

* Documentation to serialize DynamicData to JSON

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Change section name and set JSON to not filled DynamicData

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Add Supported Types Serialization section and add more verbosity

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Add json_serialize API, references and change example

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Apply suggested changes

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Fix spelling errors

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Remove unnecessary idl

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Apply suggested changes

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Add bitset section

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Apply minor change

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

* Add missing blank space in file

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

---------

Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>

code/DDSCodeTester.cpp

@@ -37,6 +37,7 @@
 #include <fastdds/dds/xtypes/dynamic_types/DynamicTypeBuilder.hpp>
 #include <fastdds/dds/xtypes/dynamic_types/DynamicTypeBuilderFactory.hpp>
 #include <fastdds/dds/xtypes/type_representation/TypeObject.hpp>
+#include <fastdds/dds/xtypes/utils.hpp>
 #include <fastdds/rtps/attributes/ThreadSettings.hpp>
 #include <fastdds/rtps/common/WriteParams.hpp>
 #include <fastdds/rtps/history/IPayloadPool.hpp>
@@ -1156,6 +1157,36 @@ class RemoteDiscoveryDomainParticipantListener : public DomainParticipantListene
 };
 //!--
 
+//!--REMOTE_TYPE_INTROSPECTION
+class TypeIntrospectionSubscriber : public DomainParticipantListener
+{
+ //!--DYNDATA_JSON_SERIALIZATION
+ void on_data_available(
+ DataReader* reader)
+ {
+ // Dynamic DataType
+ DynamicData::_ref_type new_data =
+ DynamicDataFactory::get_instance()->create_data(dyn_type_);
+
+ SampleInfo info;
+
+ while ((RETCODE_OK == reader->take_next_sample(&new_data, &info)))
+ {
+ std::stringstream output;
+ output << std::setw(4);
+
+ // Serialize DynamicData into JSON string format
+ json_serialize(new_data, DynamicDataJsonFormat::EPROSIMA, output);
+ std::cout << "Message received:\n" << output.str() << std::endl;
+ }
+ }
+
+ // DynamicType created in discovery callback
+ DynamicType::_ref_type dyn_type_;
+ //!--
+};
+//!--
+
 void dds_discovery_examples()
 {
  using Locator_t = eprosima::fastdds::rtps::Locator_t;

code/DynamicTypesIDLExamples.idl

@@ -122,6 +122,13 @@ struct ArrayStruct
 };
 //!--
 
+//!--IDL_ARRAYS_JSON
+struct ArrayStruct
+{
+ long long_array[2][3];
+};
+//!--
+
 //!--IDL_MAPS
 struct MapStruct
 {
@@ -190,6 +197,22 @@ struct BitsetStruct
 };
 //!--
 
+//!--IDL_BITSET_JSON
+bitset MyBitSet
+{
+ bitfield<3> a;
+ bitfield<1> b;
+ bitfield<4>;
+ bitfield<10> c;
+ bitfield<12, short> d;
+};
+
+struct BitsetStruct
+{
+ MyBitSet my_bitset;
+};
+//!--
+
 //!--IDL_CUSTOM_ANNOTATION
 @annotation MyAnnotation
 {

code/json/Arrays.json

@@ -0,0 +1,14 @@
+{
+ "long_array": [
+ [
+ 0,
+ 0,
+ 0
+ ],
+ [
+ 0,
+ 0,
+ 0
+ ]
+ ]
+}

code/json/Bitmask_EPROSIMA.json

@@ -0,0 +1,7 @@
+{
+ "my_bitmask": {
+ "active": [],
+ "binary": "00000000",
+ "value": 0
+ }
+}

code/json/Bitmask_OMG.json

@@ -0,0 +1,3 @@
+{
+ "my_bitmask": 0
+}

code/json/Bitsets.json

@@ -0,0 +1,8 @@
+{
+ "my_bitset": {
+ "a": 0,
+ "b": 0,
+ "c": 0,
+ "d": 0
+ }
+}

code/json/Enum_EPROSIMA.json

@@ -0,0 +1,6 @@
+{
+ "my_enum": {
+ "name": "A",
+ "value": 0
+ }
+}

code/json/Enum_OMG.json

@@ -0,0 +1,3 @@
+{
+ "my_enum": "A"
+}

code/json/Maps.json

@@ -0,0 +1,4 @@
+{
+ "short_long_map": null,
+ "string_alias_unbounded_map": null
+}

code/json/Primitives.json

@@ -0,0 +1,17 @@
+{
+ "my_bool": false,
+ "my_octet": 0,
+ "my_char": "\u0000",
+ "my_wchar": "\u0000",
+ "my_long": 0,
+ "my_ulong": 0,
+ "my_int8": 0,
+ "my_uint8": 0,
+ "my_short": 0,
+ "my_ushort": 0,
+ "my_longlong": 0,
+ "my_ulonglong": 0,
+ "my_float": 0.0,
+ "my_double": 0.0,
+ "my_longdouble": 0.0
+}

code/json/Sequences.json

@@ -0,0 +1,4 @@
+{
+ "bitmask_sequence": [],
+ "short_sequence": []
+}

code/json/Strings.json

@@ -0,0 +1,6 @@
+{
+ "my_string": "",
+ "my_wstring": "",
+ "my_bounded_string": "",
+ "my_bounded_wstring": ""
+}

code/json/Structs.json

@@ -0,0 +1,7 @@
+{
+ "complex_member": {
+ "first": 0
+ },
+ "first": 0.0,
+ "second": 0
+}

code/json/Unions.json

@@ -0,0 +1,10 @@
+{
+ "inner_union": {
+ "second": 0
+ },
+ "complex_union": {
+ "fourth": {
+ "second": 0
+ }
+ }
+}

docs/03-exports/aliases-api.include

@@ -991,6 +991,7 @@
 .. |ITypeObjectRegistry-api| replace:: :cpp:class:`ITypeObjectRegistry <eprosima::fastdds::dds::xtypes::ITypeObjectRegistry>`
 .. |ITypeObjectRegistry::get_type_object| replace:: :cpp:func:`ITypeObjectRegistry::get_type_object <eprosima::fastdds::dds::xtypes::ITypeObjectRegistry::get_type_object>`
 .. |TypeObjectUtils-api| replace:: :cpp:class:`TypeObjectUtils <eprosima::fastdds::dds::xtypes::TypeObjectUtils>`
+.. |XTypesUtils-json_serialize-api| replace:: :cpp:func:`json_serialize <eprosima::fastdds::dds::json_serialize>`
 .. }}}
 
 .. |DomainParticipant::set_listener-api| replace:: :cpp:func:`DomainParticipant::set_listener()<eprosima::fastdds::dds::DomainParticipant::set_listener>`

docs/fastdds/api_reference/dds_pim/xtypes/utils.rst

@@ -0,0 +1,9 @@
+.. _api_pim_xtypes_utils:
+
+.. rst-class:: api-ref
+
+Utils
+-----
+
+.. doxygenfunction:: eprosima::fastdds::dds::json_serialize
+ :project: FastDDS

docs/fastdds/api_reference/dds_pim/xtypes/xtypes.rst

@@ -7,3 +7,4 @@ XTypes
  /fastdds/api_reference/dds_pim/xtypes/dynamic_types.rst
  /fastdds/api_reference/dds_pim/xtypes/exception.rst
  /fastdds/api_reference/dds_pim/xtypes/type_representation.rst
+ /fastdds/api_reference/dds_pim/xtypes/utils.rst

docs/fastdds/api_reference/spelling_wordlist.txt

@@ -301,6 +301,8 @@ untaken
 untyped
 url
 UserAllocatedSequence
+Utils
+utils
 wakeup
 wdata
 WLPListener