class DatasetInfo in Tinman.Terrain.Datasets

sealed class	DatasetInfo	implements	IDatasetInfo
			IVersioned
		extends	SerializableBase

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<IDatasetInfo>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	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.

Serialization

SerialId

Serialization information about this type.

public static readonly field	SerialId
type	ISerialTypeInfo

Public / Constants

FirstField

public constant	FirstField = DatasetInfoField.Name
type	DatasetInfoField

LastField

public constant	LastField = DatasetInfoField.Remarks
type	DatasetInfoField

Public / Attributes

FieldNames

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

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

SerialType

Returns the serial type of this object.

public property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Version

Returns the current version of object.

public property	Version { get }
type	int32
value		The current version number.
implements	IVersioned.Version

Remarks:

For each modification, the version is incremented by at least one.

Public / Constructors

DatasetInfo

Creates a new instance of DatasetInfo.

public constructor

DatasetInfo ()

---

Creates a new instance of DatasetInfo.

public constructor	DatasetInfo (IDatasetInfo data)
params	data	[not-null]	The info object to copy from.

Get

Returns a modifiable DatasetInfo object from the given object.

[Pure]
public static method	Get (IDatasetInfo info = null)
type	DatasetInfo
params	info		The other info object. Defaults to null.
returns		[not-null]	The modifiable info object.

Public / Methods

Deserialize

Initializes the state of this object from the given data stream.

public override method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides	SerializableBase.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Equals

Compares this object with the given one.

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

GetField

Returns a heightmap info field.

[Pure]
public 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.
implements	IDatasetInfo.GetField

---

Returns a heightmap info field.

[Pure]
public 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.
implements	IDatasetInfo.GetField

GetFieldName

Returns the name of a dataset info field.

[Pure]
public static method	GetFieldName (DatasetInfoField field)
type	string
params	field		The field.
returns		[not-empty]	The field name.

Serialize

Serializes the current state of this object to the given data stream.

public override method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
overrides	SerializableBase.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

SetField

Sets a dataset info field.

public method	SetField (string field, string value)
type	DatasetInfo
params	field	[not-empty]	The field name.
	value		The field value.
returns		[not-null]	this

---

Sets a dataset info field.

public method	SetField (DatasetInfoField field, string value)
type	DatasetInfo
params	field		The field.
	value		The field value.
returns		[not-null]	this

Update

Updates the fields in this heightmap metadata object.

public method	Update (IDatasetInfo info)
type	DatasetInfo
params	info		The other metadata to copy from or null.
returns		[not-null]	this