class ShapeReader in Tinman.Terrain.Shapes

Abstract base class for IShapeReader implementations.

abstract class	ShapeReader	extends	Disposable
		implements	IShapeReader

Public / Attributes

HasFinished

Has the shape reader finished (i.e. all shapes have been read)?

public abstract property	HasFinished { get }
type	bool
value		true if all shapes have been read, false if not.
implements	IShapeReader.HasFinished

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Constructors

Read

Reads shapes from the given file.

[OwnerReturn]
public static method	Read (string path, ReadShapeFlags flags = ReadShapeFlags.Geo)
type	IShapeReader
params	path	[not-null]	The file path.
	flags		Optional shape read flags. Defaults to Geo.
returns		[not-null]	The shape reader.

---

Reads shapes from the given file.

[OwnerReturn]
public static method	Read (Path file, ReadShapeFlags flags = ReadShapeFlags.Geo)
type	IShapeReader
params	file	[not-null]	The file path.
	flags		Optional shape read flags. Defaults to Geo.
returns		[not-null]	The shape reader.

---

Reads shapes from the given file.

[OwnerReturn]
public static method	Read (IFileData data, ReadShapeFlags flags = ReadShapeFlags.Geo)
type	IShapeReader
params	data	[not-null]	The file data.
	flags		Optional shape read flags. Defaults to Geo.
returns		[not-null]	The shape reader.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

ReadShape

Reads the next shape.

public abstract method	ReadShape ()
type	IShape
returns			The shape or null if the reader has already finished.
implements	IShapeReader.ReadShape

Validate

Validates the state of this object.

public method	Validate (Validator validator)
params	validator	[not-null]	The validator object.
implements	IValidatable.Validate

Protected / Attributes

validator

The validator object can be used by subclasses to report errors while reading images.

protected field	validator
type	Validator

Protected / Constructors

ShapeReader

protected constructor

ShapeReader ()

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.