Rti.Dds.Core.Policy.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 = 0
	Corresponds to the Extended Common Data Representation encoding version 1. More...
const short	Xml = 1
	Corresponds to XML Data Representation (unsupported). More...
const short	Xcdr2 = 2
	Corresponds to the Extended Common Data Representation encoding version 2. More...
const short	Auto = -1
	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 = CreateDefault() [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

With()

DataRepresentation Rti.Dds.Core.Policy.DataRepresentation.With ( Action< DataRepresentationBuilder >  build )

inline

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

GetHashCode()

override int Rti.Dds.Core.Policy.DataRepresentation.GetHashCode ( )

inline

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Policy.DataRepresentation.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Policy.DataRepresentation.Equals ( DataRepresentation  other )

inline

Compares for equality

Field Documentation

Xcdr

const short Rti.Dds.Core.Policy.DataRepresentation.Xcdr = 0

static

Corresponds to the Extended Common Data Representation encoding version 1.

The full documentation is available in the C API: DDSDataRepresentationId_tXCDR_DATA_REPRESENTATION

Xml

const short Rti.Dds.Core.Policy.DataRepresentation.Xml = 1

static

Corresponds to XML Data Representation (unsupported).

The full documentation is available in the C API: DDSDataRepresentationId_tXML_DATA_REPRESENTATION

Xcdr2

const short Rti.Dds.Core.Policy.DataRepresentation.Xcdr2 = 2

static

Corresponds to the Extended Common Data Representation encoding version 2.

The full documentation is available in the C API: DDSDataRepresentationId_tXCDR2_DATA_REPRESENTATION

Auto

const short Rti.Dds.Core.Policy.DataRepresentation.Auto = -1

static

Representation is automatically chosen based on the type.

The full documentation is available in the C API: DDSDataRepresentationId_tAUTO_DATA_REPRESENTATION

Property Documentation

Value

ImmutableList<short> Rti.Dds.Core.Policy.DataRepresentation.Value

get

Sequence of representation identifiers.

The full documentation is available in the C API: DDS_DataRepresentationQosPolicy_value

CompressionSettings

CompressionSettings Rti.Dds.Core.Policy.DataRepresentation.CompressionSettings

get

Structure that contains the compression settings.

The full documentation is available in the C API: DDS_DataRepresentationQosPolicy_compression_settings

Default

DataRepresentation Rti.Dds.Core.Policy.DataRepresentation.Default = CreateDefault()

staticget

Singleton containing the default value of a DataRepresentation