Example.MyType Struct Reference

Example C# class generated from the IDL struct MyType More...

Inherits IEquatable< MyType >.

Public Member Functions
	MyType ()
	Creates a fully initialized new instance with the default values More...
	MyType (int MyKey, string MyString, Example.Point MyPoint, ISequence< int > MyIntSequence, ISequence< Example.Point > MyPointSequence, Example.Point[] MyPointArray, int? MyOptionalInt, Example.Point MyOptionalPoint)
	Creates a new instance with a given value for each property More...
	MyType (MyType other_)
	Creates a new instance by making a deep copy of an existing one More...
bool	Equals (MyType other)
	Compares two MyType instances for equality (IEquatable implementation). The comparison is deep. More...
override bool	Equals (object obj)
	Compares this instance with another object (override of object.Equals) More...
override string	ToString ()
	Provides a readable string representation More...
override int	GetHashCode ()
	Calculates the hash code based on the values of each property More...

Properties
int	MyKey [get, set]
	Gets or sets the value for the field MyKey More...
string	MyString = string.Empty [get, set]
	Gets or sets the value for the field MyString More...
Example.Point	MyPoint [get, set]
	Gets or sets the value for the field MyPoint. More...
ISequence< int >	MyIntSequence [get]
	Gets the sequence MyIntSequence More...
ISequence< Example.Point >	MyPointSequence [get]
	Gets the sequence MyPointSequence More...
Example.Point[]	MyPointArray [get, set]
	Gets or sets the array MyPointArray. More...
int?	MyOptionalInt [get, set]
	Gets or sets the optional value of MyOptionalInt. A null value is allowed. More...
Example.Point	MyOptionalPoint [get, set]
	Gets or sets the optional value of MyOptionalPoint. A null value is allowed. More...

Detailed Description

Example C# class generated from the IDL struct MyType

Use the documentation of this example class as a guide to understand the IDL-to-C# mapping of user data types, based on the OMG IDL4-CSHARP specification.

The IDL definition of MyType is the following:

// MyType.idl
 
module Example {
    struct Point {
        int32 X;
        int32 Y;
    };
 
    struct MyType {
        @key int32 MyKey;
        string<512> MyString;
        Point MyPoint;
        sequence<int32, 128> MyIntSequence;
        sequence<Point, 8> MyPointSequence;
        Point MyPointArray[5];
        @optional int32 MyOptionalInt;
        @optional Point MyOptionalPoint;
    };
};

The code generation tool (rtiddsgen) generates the C# types:

rtiddsgen -language c# MyType.idl

See also

IDL examples

Constructor & Destructor Documentation

MyType() [1/3]

Example.MyType.MyType ( )

inline

Creates a fully initialized new instance with the default values

Each member is fully initialized as follows:

• MyKey is set to 0
• MyString is set to string.Empty
• MyPoint is created with the default constructor (which sets X and Y to 0)
• MyIntSequence is created as an empty Rti.Types.Sequence.
• MyPointSequence is created as an empty Rti.Types.Sequence.
• MyPointArray is created as an array of 5 Points, each created using Point's default constructor
• MyOptionalInt is set to null
• MyOptionalPoint is set to null

MyType() [2/3]

Example.MyType.MyType ( int  MyKey, string  MyString, Example.Point  MyPoint, ISequence< int >  MyIntSequence, ISequence< Example.Point >  MyPointSequence, Example.Point[]  MyPointArray, int?  MyOptionalInt, Example.Point  MyOptionalPoint  )

inline

Creates a new instance with a given value for each property

The parameters are directly assigned to the properties; they're not deeply copied.

MyType() [3/3]

Example.MyType.MyType ( MyType  other_ )

inline

Creates a new instance by making a deep copy of an existing one

Parameters

other_

The object to copy

Each property is deeply copied. For example:

var a = new MyType();
a.MyPoint = new Point(x: 5, y: 7);
var b = new MyType(a);
Debug.Assert(!ReferenceEquals(a.MyPoint, b.MyPoint);
Debug.Assert(Equals(a.MyPoint, b.MyPoint);

Member Function Documentation

Equals() [1/2]

bool Example.MyType.Equals ( MyType  other )

inline

Compares two MyType instances for equality (IEquatable implementation). The comparison is deep.

Parameters

other

The instance to compare

Returns

Whether the two instances have the same values for all their properties and all the elements in the sequence and array fields.

Equals() [2/2]

override bool Example.MyType.Equals

(

object

obj

)

Compares this instance with another object (override of object.Equals)

Parameters

obj	Any object

Returns

True only if obj is of type MyType and both are equal

ToString()

override string Example.MyType.ToString

(

)

Provides a readable string representation

MyTypeSupport provides additional options (such as XML and JSON formatting) via Rti.Dds.Topics.TypeSupport<T>.ToString(T, Rti.Dds.Topics.PrintFormatProperty).

GetHashCode()

override int Example.MyType.GetHashCode ( )

inline

Calculates the hash code based on the values of each property

For sequence types only the sequence length is used in the hash; for arrays only the first element is used to calculate the hash.

Property Documentation

MyKey

int Example.MyType.MyKey

getset

Gets or sets the value for the field MyKey

This property is defined as follows:

[Key]
public int MyKey { get; set; }

See also

Omg.Types.KeyAttribute

MyString

string Example.MyType.MyString = string.Empty

getset

Gets or sets the value for the field MyString

This property is defined as follows:

[Bound(512)]
public string MyString { get; set; } = string.Empty;

The property can't be set to null (because it's not ``) and can't contain more bytes than its bound (512). In any of these cases Rti.Dds.Publication.DataWriter<T>.Write(T) would fail.

Note

Both IDL string and wstring map to C# string. However, an IDL string is encoded in UTF-8, whereas a wstring is encoded in UTF-16. The bound of a string refers to the total number of bytes in UTF-8, after being encoded. In the case of wstring, the bound refers to the total number of characters.

See also

Omg.Types.BoundAttribute

MyPoint

Example.Point Example.MyType.MyPoint

getset

Gets or sets the value for the field MyPoint.

The property can't be set to null unless the field is optional. Otherwise Rti.Dds.Publication.DataWriter<T>.Write(T) will fail.

MyIntSequence

ISequence<int> Example.MyType.MyIntSequence

get

Gets the sequence MyIntSequence

This property is defined as follows:

[Bound(128)]
public ISequence<int> MyIntSequence { get; }

Sequences do not provide a setter, only a getter, which allows adding or removing elements.

If a bounded sequence contains more elements than its bound (in this case, 128), Rti.Dds.Publication.DataWriter<T>.Write(T) will fail.

See also

Omg.Types.BoundAttribute

MyPointSequence

ISequence<Example.Point> Example.MyType.MyPointSequence

get

Gets the sequence MyPointSequence

This property is defined as follows:

[Bound(8)]
public ISequence<Example.Point> MyPointSequence { get; }

Sequences do not provide a setter, only a getter, which allows adding or removing elements.

If a bounded sequence contains more elements than its bound (in this case, 8), Rti.Dds.Publication.DataWriter<T>.Write(T) will fail.

See also

Omg.Types.BoundAttribute

MyPointArray

Example.Point [] Example.MyType.MyPointArray

getset

Gets or sets the array MyPointArray.

If a new array is set, it must contain exactly the number of elements that was specified in the IDL file (5). Otherwise Rti.Dds.Publication.DataWriter<T>.Write(T) will fail.

MyOptionalInt

int? Example.MyType.MyOptionalInt

getset

Gets or sets the optional value of MyOptionalInt. A null value is allowed.

This property is defined as follows:

[Optional]
public int? MyOptionalInt { get; set; }

See also

Omg.Types.OptionalAttribute

MyOptionalPoint

Example.Point Example.MyType.MyOptionalPoint

getset

Gets or sets the optional value of MyOptionalPoint. A null value is allowed.

This property is defined as follows:

[Optional]
public Example.Point MyOptionalPoint { get; set; }

See also

Omg.Types.OptionalAttribute