RTI Connext C# API Version 7.2.0
Rti.Types.Dynamic.EnumBuilder Class Reference

Allows creating a new EnumType via DynamicTypeFactory.BuildEnum(). More...

Public Member Functions

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

Properties

string Name = null [get]
 The enum name. More...
 
ExtensibilityKind ExtensibilityKind [get]
 The value for the IDL extensibility kind. More...
 
IList< EnumMemberMembers = new List<EnumMember>() [get]
 The enum members. More...
 

Detailed Description

Allows creating a new EnumType via DynamicTypeFactory.BuildEnum().

Member Function Documentation

◆ WithName()

EnumBuilder Rti.Types.Dynamic.EnumBuilder.WithName ( string  name)
inline

Returns the same EnumBuilder instance with a modified Name.

Parameters
nameThe new Name to be set.

◆ WithExtensibility()

EnumBuilder Rti.Types.Dynamic.EnumBuilder.WithExtensibility ( ExtensibilityKind  kind)
inline

Returns the same EnumBuilder instance with a modified ExtensibilityKind.

Parameters
kindThe new ExtensibilityKind to be set.

◆ AddMember()

EnumBuilder Rti.Types.Dynamic.EnumBuilder.AddMember ( EnumMember  member)
inline

Returns the same EnumBuilder instance with a new EnumMember added to Members.

Parameters
memberThe EnumMember to be added.

◆ AddMembers() [1/2]

EnumBuilder Rti.Types.Dynamic.EnumBuilder.AddMembers ( params EnumMember[]  members)
inline

Returns the same EnumBuilder instance with a number of new EnumMember added to Members.

Parameters
membersThe array of EnumMember to be added.

◆ AddMembers() [2/2]

EnumBuilder Rti.Types.Dynamic.EnumBuilder.AddMembers ( IEnumerable< EnumMember members)
inline

Returns the same EnumBuilder instance with a number of new EnumMember added to Members.

Parameters
membersThe enumerable object of EnumMember to be added.

◆ Create()

EnumType Rti.Types.Dynamic.EnumBuilder.Create ( )
inline

Creates a new EnumType object using the current properties of the EnumBuilder instance.

Property Documentation

◆ Name

string Rti.Types.Dynamic.EnumBuilder.Name = null
get

The enum name.

◆ ExtensibilityKind

ExtensibilityKind Rti.Types.Dynamic.EnumBuilder.ExtensibilityKind
get

The value for the IDL extensibility kind.

◆ Members

IList<EnumMember> Rti.Types.Dynamic.EnumBuilder.Members = new List<EnumMember>()
get

The enum members.