class GeoObjectId in Tinman.Terrain.Georef

A unique identifier used to store an IGeoObject in a registry.

sealed class	GeoObjectId	implements	IComparable<GeoObjectId>
			IConfigurable
			IEquatable<GeoObjectId>
		extends	SerializableBase

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<GeoObjectId>
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 / Attributes

Authority

The authority that has defined the geo object.

public property	Authority { get }
type	GeoAuthority
value	[not-null]	The authority.

Code

The code tag (unique for object type).

public property	Code { get }
type	string
value	[not-null]	The code tag.

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

Type

The object type.

public property	Type { get }
type	GeoObjectType
value		The object type.

Public / Constructors

FromString

Creates a new instance of GeoObjectId from the given string representation.

public static method	FromString (string value)
type	GeoObjectId
params	value		The string representation.
returns			The GeoObjectId value or null if value is invalid.

GeoObjectId

Creates a new instance of GeoObjectId.

public constructor	GeoObjectId (GeoObjectType type, int32 code, GeoAuthority authority)
params	type		The object type.
	code		The code tag (unique for object type).
	authority	[not-null]	The geo authority.

---

Creates a new instance of GeoObjectId.

public constructor	GeoObjectId (GeoObjectType type, string code, GeoAuthority authority)
params	type		The object type.
	code	[not-null]	The code tag (unique for object type).
	authority	[not-null]	The geo authority.

Public / Methods

CompareTo

Compares this object with the given one.

[Pure]
public method	CompareTo (GeoObjectId other)
type	int32
params	other		The object to compare to.
returns			< 0 : if this object is less than other, = 0 : if this object is equal to other, > 0 : if this object is greater than other.
implements	IComparable.CompareTo

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 (GeoObjectId 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

---

Compares this object with the given one.

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

GetHashCode

[Pure]
public override method	GetHashCode ()
type	int32

Lookup

Tries to find the GeoObjectId for the given geo object in the current registry (see Current).

public static method	Lookup (IGeoObject value)
type	GeoObjectId
params	value		The geo object.
returns			The found GeoObjectId or null if not found.

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

ToString

[Pure]
public override method	ToString ()
type	string