cEcopathDataStructures Class |
Wrapper for the underlying data structures of the EcoPath model.
Provides a way to wrap all the data from EcoPath into one place
Inheritance HierarchyNamespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe cEcopathDataStructures type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | cEcopathDataStructures | Initializes a new instance of the cEcopathDataStructures class |
Properties| Name | Description | |
|---|---|---|
 | DiversityIndex |
Returns the computed diversity index that is selected in DiversityIndexType |
Methods| Name | Description | |
|---|---|---|
| areUnitCurrencyNutrients |
Returns whether Ecopath is set to use Nutrient-based currency units.
|
| Clear | |
| CopyInputToModelArrays |
Copy the Input arrays into the arrays that are used for modeling and model output.
|
| DietWasChanged | |
| 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.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| onPostEcopathRun |
Central handler for computing anything after an Ecopath model run.
|
| onPostInitialization |
Run any post initialization validation
|
| RedimEcosimScenarios | |
| RedimEcospaceScenarios | |
| RedimEcotracerScenarios | |
| RedimFleetVariables |
Redimension all fishing variables
|
| redimGroups |
Redim All variables that in EcoPath that have an NGroup dimension
|
| redimGroupVariables |
redimension array variables
called when a new model is loaded
|
| RedimPedigree | |
| SumDCToOne |
Sums a Diet Composition matrix to one.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | ActiveEcosimScenario | Index of active Ecosim scenario. |
| ActiveEcospaceScenario | Index of active Ecospace scenario. |
| ActiveEcotracerScenario | Index of active Ecotracer scenario. |
| Alpha | |
| Area | Area (NumGroups) |
| B | Biomass (computed) |
| BA | Biomass accumulation (t/km²/year) |
| BaBi | Biomass accumulation / biomass |
| BAInput | Biomass accumulation (t/km²/year) as entered by the user |
| BH | Biomass in habitat area (t/km²) |
| BHinput | Biomass habitat area (input value)- original user input of BH. |
| bInitialized | |
| Binput | Biomass (input value)- original user input of B. |
| BQB | |
| CatchCode | |
| CatchSum | Sum of catch. |
| Conn | Connectance Index. |
| Consum | |
| cost | cost(nFleets,3) '1 is fixed cost, 2 is cost per unit effort, 3 sailing cost |
| CostPct | |
| CVpar | |
| DC | |
| DCChanged | |
| DCDet | Diet Composition of Detritus for fishery. |
| DCInput | |
| det | Detritus flow (#groups + #fleet,#groups + #fleet) |
| DetEaten | |
| DetPassedOn | |
| DetPassedProp | |
| DF | |
| DietChanged | |
| DietsModified | Flag stating whether diets have been modified since the last time Ecopath has ran. |
| Discard | Discarded biomass by fleet group |
| DiscardFate | Fate of discards (by fleet, #detritus) |
| DiversityIndexType | |
| Dt | Total flow of detritus |
| DtImp | Detritus import (ratio) |
| EcosimScenarioAuthor | Array of Ecosim scenario authors. |
| EcosimScenarioContact | Array of Ecosim scenario contacts. |
| EcosimScenarioDBID | Array of Ecosim scenario database IDs. |
| EcosimScenarioDescription | Array of Ecosim scenario descriptions. |
| EcosimScenarioLastSaved | Array of Ecosim scenario save dates (in julian day format). |
| EcosimScenarioName | Array of Ecosim scenario names. |
| EcospaceScenarioAuthor | Array of Ecospace scenario authors. |
| EcospaceScenarioContact | Array of Ecospace scenario contacts. |
| EcospaceScenarioDBID | Array of Ecospace scenario database IDs. |
| EcospaceScenarioDescription | Array of Ecospace scenario descriptions. |
| EcospaceScenarioLastSaved | Array of Ecospace scenario save dates (in julian day format). |
| EcospaceScenarioName | Array of Ecospace scenario names. |
| EcotracerScenarioAuthor | Array of Ecotracer scenario authors. |
| EcotracerScenarioContact | Array of Ecotracer scenario contacts. |
| EcotracerScenarioDBID | Array of Ecotracer scenario database IDs. |
| EcotracerScenarioDescription | Array of Ecotracer scenario descriptions. |
| EcotracerScenarioLastSaved | Array of Ecotracer scenario save dates (in julian day format). |
| EcotracerScenarioName | Array of Ecotracer scenario names. |
| EE | Ecotrophic efficiency (ratio) |
| EEinput | Ecotrophic efficiency (ratio) - original user input value of EE. |
| Emig | Emigration (per group) relative to biomass (ratio) |
| Emigration | Emigration (per group) out of the area covered by the model (t/km²/year) |
| Ex | |
| fCatch | Sum (per NumGroups) of landings + discards. |
| FirstYear | |
| Fixed | |
| FleetColor | Colours for fleets in an interface (x fleet). |
| FleetName | Names of fleets. |
| FlowToDet | Flow to detritus (x (group + fleet)). |
| GE | Production / consumption (ratio) |
| GEff | Gross efficiency. |
| GEinput | Production / consumption (ratio) - original user input of GE. |
| GroupColor | Colours for groups in an interface (x group). |
| GroupIsFish | States which groups are fishes. There is no interface in EwE for this flag, and its function should be replaced by the taxonomy logic |
| GroupIsInvert | States which groups are invertebrates. There is no interface in EwE for this flag, and its function should be replaced by the taxonomy logic |
| GroupName | Group names. |
| GS | Unassimilation / consumption (ratio) |
| GSEng | Unassimilation / consumption (ratio) for Energy Currency units ONLY |
| Hlap | |
| Host | |
| Immig | Migration into the area covered by the model (t/km²/year) |
| InputToDet | Input to detritus (x group). |
| isEcospaceModelCoupled |
Is the currently loaded Ecospace model setup for coupling with an external model.
|
| isGroupLeadingB | |
| isGroupLeadingCB | |
| KemptonsQ | |
| Landing | Landinged biomass (by fleet,group) |
| LandingValue | |
| LastComp | |
| M0 | |
| M2 | |
| Market | Market value of landings (by fleet,group) |
| mis |
Number of missing variables per groups
|
| ModelArea | |
| ModelAuthor | |
| ModelContact | |
| ModelCountry | |
| ModelDBID | |
| ModelDescription | |
| ModelEast | |
| ModelEcobaseCode | Code of a model in the Ecobase repository, if any. |
| ModelEcosystemType | |
| ModelGroupDigits | |
| ModelLastSaved | |
| ModelName | |
| ModelNorth | |
| ModelNumDigits | |
| ModelPublicationDOI | |
| ModelPublicationRef | |
| ModelPublicationURI | |
| ModelSouth | |
| ModelUnitArea | |
| ModelUnitAreaCustom | |
| ModelUnitCurrency | Index of current selected currency units. |
| ModelUnitCurrencyCustom | |
| ModelUnitMonetary | |
| ModelUnitTime | |
| ModelUnitTimeCustom | |
| ModelWest | |
| NoGearData | |
| NumCatchCodes | |
| NumDetrit | Total number of detritus groups. |
| NumEcosimScenarios | Number of Ecosim scenarios available in a loaded model. |
| NumEcospaceScenarios | Number of Ecospace scenarios available in a loaded model. |
| NumEcotracerScenarios | Number of Ecotracer scenarios available in a loaded model. |
| NumFleet | Total number of fleets. |
| NumGroups | Total number of groups (living and detritus) |
| NumLiving | Total number of living groups. |
| NumPedigreeLevels | |
| NumPedigreeVariables | Number of PedigreeVariables |
| NumYears | |
| OtherMortinput | Other mortaility (ratio) - defined as 1-EE. |
| Path | |
| PB | Production / biomass (/year) |
| PBinput | Production / biomass (/year) - original user input of PB. |
| Pedigree | Array [#groups, #supported vars] = Level index. |
| PedigreeLevelColor | |
| PedigreeLevelConfidence | Confidence interval expressed in rounded percentages |
| PedigreeLevelDBID | |
| PedigreeLevelDescription | |
| PedigreeLevelEstimated | |
| PedigreeLevelIndexValue | Index value expressed in ratio [0, 1] |
| PedigreeLevelName | |
| PedigreeLevelVarName | |
| PedigreeStatsModel | |
| PedigreeStatsTStar | |
 | PedigreeVariables | One-based array of variables supported by the pedigree system. |
| Plap | |
| PP | |
| PProd | |
| PropDiscard | Proportion of total catch that are discards (by fleet, group) |
| PropDiscardMort | Proportion of regulated discards that die (by fleet, group) |
| PropLanded | |
| QB | Consumption / biomass (/year) |
| QBinput | Consumption / biomass (/year) - original user input of QB. |
| Resp | All non-usable 'model currency' that leaves the box represented by a group. |
| RTZ | |
| Shadow | |
| ShadowValue | |
| Shannon | |
| StanzaGroup | |
| SumBio | |
| SumEx | Sum of exports. |
| SumP | Sum of all production. |
| SumR | |
| SysOm | |
| TimeUnitIndex | Index of current selected time unit. |
| TimeUnitName | User-provided name for time units. |
| TLcatch | Tropic level of the catch. |
| Totpp | |
| TTLX | Trophic levels in Ecopath. |
| Variab | |
| vbK | VBGF curvature parameter K (/year). |
Extension Methods| Name | Description | |
|---|---|---|
 | Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |
See Also