interface IDatasetInfo in Tinman.Terrain.Datasets

interface	IDatasetInfo	extends	IConfigurable
			IEquatable<IDatasetInfo>
		base of	DatasetInfo

Attributes

FieldNames

Returns the names of all fields that are present in this dataset info object.

property	FieldNames { get }
type	IVectorConst<string>
value	[not-null]	The list of field names.

Methods

Equals

Compares this object with the given one.

[Pure]
method	Equals (T other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	IEquatable.Equals

GetField

Returns a heightmap info field.

[Pure]
method	GetField (string field, string defaultValue = null)
type	string
params	field	[not-empty]	The field name.
	defaultValue		The value to return if the given field has no data or if no such field exists.
returns			The field value.

---

Returns a heightmap info field.

[Pure]
method	GetField (DatasetInfoField field, string defaultValue = null)
type	string
params	field		The field.
	defaultValue		The value to return if the given field has no data.
returns			The field value.

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.