DatasetInfo

Description

sealed class Tinman.Terrain.Datasets.DatasetInfo

Derived from

SerializableBase abstract
IDatasetInfo
IVersioned

Holds metadata of a dataset.

See also

IDataset

Public / Constants

FirstField


public constant FirstField → (DatasetInfoField.Name:DatasetInfoField)

The first well-known dataset info field.

LastField


public constant LastField → (DatasetInfoField.Remarks:DatasetInfoField)

The last well-known dataset info field.

Public / Constructors

DatasetInfo

2 overloads


public constructor DatasetInfo1 → ()

Creates a new instance of DatasetInfo.


public constructor DatasetInfo2 → (1)

data in : IDatasetInfo

[not-null]
The info object to copy from.

Creates a new instance of DatasetInfo.

Get


[Pure]
public static method Get → (1)

info opt : IDatasetInfo = null

The other info object.

returns → DatasetInfo

The modifiable info object.

Returns a modifiable DatasetInfo object from the given object.

Public / Methods

GetFieldName


[Pure]
public static method GetFieldName → (1)

field in : DatasetInfoField

The field.

returns → string

The field name.

Returns the name of a dataset info field.

SetField

2 overloads


public method SetField1 → (2)

field in : string

[not-empty]
The field name.

value in : string

The field value.

returns → DatasetInfo

this

Sets a dataset info field.


public method SetField2 → (2)

field in : DatasetInfoField

The field.

value in : string

The field value.

returns → DatasetInfo

this

Sets a dataset info field.

Update


public method Update → (1)

info in : IDatasetInfo

The other metadata to copy from or null.

returns → DatasetInfo

this

Updates the fields in this heightmap metadata object.

Configuration

Config


public static attribute Config → (get)

value : IConfigurator<IDatasetInfo>

[not-null]
The configurator object.

The configurator object for this type.

Serialization

SerialId


public static readonly attribute SerialId → (ISerialTypeInfo)

Serialization information about this type.