Rti.Types.Dynamic.StructMember Class Reference

Represents a data member in a StructType. More...

Inheritance diagram for Rti.Types.Dynamic.StructMember:

Public Member Functions
	StructMember (string name, DynamicType type, int id=InvalidMemberId, bool isExternal=false, bool isKey=false, bool isOptional=false, bool isMustUnderstand=false, Annotations annotations=null)
	Creates a new StructMember. More...
override bool	Equals (object other)
	Compares for equality More...
override int	GetHashCode ()
	Calculates a hash code More...
bool	Equals (StructMember other)
	Compares for equality More...
override string	ToString ()
	Returns the member type and name More...

Static Public Attributes
const int	InvalidMemberId = 0x7FFFFFFF
	The default value for a member id. More...

Properties
string	Name [get]
	The member name. More...
DynamicType	Type [get]
	The member type. More...
bool	IsExternal [get]
	Whether this member is annotated as @external. More...
int	Id [get]
	The member IDL (value of the @id annotation). More...
bool	IsKey [get]
	Whether this member is annotated as @key. More...
bool	IsOptional [get]
	Whether this member is annotated as ``. More...
bool	IsMustUnderstand [get]
	Whether this member is annotated as @must_understand. More...
Annotations	Annotations [get, set]
	Optional values for the annotated properties of this member. More...
Properties inherited from Omg.Types.Dynamic.IStructMember
bool	IsKey [get]
	Whether this member is annotated as a key. More...
bool	IsOptional [get]
	Whether this member is annotated as optional. More...
Properties inherited from Omg.Types.Dynamic.IAggregationMember
IDynamicType	Type [get]
	The IDynamicType of the IAggregationMember. More...
int	Id [get]
	The id of the IAggregationMember. More...
bool	IsExternal [get]
	Indicates whether or not the IAggregationMember is annotated as external. More...
Properties inherited from Omg.Types.Dynamic.IMember
string	Name [get]
	The name of the member. More...

Detailed Description

Represents a data member in a StructType.

Constructor & Destructor Documentation

StructMember()

Rti.Types.Dynamic.StructMember.StructMember ( string  name, DynamicType  type, int  id = InvalidMemberId, bool  isExternal = false, bool  isKey = false, bool  isOptional = false, bool  isMustUnderstand = false, Annotations  annotations = null  )

inline

Creates a new StructMember.

Parameters

name	The name (required)
type	The type (required)
id	An explicit member ID (optional, automatically assigned by default)
isExternal	Whether to set @external (optional, false by default)
isKey	Whether to set @key (optional, false by default)
isOptional	Whether to set @optional (optional, false by default)
isMustUnderstand	Whether to set @must_understand (optional, false by default)
annotations	Member annotations (optional, none by default)

Member Function Documentation

Equals() [1/2]

override bool Rti.Types.Dynamic.StructMember.Equals

(

object

other

)

Compares for equality

GetHashCode()

override int Rti.Types.Dynamic.StructMember.GetHashCode ( )

inline

Calculates a hash code

Equals() [2/2]

bool Rti.Types.Dynamic.StructMember.Equals ( StructMember  other )

inline

Compares for equality

ToString()

override string Rti.Types.Dynamic.StructMember.ToString

(

)

Returns the member type and name

Field Documentation

InvalidMemberId

const int Rti.Types.Dynamic.StructMember.InvalidMemberId = 0x7FFFFFFF

static

The default value for a member id.

Property Documentation

Name

string Rti.Types.Dynamic.StructMember.Name

get

The member name.

Implements Omg.Types.Dynamic.IMember.

Type

DynamicType Rti.Types.Dynamic.StructMember.Type

get

The member type.

Implements Omg.Types.Dynamic.IAggregationMember.

IsExternal

bool Rti.Types.Dynamic.StructMember.IsExternal

get

Whether this member is annotated as @external.

Implements Omg.Types.Dynamic.IAggregationMember.

Id

int Rti.Types.Dynamic.StructMember.Id

get

The member IDL (value of the @id annotation).

Implements Omg.Types.Dynamic.IAggregationMember.

IsKey

bool Rti.Types.Dynamic.StructMember.IsKey

get

Whether this member is annotated as @key.

Implements Omg.Types.Dynamic.IStructMember.

IsOptional

bool Rti.Types.Dynamic.StructMember.IsOptional

get

Whether this member is annotated as ``.

Implements Omg.Types.Dynamic.IStructMember.

IsMustUnderstand

bool Rti.Types.Dynamic.StructMember.IsMustUnderstand

get

Whether this member is annotated as @must_understand.

Note that members that are annotated as @key are always considered @must_understand, even if not explicitly annotated as such.

Annotations

Annotations Rti.Types.Dynamic.StructMember.Annotations

getset

Optional values for the annotated properties of this member.