DataRepresentation Class Reference

Specifies a list of representation identifiers and compression settings used by Publication.DataWriter<T> and Subscription.DataReader<T> entities to negotiate which data representation and compression settings to use. More...

Inherits IEquatable< DataRepresentation >.

Public Member Functions
DataRepresentation	With (Action< DataRepresentationBuilder > build)
	Creates a new DataRepresentation with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (DataRepresentation other)
	Compares for equality More...

Static Public Attributes
const short	Xcdr
	Corresponds to the Extended Common Data Representation encoding version 1. More...
const short	Xml
	Corresponds to XML Data Representation (unsupported). More...
const short	Xcdr2
	Corresponds to the Extended Common Data Representation encoding version 2. More...
const short	Auto
	Representation is automatically chosen based on the type. More...

Properties
ImmutableList< short >	Value [get]
	Sequence of representation identifiers. More...
CompressionSettings	CompressionSettings [get]
	Structure that contains the compression settings. More...
static DataRepresentation	Default [get]
	Singleton containing the default value of a DataRepresentation More...

Detailed Description

Specifies a list of representation identifiers and compression settings used by Publication.DataWriter<T> and Subscription.DataReader<T> entities to negotiate which data representation and compression settings to use.

Member Function Documentation

Equals() [1/2]

bool Equals

(

DataRepresentation

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

DataRepresentation With

(

Action< DataRepresentationBuilder >

build

)

Creates a new DataRepresentation with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this DataRepresentation.

Returns

A new DataRepresentation with the changes applied by the Action

Member Data Documentation

Auto

const short Auto

static

Representation is automatically chosen based on the type.

The full documentation is available in the C API: DDS_AUTO_DATA_REPRESENTATION

Xcdr

const short Xcdr

static

Corresponds to the Extended Common Data Representation encoding version 1.

The full documentation is available in the C API: DDS_XCDR_DATA_REPRESENTATION

Xcdr2

const short Xcdr2

static

Corresponds to the Extended Common Data Representation encoding version 2.

The full documentation is available in the C API: DDS_XCDR2_DATA_REPRESENTATION

Xml

const short Xml

static

Corresponds to XML Data Representation (unsupported).

The full documentation is available in the C API: DDS_XML_DATA_REPRESENTATION

Property Documentation

CompressionSettings

CompressionSettings CompressionSettings

get

Structure that contains the compression settings.

The full documentation is available in the C API: DDS_DataRepresentationQosPolicy::compression_settings

Default

DataRepresentation Default

staticget

Singleton containing the default value of a DataRepresentation

Value

ImmutableList<short> Value

get

Sequence of representation identifiers.

The full documentation is available in the C API: DDS_DataRepresentationQosPolicy::value