cBaseShapeManager Class

Base class for a Shape Manager. Provides implementation to make a derived Shape Manager behave like a List (For Each).

Inheritance Hierarchy

SystemObject
  EwECorecBaseShapeManager
    EwECorecEnviroResponseShapeManager
    EwECorecFishingBaseShapeManager
    EwECorecForcingFunctionShapeManager
    EwECorecLandingsMediationShapeManager
    EwECorecMediationShapeManager

Namespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)

Syntax

Copy

public abstract class cBaseShapeManager : IEnumerable, 
	ICoreInterface, IDisposable

Public MustInherit Class cBaseShapeManager
	Implements IEnumerable, ICoreInterface, IDisposable

[<AbstractClassAttribute>]
type cBaseShapeManager =  
    class
        interface IEnumerable
        interface ICoreInterface
        interface IDisposable
    end

The cBaseShapeManager type exposes the following members.

Properties

	Name	Description
	Core
	CoreComponent
	CoreItem	Use a Core one based index to retrieve an item
	Count	Number of Items(shapes) in this Shape Manager
	DataType
	DBID
	Index
	Item	Get a shape from the manager.
	Name
	NPoints	Number of points in the data for this type of shape. This is specific to a ShapeManger implementation.

Top

Methods

	Name	Description
	Add	Add a shape to the manager
	Contains	Does this ShapeManager contain this cForcingFunction
	CreateNewShape(String, Single, Int64, Single)	Shapes can not be created outside the Shape Manager; they must be created by a ShapeManager.
	CreateNewShape(String, Single, Single, Single, Single, Single, Int64)	Obsolete. Shapes can not be created outside the Shape Manager; they must be created by a ShapeManager.
	Dispose	Releases all resources used by the cBaseShapeManager
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Implementation of IEnumerable.GetEnumerator provides access to the For Each statment
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetID
	getShapeForEcoSimArrayIndex	Convert an array index from the underlying data in EcoSim into the Forcing function that is stored in the list
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Load	Load the existing shape with the underlying Ecosim data
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Remove a shape from the Manager and the underlying EcoSim Data
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Populate the underlying EcoSim data structures with the forcing function data
	UpdateIDs

Top

Fields

	Name	Description
	m_core	Reference to the core.
	m_DataType	Type of shape this manager operates on.
	m_shapes	List of shapes owned by this manager.
	m_SimData	underlying EcoSim data

Top

Extension Methods

	Name	Description
	Value	Extension method; extract a value from an object by property name. (Defined by Extensions.)

Top

Remarks

This provides For Each functionality to a Shape Manager by implementing the IEnumerable.GetEnumerator() interface. Behaviour specific to a Shape Manager must be implemented in a derived class.

Reference

EwECore Namespace