Click or drag to resize

cEcospaceLayer Class

Base class for providing cell-based interaction with Ecospace data.
Inheritance Hierarchy

Namespace:  EwECore
Assembly:  EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
Syntax
public abstract class cEcospaceLayer : cCoreInputOutputBase

The cEcospaceLayer type exposes the following members.

Constructors
  NameDescription
Protected methodcEcospaceLayer(cCore, Object, String, Type, cVariableMetaData, eVarNameFlags)
Constructor for defining a layer that is connected directly to its data.
Protected methodcEcospaceLayer(cCore, Int32, IEcospaceLayerManager, String, eVarNameFlags, Int32, Type)
Constructor for definining a layer that dynamically obtains its data.
Top
Properties
  NameDescription
Public propertyCanDeactivate
Get whether this layer can be deactivated.
Public propertyCell
Get/set the value of a cell.
Public propertyCoreComponent
Get the core component type that this object belongs to. Component types are useful for determining the level of impact that objects have on the EwE computing model.
(Inherited from cCoreInputOutputBase.)
Protected propertyData
Public propertyDataType
Get the data type uniquely identifying the type of core data that this class implements.
(Inherited from cCoreInputOutputBase.)
Public propertyDBID
Returns the persistent unique database ID for an ICoreInputOutput.
(Inherited from cCoreInputOutputBase.)
Public propertyDefault
Get the defaulkt value for the layer.
Public propertyDescription
Public propertyDisposed (Inherited from cCoreInputOutputBase.)
Public propertyIndex
Get/set the one-based index of a cCoreInputOutputBase instance in the list that it is contained in.
(Inherited from cCoreInputOutputBase.)
Public propertyIsActive
Get/set if the layer is active. This can have different meanings for different layers
Public propertyIsExternalData
Get if layer is receiving data from an external source.
Public propertyManager
Get the manager responsible for this layer.
Public propertyMaxValue
Get the maximum value in a layer.
Public propertyMetadataCell
Get/set the metadata associated with the values for a cell.
Public propertyMinValue
Get the minimum value in a layer.
Public propertyName
Get/set the name of a core object. Every ICoreInterface derived instance in EwE6 has a name.
(Inherited from cCoreInputOutputBase.)
Public propertyNumValueCells
Get the number of value cells in the layer.
Public propertyRemark
Get/set a remark.
(Inherited from cCoreInputOutputBase.)
Public propertySecundaryIndex
Secundary index for layers that contain, for instance, monthly data.
Public propertySecundaryIndexCounter
Secundary index type for layers that contain, for instance, monthly data.
Public propertyUnits (Inherited from cCoreInputOutputBase.)
Public propertyValidationStatus
Get the outcome of the most recently performed variable validation attempt on a cCoreInutOutputBase instance.
(Inherited from cCoreInputOutputBase.)
Public propertyValueDescriptor
Returns the Value descriptor for a given variable name, associated with this object.
(Inherited from cCoreInputOutputBase.)
Public propertyValueType
Get the type of layer values.
Public propertyVarName
Get the eVarNameFlags for the variable of this layers' data
Top
Methods
  NameDescription
Public methodClear (Inherited from cCoreInputOutputBase.)
Protected methodDefaultName
Public methodDispose
Destroy an instance.
(Inherited from cCoreInputOutputBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetID
Returns the unique ID for this object as a text string.
(Inherited from cCoreInputOutputBase.)
Public methodGetStatus
Returns the status of a variable in this object.
(Inherited from cCoreInputOutputBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVariable
Overridden to make sure there is always a name returned for a layer.
(Overrides cCoreInputOutputBaseGetVariable(eVarNameFlags, Int32, Int32, Int32).)
Public methodGetVariableMetadata
Return metadata associated with a variable. If the local instance does not have metadata associated the central metadata repository is consulted.
(Inherited from cCoreInputOutputBase.)
Public methodInvalidate
Invalidates the content of a layer.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReset
Reset the layer content to its Default value
Protected methodSetStatus
Replaces current status flags for a given variable with a new set of status flags.
(Inherited from cCoreInputOutputBase.)
Public methodSetVariable (Overrides cCoreInputOutputBaseSetVariable(eVarNameFlags, Object, Int32, Int32).)
Public methodToString (Overrides ObjectToString.)
Protected methodValidateCellPosition
Protected methodValidateCellValue
Top
Fields
  NameDescription
Protected fieldm_bInvalidateStats
States whether cached statistics should be recalculated.
Protected fieldm_bReadOnly
States whether an object will allow its values to be modified via SetVariable.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_bValidate
States whether Variable validation is enabled for this object.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_ccSecundaryIndex
Protected fieldm_core
Reference to the EwE Core that exposes the object.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_coreComponent
The EwE core component that this object belongs to
(Inherited from cCoreInputOutputBase.)
Protected fieldm_data
If set, a hard-linked reference to an array.
Protected fieldm_dataType
Container for the data type describing the object.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_iSecundaryIndex
Protected fieldm_manager
Manager delivering the data, if any.
Protected fieldm_metadata
Metadata to restrict values that can enter a layer.
Protected fieldm_typeValue
Type of the data.
Protected fieldm_ValidationStatus
Container for the Validation status of the object.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_vnData
If set, this flag will direct the manager how to get to the actual map data.
Top
Extension Methods
  NameDescription
Public Extension MethodValue
Extension method; extract a value from an object by property name.
(Defined by Extensions.)
Top
Remarks

This class can be used in two ways:

  • In conjunction with a manager, who will link this layer to the actual data
  • Directly linked to a data array holding the data. In that case the manager is obsolete.

See Also