LuciadCPillar C# 2024.0.04
Luciad.Datamodels.DataProperty.Builder Class Reference

Builder that allows DataProperty instances to be created. More...

Inheritance diagram for Luciad.Datamodels.DataProperty.Builder:

Public Member Functions

 Builder (Luciad.Datamodels.DataProperty.Builder other)
 
Luciad.Datamodels.DataProperty Build ()
 Build the data type, including the value type that was set on this builder. More...
 
void Dispose ()
 
Luciad.Datamodels.DataProperty.Builder Name (string name)
 Sets the name of the data property. More...
 
Luciad.Datamodels.DataProperty.Builder ValueType (Luciad.Datamodels.DataType type)
 Sets the data type for the data property under construction. More...
 

Detailed Description

Builder that allows DataProperty instances to be created.

Typical usage would be create a DataProperty.Builder using DataProperty.NewBuilder, specifying the data property's name. Then specify the value type and finally build() the data property. The following snippet shows how this is done for a simple example data property:

return DataProperty.NewBuilder().Name("geometry").ValueType(DataType.GeometryType).Build();
Represents a property of a DataType.
Definition: DataProperty.cs:21
static Luciad.Datamodels.DataProperty.Builder NewBuilder()
Creates a new DataProperty builder.
Definition: DataProperty.cs:58
string Name
The name of the data property.
Definition: DataProperty.cs:84
A representation of the type of a data object.
Definition: DataType.cs:26
static Luciad.Datamodels.DataType GeometryType
The type that corresponds to Geometry values.
Definition: DataType.cs:167

Constructor & Destructor Documentation

◆ Builder()

Luciad.Datamodels.DataProperty.Builder.Builder ( Luciad.Datamodels.DataProperty.Builder  other)
inline

Member Function Documentation

◆ Build()

Luciad.Datamodels.DataProperty Luciad.Datamodels.DataProperty.Builder.Build ( )
inline

Build the data type, including the value type that was set on this builder.

After calling this function, this builder should no longer be used.

Returns
the data type.
Exceptions
System.InvalidOperationExceptionIf not all mandatory parameters are set.

◆ Dispose()

void Luciad.Datamodels.DataProperty.Builder.Dispose ( )
inline

◆ Name()

Luciad.Datamodels.DataProperty.Builder Luciad.Datamodels.DataProperty.Builder.Name ( string  name)
inline

Sets the name of the data property.

Calling this function is mandatory.

Parameters
namename of the data property.
Returns
this builder.

◆ ValueType()

Luciad.Datamodels.DataProperty.Builder Luciad.Datamodels.DataProperty.Builder.ValueType ( Luciad.Datamodels.DataType  type)
inline

Sets the data type for the data property under construction.

Calling this function is mandatory.

Parameters
typethe data type for the data property under construction.
Returns
this builder.