RTI Connext C# API  6.1.2
StructBuilder Class Reference

Allows creating a new StructType via DynamicTypeFactory.BuildStruct(). More...

Public Member Functions

StructBuilder WithName (string name)
 Returns the same StructBuilder instance with a modified Name. More...
 
StructBuilder WithParent (StructType parent)
 Returns the same StructBuilder instance with a modified Parent. More...
 
StructBuilder WithExtensibility (ExtensibilityKind kind)
 Returns the same StructBuilder instance with a modified ExtensibilityKind. More...
 
StructBuilder AddMember (StructMember member)
 Returns the same StructBuilder instance with a new StructMember added to Members. More...
 
StructBuilder AddMembers (params StructMember[] members)
 Returns the same StructBuilder instance with a number of new StructMember added to Members. More...
 
StructBuilder AddMembers (IEnumerable< StructMember > members)
 Returns the same StructBuilder instance with a number of new StructMember added to Members. More...
 
StructType Create ()
 Creates a new StructType object using the current properties of the StructBuilder instance. More...
 

Properties

string Name [get]
 The type name. More...
 
StructType Parent [get]
 The base type or null if the struct doesn't have one. More...
 
ExtensibilityKind ExtensibilityKind [get]
 The value for the IDL extensibility kind. More...
 
IList< StructMemberMembers [get]
 The data members. More...
 

Detailed Description

Allows creating a new StructType via DynamicTypeFactory.BuildStruct().

Member Function Documentation

◆ AddMember()

StructBuilder AddMember ( StructMember  member)

Returns the same StructBuilder instance with a new StructMember added to Members.

Parameters
memberThe StructMember to be added.

◆ AddMembers() [1/2]

StructBuilder AddMembers ( IEnumerable< StructMember members)

Returns the same StructBuilder instance with a number of new StructMember added to Members.

Parameters
membersThe enumerable object of StructMember to be added.

◆ AddMembers() [2/2]

StructBuilder AddMembers ( params StructMember[]  members)

Returns the same StructBuilder instance with a number of new StructMember added to Members.

Parameters
membersThe array of StructMember to be added.

◆ Create()

StructType Create ( )

Creates a new StructType object using the current properties of the StructBuilder instance.

◆ WithExtensibility()

StructBuilder WithExtensibility ( ExtensibilityKind  kind)

Returns the same StructBuilder instance with a modified ExtensibilityKind.

Parameters
kindThe new ExtensibilityKind to be set.

◆ WithName()

StructBuilder WithName ( string  name)

Returns the same StructBuilder instance with a modified Name.

Parameters
nameThe new Name to be set.

◆ WithParent()

StructBuilder WithParent ( StructType  parent)

Returns the same StructBuilder instance with a modified Parent.

Parameters
parentThe new Parent to be set.

Property Documentation

◆ ExtensibilityKind

The value for the IDL extensibility kind.

◆ Members

IList<StructMember> Members
get

The data members.

◆ Name

string Name
get

The type name.

◆ Parent

StructType Parent
get

The base type or null if the struct doesn't have one.