MetadataBuilder Class Reference

Provides a convenient way to to build up a Metadata flatbuffers. More...

Public Member Functions
	MetadataBuilder (AllowedOperationFlags allowedOperationFlags, string description="", string descriptionUrl="")
	Initializes a new instance of the MetadataBuilder class.
MetadataBuilder	AddDescription (string localeId, string text)
	Adds the description.
MetadataBuilder	AddDisplayName (string localeId, string text)
	Adds the display name.
MetadataBuilder	AddExtension (string key, string value)
	Adds the extension.
MetadataBuilder	AddReference (ReferenceType type, string targetAddress)
	Adds the reference.
Variant	Build ()
	Builds this instance.
MetadataBuilder	SetDisplayFormat (DisplayFormat displayFormat)
	Sets the display format.
MetadataBuilder	SetDisplayName (string displayName)
	Sets the display name.
MetadataBuilder	SetNodeClass (NodeClass nodeClass)
	Sets the node class.
MetadataBuilder	SetUnit (string unit)
	Sets the unit.

Detailed Description

Provides a convenient way to to build up a Metadata flatbuffers.

Definition at line 10 of file MetadataBuilder.cs.

Constructor & Destructor Documentation

MetadataBuilder()

MetadataBuilder ( AllowedOperationFlags  allowedOperationFlags, string  description = "", string  descriptionUrl = ""  )

inline

Initializes a new instance of the MetadataBuilder class.

Parameters

allowedOperationFlags	The allowed operation flags.
description	The description.
descriptionUrl	The description URL.

Definition at line 78 of file MetadataBuilder.cs.

References Variant.DefaultFlatbuffersInitialSize.

Member Function Documentation

AddDescription()

MetadataBuilder AddDescription ( string  localeId, string  text  )

inline

Adds the description.

Parameters

localeId	The local identifier (en, de, ...).
text	The text.

Returns

The MetadataBuilder instance.

Definition at line 184 of file MetadataBuilder.cs.

AddDisplayName()

MetadataBuilder AddDisplayName ( string  localeId, string  text  )

inline

Adds the display name.

Parameters

localeId	The local identifier (en, de, ...).
text	The text.

Returns

The MetadataBuilder instance.

Definition at line 172 of file MetadataBuilder.cs.

AddExtension()

MetadataBuilder AddExtension ( string  key, string  value  )

inline

Adds the extension.

Parameters

key	The key.
value	The value.

Returns

The MetadataBuilder instance.

Definition at line 160 of file MetadataBuilder.cs.

AddReference()

MetadataBuilder AddReference ( ReferenceType  type, string  targetAddress  )

inline

Adds the reference.

Parameters

type	The type.
targetAddress	The target address.

Returns

The MetadataBuilder instance.

Definition at line 148 of file MetadataBuilder.cs.

References ReferenceType.Value.

Build()

Variant Build ( )

inline

Builds this instance.

Returns

The MetadataBuilder instance.

Definition at line 194 of file MetadataBuilder.cs.

SetDisplayFormat()

MetadataBuilder SetDisplayFormat ( DisplayFormat  displayFormat )

inline

Sets the display format.

Parameters

displayFormat

The display format.

Returns

The MetadataBuilder instance.

Definition at line 125 of file MetadataBuilder.cs.

SetDisplayName()

MetadataBuilder SetDisplayName ( string  displayName )

inline

Sets the display name.

Parameters

displayName

The display name.

Returns

The MetadataBuilder instance.

Definition at line 114 of file MetadataBuilder.cs.

SetNodeClass()

MetadataBuilder SetNodeClass ( NodeClass  nodeClass )

inline

Sets the node class.

Parameters

nodeClass

The node class.

Returns

The MetadataBuilder instance.

Definition at line 103 of file MetadataBuilder.cs.

SetUnit()

MetadataBuilder SetUnit ( string  unit )

inline

Sets the unit.

Parameters

unit

The unit.

Returns

The MetadataBuilder instance.

Definition at line 136 of file MetadataBuilder.cs.

---

The documentation for this class was generated from the following file:

• D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/MetadataBuilder.cs