cCore Class |
Class to handle all interactions between a user interface layer, a
data source and the
EcoPath, EcoSim
and EcoSpace models.
Inheritance HierarchyNamespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe cCore type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ActiveEcosimScenarioIndex |
Gets the index of the active Ecosim scenario.
If no scenario is loaded, a value < 1 will be returned.
|
| ActiveEcospaceScenarioIndex |
Gets the index of the active Ecospace scenario.
|
| ActiveEcotracerScenarioIndex |
Gets the index of the active Ecotracer scenario.
|
| ActiveTimeSeriesDatasetIndex |
Gets the one-based index of the active TimeSeries Dataset.
If no time series are loaded, a value < 1 is returned.
|
| AdvectionManager | |
| Autosave |
Get/set whether a auto-save capable component
is allowed to auto-save.
|
| AuxillaryDataString |
Helper method; looks up - or creates when non-existing - an
AuxillaryData instance for a value.
|
| AuxillaryDatacValueID |
Get/set anAuxillaryData instance
for a given value ID.
|
| AuxillaryDatacCoreInputOutputBase, Boolean |
Get all auxillary data that related to a given core object.
|
| AuxillaryDataeDataTypes, Int32, Boolean |
Get all auxillary data that related to a given object.
|
| BackupFileMask | |
| CapacityMapInteractionManager | |
| DataSource |
The data source that the core will use
for reading and writing model data.
|
| DefaultAuthor |
Get/set the default author name to use for EwE.
|
| DefaultContact |
Get/set the default author contact information to use for EwE.
|
| DefaultOutputPath |
Get the default output location for a given autosaving component.
|
| EcoFunction |
Get the single cEcoFunctions instance.
|
| EcopathDataStructures | |
| EcopathFleetInputs | |
| EcoPathFleetOutputs | |
| EcoPathGroupInputs |
Basic Inputs for EcoPath for a single group
|
| EcoPathGroupOutputs |
Retrieves the EcoPath estimated parameters for the last run parameter estimation for this iGroup
by creating a new EcoPathGroupOutputs object that is populated with the estimated parameters.
|
| EcopathStats |
Statistics from the last Ecopath model run
|
| EcosimArenaManager | |
| EcosimEnviroResponseManager | |
| EcosimFitToTimeSeries |
Get the Ecosim Fit to Time Series manager.
|
| EcosimFleetInputs |
Ecosim Fleet inputs.
|
| EcosimFleetOutput |
Ecosim Fleet summary results from last Ecosim run.
|
| EcoSimGroupInputs |
Get a Ecosim input group for a given group index.
|
| EcoSimGroupOutputs |
Get a Ecosim output group for a given group index.
|
| EcoSimModelParameters |
Get the Ecosim model parameters for
the currently loaded Ecosim scenario.
|
| EcosimMonteCarlo |
Get the EcosimMonte Carlo manager.
|
| EcosimScenarioCount | Obsolete. |
| EcosimScenarios |
Get an Ecosim scenario from the available scenarios.
|
| EcosimStats |
Statistics from the last Ecosim model run
|
| EcospaceBasemap |
Get the Ecospace base map for the
currently loaded Ecospace scenario.
|
| EcospaceFleetInputs |
Get a Ecospace fleet for a given index.
|
| EcospaceFleetOutput |
Ecospace Fleet summary results from last Ecospace run.
|
| EcospaceFleets | Obsolete. |
| EcospaceGroupInputs |
Get a Ecospace group for a given index.
|
| EcospaceGroupOutput |
Results from last Ecospace run by group
|
| EcospaceGroups | Obsolete. |
| EcospaceHabitats |
Get a Ecospace habitat for a given index.
|
| EcospaceModelParameters |
Get the Ecospace model parameters
for the currently loaded Ecospace scenario.
|
| EcospaceMPAs |
Get a Ecospace MPA for a given index.
|
| EcospacePaused | |
| EcospaceRegionOutput |
Ecospace region summary results from last Ecospace run.
|
| EcospaceScenarioCount | Obsolete. |
| EcospaceScenarios |
Get an Ecospace scenario from the available scenarios.
|
| EcospaceStats |
Statistics from the last Ecospace model run
|
| EcospaceTimeSeriesManager | |
| EcotracerGroupInputs |
Get an Ecotracer group input.
|
| EcotracerGroupResults | |
| EcotracerModelParameters |
Get the model parameters object for the current loaded Ecotracer scenario.
|
| EcotracerRegionGroupResults | |
| EcotracerScenarioCount | Obsolete. |
| EcotracerScenarios |
Get an Ecotracer scenario.
|
| EggProdShapeManager | |
| EnviroResponseShapeManager | |
| EwEModel |
Returns the EwE model for the current loaded data source.
|
| FishingEffortShapeManager | |
| FishingPolicyManager | |
| FishMortShapeManager | |
| FleetInputs | Obsolete. |
| ForcingShapeManager | |
| GameManager | |
| LandingsShapeManager | |
| MediatedInteractionManager | |
| MediationShapeManager | |
| Messages |
Exposes the MessagePublisher instance so that an interface can add message handlers to the message publisher
|
| MPAOptimizationManager | |
| MSEBatchManager | |
| MSEManager | |
| MSYManager | |
| nAgeSteps | |
| nCapacityMaps |
Get the number of capacity maps
.
|
| nDetritusGroups |
Number of detritus groups across all models.
|
| nEcosimScenarios |
Returns the number of Ecosim scenarios in the currently loaded model
|
| nEcosimTimeSteps |
Number of time steps in an Ecosim run.
|
| nEcosimYears |
Number of years to run an Ecosim model.
|
| nEcospaceResultWriters | |
| nEcospaceScenarios |
Gets the number of available Ecospace scenarios for the loaded model.
|
| nEcospaceTimeSteps |
Number time steps in an Ecospace model.
|
| nEcospaceYears |
Number of years to run an Ecospace model.
|
| nEcotracerScenarios |
Get the number of available Ecotracer scenarios in the current loaded
model.
|
| nEnvironmentalDriverLayers |
Number of Ecospace environmental driver layers.
|
| nEnvironmentalLayers | Obsolete. |
| nFleets |
Number of fishing fleets across all models.
|
| nGroups |
Total number of groups across all models.
|
| nHabitats |
Number of Ecospace habitats.
|
| nImportanceLayers |
Number of Ecospace Importance layers.
|
| nLivingGroups |
Number of living groups across all models.
|
| nMaxStanza |
Max number of groups in a single stanza configuration over all stanza groups.
|
| nMPAs |
Number of Ecospace MPAs.
|
| nPedigreeVariables |
Get the number of pedigree variables.
|
| nRegions |
Number of Ecospace regions.
|
| nStanzas |
Number of stanza configurations.
|
| nTaxon |
Get the number of taxonomy groups.
|
| nTimeSeries |
Number of available time series.
|
| nTimeSeriesDatasets | |
| nTimeSeriesEnabled |
Number of applied time series.
|
| nTimeSeriesYears |
Number of applied time series.
|
| nWeightClasses | |
| OutputPath |
Get/set the path for core processes to write output information to.
|
| ParticleSizeDistributionParameters |
Returns the EwE model for the current loaded data source.
|
| PluginManager |
Get/set the Plug-in manager that the core must use
for accessing plug-ins.
|
| SaveWithFileHeader |
Flag, stating whether results should be saved with header
information.
|
| SearchObjective | |
| SpatialDataConnectionManager | |
| SpatialOperationLog | |
| StanzaGroups |
Return a stanza group from the core.
|
| StartBiomass |
Start biomass of each group
|
| StateManager |
Returns the state manager that
provides methods to bring the core execution state up-to-date.
|
| StateMonitor |
Returns the state monitor that
reflects the running state and data state of this core instance.
|
| Taxon |
Get a taxon for a given index.
|
 | Version |
Get the Core assembly version, formatted as a string.
|
Methods| Name | Description | |
|---|---|---|
 | AbsoluteTimeToEcospaceTimestep |
Convert an absolute time to an Ecospace time step.
|
| AddEcospaceDriverLayer |
Add a driver layer to the current
data source.
|
| AddEcospaceHabitat |
Add an Ecospace habitat to the current
data source.
|
| AddEcospaceImportanceLayer |
Add an Ecospace importance layer
to the current data source.
|
| AddEcospaceMPA |
Add an Ecospace MPA to the current
data source.
|
| AddEcospaceTimeStepHandler | |
| AddFleet |
Add a Fleet to the system.
|
| AddGroup |
Add a Group
|
| AddPedigreeLevel |
Add a pedigree level to a loaded EwE model.
|
| AddStanzaLifestage |
Add a group to a stanza configuration as a life stage.
|
| AddTaxon |
Add a taxonomy definition to an Ecopath group.
|
| AddTimeSeries(String, Int32, eTimeSeriesType, Single, Single, Int32) | Obsolete.
Add an Ecosim Time Series to the data source.
|
| AddTimeSeries(String, Int32, Int32, eTimeSeriesType, Single, Single, Int32) |
Add an Ecosim Time Series to the data source.
|
| AppendStanza |
Adds a stanza group to the data source.
|
| AppendTimeSeriesDataset |
Append a time series dataset to the core.
|
| CalcEcosimVulBo | |
| CalcEcosimVulFMax | |
| CalcEcospaceCostOfSailing |
Recalculate the Ecospace distance sailing cost map for all fleets.
|
| CanSave |
Checks if the underlying datasource can be saved.
|
| CanStopRun |
Check wether a means to stop any running process is in place.
|
| CheckExternalSpatialTemporalData |
Check whether the spatial/temporal data set-up is valid.
|
| CheckHabitats |
Has the capacity been set to a reasonable level for all groups.
|
| CheckMigrationMapsSet | |
| CheckResetDefaultVulnerabilities |
Check if Ecosim has non-default vulnerabilities, and if so, reset the
vulnerabilties.
|
| ClearEcospacePort |
Clear port cells for a given fleet.
|
| ClearExcludedCells |
Clear excluded cells.
|
| CloseEcosimScenario | |
| CloseEcospaceScenario | |
| CloseEcotracerScenario | |
| CloseModel |
Close the Ecopath model and terminate the core.
|
| DefaultFileHeader(eAutosaveTypes, Int32) |
Returns a default file header for text files for a given
auto-save type, representing loaded
aspects of ecopath, ecosim, ecospace and ecotracer, where applicable.
This header block can be integrated in CSV files.
|
| DefaultFileHeader(XmlDocument, eAutosaveTypes, Int32) |
Returns a default file header for XML files for a given
auto-save type, representing loaded
aspects of ecopath, ecosim, ecospace and ecotracer, where applicable.
This header block can be integrated in XML files.
|
| DiscardChanges |
Discard any unsaved data change flags.
|
| Dispose | Releases all resources used by the cCore |
| EcosimFirstYear |
Returns the start year for Ecosim
|
| EcosimOutputs |
Get outputs of the last Ecosim run
|
| EcosimTimeSeries |
Obtain a cTimeSeries-derived instance from the core.
|
| EcospaceTimestepToAbsoluteTime |
Convert an Ecospace time step to absolute time.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| EstimateVulnerabilities | |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetCoreCounter |
Returns the value the Core holds for a given eCoreCounterTypes enumerator. These
values are referred to as Core Counters.
|
| GetDataDescription | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetPedigreeManager |
Returns the pedigree manager for a given variable name.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasAppliedTimeSeries |
Helper method, states whether the model has time series applied.
|
| HasChanges |
Check whether the EwE data needs saving.
|
| HasTimeSeries |
Helper method, states whether the model has time series loaded.
|
| HasUnusedShapeData |
Returns whether Ecosim has unused shape data - shape data allocated by
earlier, longer Ecosim runs - that is currently not used. This data can
be trimmed via TrimUnusedShapeData.
|
| ImportEcosimTimeSeries |
Import one time series into the database.
|
| InvertExcludedCells |
Clear excluded cells.
|
| IsModelBalanced | |
| IsPedigreeVariableSupported |
States whether pedigree is supported for a given variable.
|
| LoadEcosimScenario(Int32) |
Load an Ecosim scenario from the current Data Source.
|
| LoadEcosimScenario(cEcoSimScenario) |
Load an Ecosim scenario from the current Data Source.
|
| LoadEcospaceScenario(Int32) |
Load an Ecospace scenario from the current Data Source.
|
| LoadEcospaceScenario(cEcospaceScenario) |
Load an Ecospace scenario from the current Data Source.
|
| LoadEcotracerScenario(Int32) |
Load an Ecotracer scenario
from the current Data Source.
|
| LoadEcotracerScenario(cEcotracerScenario) |
Load an Ecotracer scenario from the
current Data Source.
|
| LoadModel(String) |
Load the Ecopath model from a given file.
|
| LoadModel(IEwEDataSource) |
Load the Ecopath model from a given Datasource.
|
| LoadTimeSeries(Int32, Boolean) |
Load (and optionally apply) a single time series dataset
|
| LoadTimeSeries(cTimeSeriesDataset, Boolean) |
Load (and optionally apply) a single time series dataset
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveDriverLayer |
Move a cEcospaceLayerDriver to a new position in the EwE model.
|
| MoveEcospaceHabitat | |
| MoveEcospaceMPA | |
| MoveFleet | |
| MoveGroup |
Move a group to a new position in the EwE model.
|
| MovePedigreeLevel |
Move a pedigree level to a new location in the pedigree levels list.
|
| NewEcosimScenario |
Creates and loads a new Ecosim scenario.
|
| NewEcospaceScenario |
Creates and loads a new Ecospace scenario.
|
| NewEcotracerScenario |
Creates and loads a new Ecotracer scenario.
|
| NormalizeDietInput |
Normalize ecopath input values
|
| NormalizeQuotaShare |
Normalize MSE QuotaShare values
|
| NormalizeTaxonProportions | |
| onChanged |
Interface for non-cCoreInputOutputBase object to report changes to the core
|
| OnSettingsChanged |
Send out a notification that core settings have changed.
|
| PedigreeVariable |
Returns the variable at a given variable index.
|
| PedigreeVariableIndex |
Returns the index of a pedigree variable, or -1 if pedigree is not
supported for the variable.
|
| ReleaseBatchLock |
End a batch operation of additions and removals of Core objects.
Relevant data is reloaded and all locked messages will be sent to allow
listening user interfaces to catch up.
|
| RemoveEcosimScenario(Int32) |
Remove a Ecosim Scenario from the current Data Source.
|
| RemoveEcosimScenario(cCoreInputOutputBase) |
Remove a Ecosim Scenario from the current Data Source.
|
| RemoveEcospaceDriverLayer |
Remove a driver layer from the current
data source.
|
| RemoveEcospaceHabitat |
Remove an Ecospace habitat from the current
data source.
|
| RemoveEcospaceImportanceLayer |
Remove an Ecospace habitat from the current
data source.
|
| RemoveEcospaceMPA |
Remove an Ecospace MPA from the current
data source.
|
| RemoveEcospaceScenario(Int32) |
Remove a Ecospace Scenario from the current Data Source.
|
| RemoveEcospaceScenario(cCoreInputOutputBase) |
Remove a Ecospace Scenario from the current Data Source.
|
| RemoveEcospaceTimeStepHandler | |
| RemoveEcotracerScenario(Int32) |
Remove a Ecotracer Scenario from
the current Data Source.
|
| RemoveEcotracerScenario(cCoreInputOutputBase) |
Remove a Ecotracer Scenario from the current Data Source.
|
| RemoveFleet | |
| RemoveGroup |
Remove a group from the EwE model.
|
| RemovePedigreeLevel |
Remove an existing pedigree level.
|
| RemoveStanza |
Remove a stanza group from the data source.
|
| RemoveStanzaLifestage |
Remove a life stage from a stanza configuration.
|
| RemoveTaxon |
Remove a taxonomy definition from an Ecopath group.
|
| RemoveTimeSeries(Int32) |
Remove an Ecosim Time Series from the data source.
|
| RemoveTimeSeries(cTimeSeries) |
Remove an Ecosim Time Series from the data source.
|
| RemoveTimeSeriesDataset(Int32) | |
| RemoveTimeSeriesDataset(cTimeSeriesDataset) | |
| ResetMSEGroupRefLevels | |
| ResizeEcospaceBasemap |
Change the size of the Ecospace base map to a new number of rows and columns.
|
| RunEcoPath |
Run the EcoPath model.
|
| RunEcoPath(Boolean) |
Run the EcoPath model.
|
| RunEcoSim |
Launch an Ecosim run.
|
| RunEcoSpace |
Run the Ecospace model with the currently loaded Ecosim and Ecospace scenario
|
| SampleManager |
Returns the only instance of the cEcopathSampleManager.
|
| Save |
Save the data of all models.
|
| SaveChanges |
Public interface to save changes.
|
| SaveEcosimScenario |
Saves the current Ecosim scenario.
|
| SaveEcosimScenarioAs |
Saves the current ecosim scenario under a new name.
|
| SaveEcospaceScenario | |
| SaveEcospaceScenarioAs |
Save the current ecospace scenario under a new name.
|
| SaveEcotracerScenario |
Save the current Ecotracer scenario.
|
| SaveEcotracerScenarioAs |
Save the current ecotracer scenario under a new name.
|
| ScaleVulnerabilitiesToTL |
Ecosim scale vulnerabilities by trophic level.
|
| SetBatchLock |
Begin a batch operation of additions and removals of Core objects.
All messages will be locked while a batch operation is active.
|
| setDefaultCatchabilities | |
| SetDefaultMSERecruitment |
Set MSE QuotaShare values to default
|
| SetDefaultQuotaShare |
Set MSE QuotaShare values to default
|
| SetDefaultTFM | |
| SetEcospaceAllCoastToPort |
Set all coastal cells to ports for a given fleet.
|
| SetExcludedDepth |
Set all coastal cells to ports for a given fleet.
|
| SetFtimeFromGear | |
| SetMessagePumpDelegate |
Sets a delegate that a Manager can use to pump messages in the interface waiting for a process/thread to complete.
|
| SetStopRunDelegate |
Provide the delegate that the core can call to stop any running process.
|
| SetVToDefault | |
| StopEcoSim |
Stop a running EcoSim model
|
| StopEcospace |
Stop a running EcoSpace model.
|
| StopRun |
Stop any running process, if possible.
|
| TaxonAnalysis | |
| TimeSeriesDataset |
Obtain a time series dataset.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TrimUnusedShapeData |
Trim forcing functions to the Ecosim number of time steps. To determine
if there is unused shape data check HasUnusedShapeData.
|
| UpdateTimeSeries |
Apply all Time Series that are flagged as
Enabled to the Ecosim model.
|
Fields| Name | Description | |
|---|---|---|
 | m_EcoSpaceData | |
| MAX_AGE | The maximum age of a stanza life stage. |
| MAX_RUN_LENGTH | Max number of years ecosim or ecospace can run for |
| N_MONTHS | The number of months in a year. |
| NULL_VALUE | The NULL or 'no data' value for values maintained in the EwE Core. |
Extension Methods| Name | Description | |
|---|---|---|
 | Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |
RemarksThis class provides a wrapper for the underlying EcoPath, EcoSim and EcoSpace models.
The underlying model data structures have been converted into classes that an interface can program against. For instance, cEcopathFleetInput is the representation of a fishing fleet.
The EcopathFleetInputsInt32(iFleet) property provides a way for a user interface to interact with the underlying data structures that represent a fishing fleet without having to understand the modeling array structures.
Most conversions from interface objects (cEcopathFleetInput or cEcoSimResults) into model data structures are handled by the core.
Data structures for each model that need to be made public for setting of parameters or storing to file are held in a wrapper class for each model (cEcopathDataStructures or cEcosimDatastructures). These classes provide a thin wrapper, and a means to pass data back and forth between each other and a data source.
See Also