rti::core::xtypes::DynamicDataTypeSerializationProperty Class Reference

<<extension>> <<value-type>> Configures aspects of the memory management in the serialization of dds::core::xtypes::DynamicData samples. More...

#include <rti/core/xtypes/DynamicDataProperty.hpp>

Public Member Functions
	DynamicDataTypeSerializationProperty ()
	Default configuration. More...
	DynamicDataTypeSerializationProperty (int32_t the_max_size_serialized, int32_t the_min_size_serialized, bool the_trim_to_size, bool the_enable_fast_deserialization)
	Specifies all the serialization parameters. More...
uint32_t	max_size_serialized () const
	Getter (see setter with the same name) More...
DynamicDataTypeSerializationProperty &	max_size_serialized (uint32_t value)
	[No longer supported] If you were previously using this property, use DynamicDataProperty_t::buffer_max_size instead. The maximum number of bytes that objects of a given type could consume when serialized on the network. More...
uint32_t	min_size_serialized () const
	Getter (see setter with the same name) More...
DynamicDataTypeSerializationProperty &	min_size_serialized (uint32_t value)
	[No longer supported] If you were previously using this property, use DynamicDataProperty_t::buffer_initial_size instead. The minimum number of bytes that objects of a given type could consume when serialized on the network. More...
bool	trim_to_size () const
	Getter (see setter with the same name) More...
DynamicDataTypeSerializationProperty &	trim_to_size (bool value)
	Controls the growth of the buffer in a DynamicData object. More...
bool	enable_fast_deserialization () const
	Getter (see setter with the same name) More...

Static Public Attributes
static OMG_DDS_API_CLASS_VARIABLE const DynamicDataTypeSerializationProperty	DEFAULT
	Default configuration. More...

Detailed Description

<<extension>> <<value-type>> Configures aspects of the memory management in the serialization of dds::core::xtypes::DynamicData samples.

See also

rti::domain::register_type(dds::domain::DomainParticipant&,const std::string&, const dds::core::xtypes::DynamicType&, const rti::core::xtypes::DynamicDataTypeSerializationProperty&)

Constructor & Destructor Documentation

DynamicDataTypeSerializationProperty() [1/2]

rti::core::xtypes::DynamicDataTypeSerializationProperty::DynamicDataTypeSerializationProperty ( )

inline

Default configuration.

DynamicDataTypeSerializationProperty() [2/2]

rti::core::xtypes::DynamicDataTypeSerializationProperty::DynamicDataTypeSerializationProperty ( int32_t  the_max_size_serialized, int32_t  the_min_size_serialized, bool  the_trim_to_size, bool  the_enable_fast_deserialization  )

inline

Specifies all the serialization parameters.

Member Function Documentation

max_size_serialized() [1/2]

uint32_t rti::core::xtypes::DynamicDataTypeSerializationProperty::max_size_serialized ( ) const

inline

Getter (see setter with the same name)

max_size_serialized() [2/2]

DynamicDataTypeSerializationProperty& rti::core::xtypes::DynamicDataTypeSerializationProperty::max_size_serialized ( uint32_t  value )

inline

[No longer supported] If you were previously using this property, use DynamicDataProperty_t::buffer_max_size instead. The maximum number of bytes that objects of a given type could consume when serialized on the network.

This value is used to set the sizes of certain internal middleware buffers.

The effective value of the maximum serialized size will be the value of this field or the size automatically inferred from the type's TypeCode, whichever is smaller.

min_size_serialized() [1/2]

uint32_t rti::core::xtypes::DynamicDataTypeSerializationProperty::min_size_serialized ( ) const

inline

Getter (see setter with the same name)

min_size_serialized() [2/2]

DynamicDataTypeSerializationProperty& rti::core::xtypes::DynamicDataTypeSerializationProperty::min_size_serialized ( uint32_t  value )

inline

[No longer supported] If you were previously using this property, use DynamicDataProperty_t::buffer_initial_size instead. The minimum number of bytes that objects of a given type could consume when serialized on the network.

This value is used to set the sizes of certain internal middleware buffers.

Default: 0xFFFFFFFF, a sentinel that indicates that this value must be equal to the value specified in max_size_serialized.

trim_to_size() [1/2]

bool rti::core::xtypes::DynamicDataTypeSerializationProperty::trim_to_size ( ) const

inline

Getter (see setter with the same name)

trim_to_size() [2/2]

DynamicDataTypeSerializationProperty& rti::core::xtypes::DynamicDataTypeSerializationProperty::trim_to_size ( bool  value )

inline

Controls the growth of the buffer in a DynamicData object.

This property only applies to DynamicData samples that are obtained from the sample pool that is created by each DynamicData DataReader.

If set to 0 (default): The buffer will not be reallocated unless the deserialized size of the incoming sample is greater than the current buffer size.

If set to 1: The buffer of a DynamicData object obtained from the DDS sample pool will be freed and re-allocated for each sample to just fit the size of the deserialized data of the incoming sample. The newly allocated size will not be smaller than DynamicDataProperty_t::buffer_initial_size.

enable_fast_deserialization()

bool rti::core::xtypes::DynamicDataTypeSerializationProperty::enable_fast_deserialization ( ) const

inline

Getter (see setter with the same name)

Member Data Documentation

DEFAULT

OMG_DDS_API_CLASS_VARIABLE const DynamicDataTypeSerializationProperty rti::core::xtypes::DynamicDataTypeSerializationProperty::DEFAULT

static

Default configuration.