Rti.Dds.Topics.PrintFormatProperty Class Reference

A collection of attributes used to configure how data samples will be formatted when converted to a string. More...

Inherits IEquatable< PrintFormatProperty >.

Public Member Functions
override bool	Equals (object other)
	Compares for equality. More...
override int	GetHashCode ()
	Calculates a hash code. More...
bool	Equals (PrintFormatProperty other)
	Compares for equality. More...

Properties
PrintFormatKind	Kind = PrintFormatKind.Default [get, set]
	The kind of format to be used when converting a data sample to a string. More...
bool	PrettyPrint = true [get, set]
	Choose whether to print a data sample in a more readable format or to eliminate all white space. More...
bool	EnumAsInt = false [get, set]
	Choose whether to print enum values as integers or as strings. More...
bool	IncludeRootElements = true [get, set]
	Choose whether or not to include the root elements of the print format in the output string. More...

Detailed Description

A collection of attributes used to configure how data samples will be formatted when converted to a string.

See also

Rti.Types.Dynamic.DynamicData.ToString(PrintFormatProperty).

TypeSupport<T>.ToString(T, PrintFormatProperty)

Member Function Documentation

Equals() [1/2]

override bool Rti.Dds.Topics.PrintFormatProperty.Equals

(

object

other

)

Compares for equality.

GetHashCode()

override int Rti.Dds.Topics.PrintFormatProperty.GetHashCode ( )

inline

Calculates a hash code.

Equals() [2/2]

bool Rti.Dds.Topics.PrintFormatProperty.Equals ( PrintFormatProperty  other )

inline

Compares for equality.

Property Documentation

Kind

PrintFormatKind Rti.Dds.Topics.PrintFormatProperty.Kind = PrintFormatKind.Default

getset

The kind of format to be used when converting a data sample to a string.

The full documentation is available in the C API: DDS_PrintFormatProperty_kind

PrettyPrint

bool Rti.Dds.Topics.PrintFormatProperty.PrettyPrint = true

getset

Choose whether to print a data sample in a more readable format or to eliminate all white space.

The full documentation is available in the C API: DDS_PrintFormatProperty_pretty_print

EnumAsInt

bool Rti.Dds.Topics.PrintFormatProperty.EnumAsInt = false

getset

Choose whether to print enum values as integers or as strings.

The full documentation is available in the C API: DDS_PrintFormatProperty_enum_as_int

IncludeRootElements

bool Rti.Dds.Topics.PrintFormatProperty.IncludeRootElements = true

getset

Choose whether or not to include the root elements of the print format in the output string.

The full documentation is available in the C API: DDS_PrintFormatProperty_include_root_elements