Click or drag to resize

cEcospaceBasemap Class

The heart of the Ecospace map interfaces. The basemap manages all foundation Ecospace map layers.
Inheritance Hierarchy

Namespace:  EwECore
Assembly:  EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
Syntax
public class cEcospaceBasemap : cCoreInputOutputBase, 
	IEcospaceLayerManager

The cEcospaceBasemap type exposes the following members.

Constructors
  NameDescription
Public methodcEcospaceBasemap
Initializes a new instance of the cEcospaceBasemap class
Top
Properties
  NameDescription
Public propertyAssumeSquareCells

Get/set whether to assume square cells without latitude tapering correction. Square cells can be assumed on relatively small areas in UTM projections.

As an additional bonus Ecospace assumes meters as map units when this flag is set; if this flag is cleared map units are expected to be decimal degrees.

Public propertyCellLength
Get/set the CellLength value for this scenario in kilometers.
Public propertyCellSize
Get/set the CellLength value for this scenario in map units. The value returned here depends on the setting of the AssumeSquareCells flag. If set to false, Ecospace returns the cell size in decimal degrees. If set to true, Ecospace returns the cell size in meters.
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.)
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 propertyDisposed (Inherited from cCoreInputOutputBase.)
Public propertyInCol
Get/set the nCols value for this scenario
Public propertyIndex
Get/set the one-based index of a cCoreInputOutputBase instance in the list that it is contained in.
(Inherited from cCoreInputOutputBase.)
Public propertyInRow
Get/set the nRows value for this scenario
Public propertyLatitude
Get/set the TopLeft latitude value for the map.
Public propertyLayerAdvection
Get the Advection layers in Ecospace.
Public propertyLayerDepth
Get the Ecospace Depth layer.
Public propertyLayerDriver
Returns an external driver layer
Public propertyLayerExclusion
Get the Ecospace exclusion layer.
Public propertyLayerHabitat
Get the Ecospace Habitat layer.
Public propertyLayerHabitatCapacity
Get the computed habitat foraging capacity layer
Public propertyLayerHabitatCapacityInput
Get the habitat foraging capacity input layer (prior)
Public propertyLayerImportance
Returns a LayerImportance
Public propertyLayerMigration
Get the migration layer for a given group.
Public propertyLayerMPA
Get the Ecospace MPA layer.
Public propertyLayerMPASeed
Public propertyLayerOtherMortality
Get the computed other mortality layer
Public propertyLayerOtherMortalityInput
Get the other mortality input layer (prior)
Public propertyLayerPort
Get the Ecospace port layer for a given fleet.
Public propertyLayerRegion
Get the Ecospace Region layer.
Public propertyLayerRelCin
Public propertyLayerRelPP
Get the Relative Primary Production layer in Ecospace.
Public propertyLayerSailingCost
Get the Ecospace sailing cost layer for a given fleet.
Public propertyLayerUpwelling
Get the flow layer in Ecospace for the current month.
Public propertyLayerWind
Get the Ecospace wind layers.
Public propertyLongitude
Get/set the TopLeft longitude value for the map.
Public propertyName
Get/set the name of a core object. Every ICoreInterface derived instance in EwE6 has a name.
(Inherited from cCoreInputOutputBase.)
Public propertyPosBottomRight
Get/set the bottom-right (SE) extent of the map, expressed in degrees (lon, lat)
Public propertyPosTopLeft
Get/set the top-left (NW) extent of the map, expressed in degrees (lon, lat)
Public propertyProjectionString

Get/set the Proj4 string for the Ecospace map.

Public propertyRemark
Get/set a remark.
(Inherited from cCoreInputOutputBase.)
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.)
Top
Methods
  NameDescription
Public methodClear (Inherited from cCoreInputOutputBase.)
Public methodColToLon
Returns the top-left longitude position of the given row.
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 (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 methodIsModelledCell
Returns whether a cell is modelled for Ecosystem dynamics.
Public methodIsValidCellPosition
Returns whether an intended cell index falls within the map bounds.
Public methodLatToRow
Returns the one-based index of the row that contains a given latitude value.
Public methodLayer
Protected methodLayerData
Public methodLayers
Public methodLonToCol
Returns the one-based index of the column that contains a given longitude value.
Public methodMapUnits
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRowToLat
Returns the top-left latitude position of the given row.
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 methodToCellLength
Public methodToCellSize
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
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_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_dataType
Container for the data type describing the object.
(Inherited from cCoreInputOutputBase.)
Protected fieldm_ValidationStatus
Container for the Validation status of the object.
(Inherited from cCoreInputOutputBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodValue
Extension method; extract a value from an object by property name.
(Defined by Extensions.)
Top
See Also