LuciadCPillar C# 2024.0.01
Luciad.Datamodels.DataType Class Reference

A representation of the type of a data object. More...

Inheritance diagram for Luciad.Datamodels.DataType:

Classes

class  Builder
 Builder that allows DataType instances to be created. More...
 

Public Member Functions

void Dispose ()
 
override bool Equals (object other)
 
Luciad.Datamodels.DataProperty FindDataProperty (string name)
 Searches for a data property by name. More...
 
override int GetHashCode ()
 Returns the hash code. More...
 
bool HasDataProperty (Luciad.Datamodels.DataProperty property)
 Returns if the given property is declared in this data type. More...
 
override string ToString ()
 

Static Public Member Functions

static Luciad.Datamodels.DataType.Builder NewBuilder ()
 Creates a new DataType builder. More...
 

Properties

System.Collections.Generic.IList< Luciad.Datamodels.DataAnnotationAnnotations [get]
 The list of annotations attached to this data type. More...
 
static Luciad.Datamodels.DataType BooleanType [get]
 The type that corresponds to bool values. More...
 
System.Collections.Generic.IList< Luciad.Datamodels.DataPropertyDataProperties [get]
 The list of properties of this data type. More...
 
static Luciad.Datamodels.DataType DoubleType [get]
 The type that corresponds to double values. More...
 
static Luciad.Datamodels.DataType FloatType [get]
 The type that corresponds to float values. More...
 
static Luciad.Datamodels.DataType GeometryType [get]
 The type that corresponds to Geometry values. More...
 
static Luciad.Datamodels.DataType IntType [get]
 The type that corresponds to int32_t values. More...
 
bool IsPrimitive [get]
 Whether this is a primitive type, i.e. More...
 
static Luciad.Datamodels.DataType LongType [get]
 The type that corresponds to int64_t values. More...
 
string Name [get]
 The name of this data type. More...
 
static Luciad.Datamodels.DataType StringType [get]
 The type that corresponds to std::string values. More...
 

Detailed Description

A representation of the type of a data object.

A type describes the structure of a data object as a list of properties. Each of these properties is itself of a certain type.

A type is either a primitive type or a data object type. Primitive types are types which have no internal structure (no properties) and typically represent simple object such as strings, numbers etc. All primitive types are accessible from this class (see e.g. getIntType(), getStringType() ...).

Application-specific metadata can be attached to a type in the form of a DataAnnotation.

New types can be defined using a DataType.Builder (see newBuilder()).

Instances of this class are thread safe. Once an instance has been created, there is no public API to modify it.

See also
DataProperty

Member Function Documentation

◆ Dispose()

void Luciad.Datamodels.DataType.Dispose ( )
inline

◆ Equals()

override bool Luciad.Datamodels.DataType.Equals ( object  other)
inline
Parameters
otheranother data type.
Returns
whether this type and other have the same name, properties and annotations.

◆ FindDataProperty()

Luciad.Datamodels.DataProperty Luciad.Datamodels.DataType.FindDataProperty ( string  name)
inline

Searches for a data property by name.

Parameters
namethe name of a property
Returns
the data property with the given name, if available
See also
HasDataProperty

◆ GetHashCode()

override int Luciad.Datamodels.DataType.GetHashCode ( )
inline

Returns the hash code.

Returns
the hash code.

◆ HasDataProperty()

bool Luciad.Datamodels.DataType.HasDataProperty ( Luciad.Datamodels.DataProperty  property)
inline

Returns if the given property is declared in this data type.

Parameters
propertyData property.
Returns
if the given property is declared in this data type.
See also
FindDataProperty

◆ NewBuilder()

static Luciad.Datamodels.DataType.Builder Luciad.Datamodels.DataType.NewBuilder ( )
inlinestatic

Creates a new DataType builder.

Returns
a new DataType builder.

◆ ToString()

override string Luciad.Datamodels.DataType.ToString ( )
inline

Property Documentation

◆ Annotations

System.Collections.Generic.IList<Luciad.Datamodels.DataAnnotation> Luciad.Datamodels.DataType.Annotations
get

The list of annotations attached to this data type.

[get]

Returns the list of annotations attached to this data type.

◆ BooleanType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.BooleanType
staticget

The type that corresponds to bool values.

[get]

Returns the type that corresponds to bool values.

◆ DataProperties

System.Collections.Generic.IList<Luciad.Datamodels.DataProperty> Luciad.Datamodels.DataType.DataProperties
get

The list of properties of this data type.

[get]

Returns the list of properties of this data type.

◆ DoubleType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.DoubleType
staticget

The type that corresponds to double values.

[get]

Returns the type that corresponds to double values.

◆ FloatType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.FloatType
staticget

The type that corresponds to float values.

[get]

Returns the type that corresponds to float values.

◆ GeometryType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.GeometryType
staticget

The type that corresponds to Geometry values.

[get]

Returns the type that corresponds to Geometry values.

◆ IntType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.IntType
staticget

The type that corresponds to int32_t values.

[get]

Returns the type that corresponds to int32_t values.

◆ IsPrimitive

bool Luciad.Datamodels.DataType.IsPrimitive
get

Whether this is a primitive type, i.e.

[get]

Returns whether this is a primitive type, i.e. a type without any properties.

◆ LongType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.LongType
staticget

The type that corresponds to int64_t values.

[get]

Returns the type that corresponds to int64_t values.

◆ Name

string Luciad.Datamodels.DataType.Name
get

The name of this data type.

[get]

Returns the name of this data type.

◆ StringType

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.StringType
staticget

The type that corresponds to std::string values.

[get]

Returns the type that corresponds to std::string values.