Click or drag to resize

EwECore Namespace

Namespace containing all elements essential to the functioning of the EwE computational engine.
Classes
  ClassDescription
Public classcBaseShapeManager
Base class for a Shape Manager. Provides implementation to make a derived Shape Manager behave like a List (For Each).
Public classcBetapdfShapeFunction
Public classcBiomassResultsDataSource
Implementation of cResultsDataSourceBase for biomass averaged over the total modeled area.
Public classcCatchResultsDataSource
Implementation of cResultsDataSourceBase for catch averaged over the total modeled area.
Public classcContaminantTracer
Contaminant tracing model.
Public classcContaminantTracerDataStructures
Public variables need by the contaminant tracing model.
Public classcCore
Class to handle all interactions between a user interface layer, a data source and the EcoPath, EcoSim and EcoSpace models.
Public classcCoreEnumNamesIndex
Helper class; creates and maintains quick lookup tables of string representations of enumerated types defined in the Core.
Public classcCoreGroupBase
Base implementation of a core group. This class serves as an base class for building dedicated group classes for the various EwE components.
Public classcCoreInputOutputBase
Base class implementation of the ICoreInterface, ICoreInputOutput interfaces.
Public classcCoreInputOutputListT
Strong-typed list that handles item index offset headaches transparently.
Public classcCoreStateManager
Manager class used to bring the core execution state up to date.
Public classcCoreStateMonitor
Monitor that distributes Core execution state change events and Core data state change events.
Public classcEcoFunctions
Class to provide access to functions needed both internally to the core and externally by plugins or other things.
Public classcEcopathDataStructures
Wrapper for the underlying data structures of the EcoPath model. Provides a way to wrap all the data from EcoPath into one place
Public classcEcopathFleetInput
Class to encapsulate a variables for a single Fishing Fleet Input
Public classcEcopathFleetOutput
Results from EcoPath for a single fleet.
Public classcEcoPathGroupInput
Inputs for EcoPath for a single group.
Public classcEcoPathGroupOutput
Results from EcoPath for a single group.
Public classcEcopathModelFromEcosim
Class to export an Ecosim time step to a new Ecopath model.
Public classcEcopathResultWriter
Writer to save Ecopath estimates to a CSV file.
Public classcEcoPathStats
Public classcEcosimArenaManager
Public classcEcosimArenaShare
Public classcEcosimDatastructures
This class wraps the underlying EcoSim data structures
Public classcEcosimEnviroInputData
Public classcEcosimEnviroResponseManager
Manager class to handle Ecosim Environmental Response functions
Public classcEcosimFleetInput
Public classcEcosimFleetOutput
Public classcEcoSimGroupInput
Inputs for EcoSim for a single group.
Public classcEcosimGroupOutput
Results from EcoSim for a single group.
Public classcEcoSimModelParameters
Contains the Model Run Parameters for EcoSim i.e. 'NumberYears' number of years to run the model for
Public classcEcosimMonteCarlo
Ecosim Monte Carlo routines
Public classcEcosimOutput
Public classcEcoSimResults
Results from the last completed EcoSim Time Step Passed out by EcoSim via the EcoSimTimeStepDelegate(iTime,Results) delegate
Public classcEcoSimScenario
Class to encapsulate scenario parameters for a single scenario in the cEcoSim Model
Public classcEcosimStats
Public classcEcoSpace
Public classcEcospaceASCBaseResultsWriter
Base Class for ASC Specific Writers that implement IEcospaceResultsWriter and cEcospaceBaseResultsWriter to write Ecospace output to ESRI ASCII files.
Public classcEcospaceASCMapBiomassWriter
Implementation of IEcospaceResultsWriter to write Ecospace biomass distributions maps to ESRI ASCII files.
Public classcEcospaceASCMapCapacityWriter
Implementation of IEcospaceResultsWriter to write Ecospace computed habitat capacity maps to ESRI ASCII files.
Public classcEcospaceASCMapCatchWriter
Implementation of IEcospaceResultsWriter to write Ecospace catch distributions maps to ESRI ASCII files.
Public classcEcospaceASCMapContaminants
Public classcEcospaceASCMapDiscardsWriter
Implementation of IEcospaceResultsWriter and cEcospaceBaseResultsWriter to write Ecospace output to ESRI ASCII files.
Public classcEcospaceASCMapEffortWriter
Implementation of IEcospaceResultsWriter to write Ecospace effort distributions maps to ESRI ASCII files.
Public classcEcospaceBasemap
The heart of the Ecospace map interfaces. The basemap manages all foundation Ecospace map layers.
Public classcEcospaceBaseResultsWriter
Base implementation of IEcospaceResultsWriter
Public classcEcospaceDataStructures
Public classcEcospaceEnviroResponseManager
Public classcEcospaceFleet Obsolete.
Public classcEcospaceFleetInput
Public classcEcospaceFleetOutput
Public classcEcospaceGroup Obsolete.
Public classcEcospaceGroupInput
Public classcEcospaceGroupOutput
Results, over all the time steps, at the end of an ecospace model run
Public classcEcospaceHabitat
Public classcEcospaceImportExportASCIIData
Helper class for importing and exporting data from ASCII grid files directly to and from Ecospace, without GIS intervention.
Public classcEcospaceImportExportRaster
Foundation raster class for importing and exporting external data without a true spatial engine.
Public classcEcospaceImportExportXYData
Helper class for importing and exporting XY data from text files.
Public classcEcospaceLayer
Base class for providing cell-based interaction with Ecospace data.
Public classcEcospaceLayerAdvection
Layer providing access to Ecospace advection data.
Public classcEcospaceLayerBiomassForcing
Layer providing access to Ecospace biomass forcing data.
Public classcEcospaceLayerBiomassRelativeForcing
Layer providing access to Ecospace biomass relative forcing data.
Public classcEcospaceLayerBoolean
Base layer providing access to Ecospace data as cells of Boolean values.
Public classcEcospaceLayerDepth
Layer providing access to Ecospace depth data.
Public classcEcospaceLayerDriver
Layer providing access to Ecospace external driving data.
Public classcEcospaceLayerExclusion
Layer providing access to Ecospace excluded cells.
Public classcEcospaceLayerHabitat
Layer providing access to Ecospace habitat data.
Public classcEcospaceLayerHabitatCapacity
Layer providing access to Ecospace habitat capacity data.
Public classcEcospaceLayerImportance
Layer providing access to Ecospace importance data.
Public classcEcospaceLayerInteger
Base layer providing access to Ecospace data as cells of integer values.
Public classcEcospaceLayerMigration
Layer providing access to Ecospace migration data.
Public classcEcospaceLayerMPA
Layer providing access to Ecospace migration data.
Public classcEcospaceLayerMPASeed
Layer providing access to Ecospace MPA seed data.
Public classcEcospaceLayerOtherMortality
Layer providing access to Ecospace other mortality data.
Public classcEcospaceLayerPort
Layer providing access to Ecospace port data.
Public classcEcospaceLayerRegion
Layer providing access to Ecospace region data.
Public classcEcospaceLayerRelCin
Layer providing access to Ecospace relative contaminants data.
Public classcEcospaceLayerRelPP
Layer providing access to Ecospace Primarey Production data.
Public classcEcospaceLayerSail
Layer providing access to Ecospace sailing cost data.
Public classcEcospaceLayerSingle
Base layer providing access to Ecospace data as cells of single values.
Public classcEcospaceLayerUpwelling
Layer providing access to Ecospace upwelling data.
Public classcEcospaceLayerWind
Layer providing access to Ecospace vector data.
Public classcEcospaceModelParameters
Public classcEcospaceMPA
The definition of a Marine Protected Area in Ecospace.
Public classcEcospaceRegionAvgResultsWriter
Implementation of IEcospaceResultsWriter and cEcospaceBaseResultsWriter to write Ecospace area averaged results to csv files. This class provides the framework for writting the file. The actual data is supplied by an implementation of cEcospaceResultsWriterDataSourceBase that supplies the data in a generic format.
Public classcEcospaceRegionOutput
Public classcEcospaceResultsWriterDataSourceBase
Base class for data source objects used by the cEcospaceAvgModelAreaResultsWriter to write averaged Ecospace results to a csv file.
Public classcEcospaceResultWriterFactory
Factory class for creating an IEcospaceResultsWriter
Public classcEcospaceScenario
Public classcEcospaceStats
Statistics for the last Ecospace run.
Public classcEcospaceTimestep
Results of the current Ecospace time step
Public classcEcospaceXYZTResultsWriter
Implementation of IEcospaceResultsWriter and cEcospaceBaseResultsWriter to save Ecospace results to a series of CSV files.
Public classcEcotracerGroupInput
Public classcEcotracerGroupOutput
Public classcEcotracerModelParameters
Public classcEcotracerRegionGroupOutput
Public classcEcotracerResultWriter
Ecostracer result writer.
Public classcEcotracerScenario
Public classcEggProductionShapeManager
Manager for the Egg Production Shapes
Public classcEIIDataSource
Data access for an EwE5 .EII file
Public classcEIIXMLDataSource
Data access for an EwE6 .eiixml file
Public classcENACellData
Public classcENARDataStructures
Public classcEnviroInputMap
Joins an input map(row,col) with a list(by group) of Environmental Response functions (mediation functions).
Public classcEnviroResponseFunction
Public classcEnviroResponseShapeManager
Implemenation of the Base class for capacity shapes
Public classcEqualTo
Public classcEwEModel
Class to encapsulate and expose ecopath model for a single model
Public classcEwEScenario
Public classcExponentialShapeFunction
Public classcF2TSDataStructures
Public classcF2TSManager
Public classcFeedbackMessage
A feedback message is the only vehicle for the EwE Core to prompt a user interface for feedback.
Public classcFishingBaseShapeManager
Public classcFishingEffortShapeManger
Public classcFishingMortalityShapeManger
Public classcFishingMortShape
A fishing mortality shape.
Public classcFishingPolicyParameters
Public classcFishingPolicySearchBlock
Blocks for Fishing Policy Search
Public classcFishingRateShape
A fish s
Public classcFleetInput Obsolete.
Public classcFleetTimeSeries
Data for one time series contained in an Ecosim scenario.
Public classcForcingFunction
Provides access to Forcing and EggProduction shapes, and a base class for Mediation functions.
Public classcForcingFunctionShapeManager
Extents the base class to manage the Forcing Shapes
Public classcFreehandShapeFunction
A cShapeFunction which points are not defined through a primitive, but instead have been sketching in the EwE user interface or have been obtained by other means.
Public classcGameServerInterface
Core data collector for the OceanViz game server.
Public classcGreaterThan
Public classcGreaterThanOrEqualTo
Public classcGridSolver
Public classcGroupShapeList
This is a collection of cShapeGroupPair
Public classcGroupShapePair
This object represents the iStanza Group (index of stanza group) and Egg Production Forcing Shape index that is used by this Stanza group
Public classcGroupTimeSeries
Data for one time series contained in an Ecosim scenario.
Public classcHyperbolicShapeFunction
Public classcIBMSolver
Public classcLandingsInteraction
Class to wrap the shape and function type modifiers for a price elasticity interaction
Public classcLandingsMediatingGroup
Mediation group for Price Elasticity. cPriceMediatingGroup "Is A" cMediatingGroup with a fleet index that tell you what Fleet to get the Landings from
Public classcLandingsMediationFunction
A derived mediation function, dedicated to modelling fleet-group interactions based on landings.
Public classcLandingsMediationShapeManager
Implemenation of the Base class for Mediation shapes
Public classcLeftShoulderShapeFunction
Public classcLessThan
Public classcLessThanOrEqualTo
Public classcLinearShapeFunction
Public classcLPSolver
LP solver interface to the unmanaged lp_solve engine version 5.5
Public classcLPSolverlpsolve55
LPSolve unmanaged library wrapper
Public classcMatrixCalc
Public classcMediatedInteraction
Class to wrap the shape and function type modifiers for a meditated interaction
Protected classcMediatedInteractioncShapeFunctionTypePair
Private class to hold the shape and function type for each possible modifier.
Public classcMediatedInteractionManager
Manages all mediated shape interactions.
Public classcMediatingFleet
Fleet and Weight of a Fleet that make up a Mediating Fleet for a Mediation function. There can be more then one cMediatingFleet for a Mediation Function
Public classcMediatingGroup
Group and Weight of a Group that make up a Mediating Group for a Mediation function. There can be more then one cMediatingGroup for a Mediation Function
Public classcMediationBaseFunction
Base Class for a mediation function. A mediation function "Is A" Forcing function that that contains Ecopath base values along it's X axis, Biomass, Effort or Catch depending on the implementation. The Y axis contains the value of the underlying shape entered by the user. The value of the Y axis is used to mediate/modify a Group biomass (for a Mediation function) or Group/Fleet price (for a Price Elasticity function) based on how the mediaton function is applied via the cPredPreyInteraction or cLandingsInteraction that "contain" the mediation function.
Public classcMediationDataStructures
Public classcMediationFunction
Mediation functions inherit their base functionality from cMediationBaseFunction which provide the underlying shape data and Ecopath base line properties. This implements loading and updating of the correct core data for this type of mediation function.
Public classcMediationShapeManager
Implemenation of the Base class for Mediation shapes
Public classcMessage
This class encapsulates a message that is passed from the Core to an Interface via the cMessagePublisher-cMessageHandler system
Public classcMessageHandler

This class is the message handler portion of the Message-Publisher/Message-Handler pattern use to pass messages from the core(publisher) to an interface(handler).

This pattern is based on the Subject/Observer or Publisher/Subscriber patterns. Basically the cMessageHandler provides a wrapper for a delegate in the interface that handles the message. This allows the interface to implement the actual message handling without having to expose its internal structure.

It also allows an interface to split the message handling into a series of smaller routines that only know how to handle one type of message.

Public classcMessagePublisher
This class provides a single interface for dealing with different types of messages. It uses a Publisher/Subscriber or Observer pattern
Public classcModelImporterFactory
Factory class; builds a EwE5 model importer.
Public classcMonteCarloGroup
Public classcMonteCarloManager
Manager to run the Ecosim Monte Carlo.
Public classcMonteCarloResultsWriterMultipleFiles
EwE 6.6 Monte Carlo result writer, using separate files for baseline, iterations, and Ecosim output.
Public classcMonteCarloResultsWriterOneFile
Pre-EwE6.6 result writer, writing all MC output to one single CSV file.
Public classcMPACell
MPA cell selected during a trial
Public classcMPAOptBaseClass
Public classcMPAOptDataStructures
Public classcMPAOptManager
Public classcMPAOptOutput
Results of the current search iteration
Public classcMPAOptParameters
Public classcMPARandomSearch
Public classcMSEBatchParameters
Public classcNormalShapeFunction
Public classcObjectiveResult
Public classcOperatorBase
Base class for equality comparison of values
Public classcOperatorManager
Manages the operators
Public classcPathUtility

Utility class for translating a path mask into a full path. The mask can be composed of valid path characters and place holders.

Place holder texts are expected to be wrapped in curly brackets, { }, and are not case-sensitive.

Public classcPedigreeLevel
Inputs for a single pedigree level within a pedigree category.
Public classcPedigreeManager
Class that contains and distributes pedigree levels, and maintains group pedigree assignments.
Public classcPredPreyInteraction
Class to wrap the shape and function type modifiers for a pred/prey interaction
Public classcProgressMessage
Public classcPSDDatastructures
This class wraps the underlying particle size distribution data structures
Public classcPSDModel
Public classcPSDParameters
This class wraps the underlying particle size distribution data structures
Public classcRegionBiomassResultsDataSource
Implementation of cResultsDataSourceBase for averaged biomass by region.
Public classcRegionCatchResultsDataSource
Implementation of cResultsDataSourceBase for averaged catch by region.
Public classcRightShoulderShapeFunction
Public classcRowCol
Public classcSCORFileWriter
Public classcSearchDatastructures
Data used by Search and Optimization routines
Public classcShapeData
Class to handle the data that makes up the shape of a forcing or mediation shape
Public classcShapeFunction
Base class for implementing EwE core shape functions.
Public classcShapeFunctionFactory
Factory for delivering shape functions that can be used to reshape a particular cForcingFunction. This class also takes shape functions delivered by plug-ins into account.
Public classcShoulderShapeFunction
Public classcSigmoidLegacyShapeFunction
Public classcSigmoidShapeFunction
Public classcSpaceSolver
Public classcStanzaDatastructures
Public classcStanzaGroup
Multi-stanza group
Public classcTaxon
Taxonomy definition that contributes to a functional group or stanza configuration.
Public classcTaxonAnalysis
Helper class to analyze taxonomy data.
Public classcTaxonDataStructures
Public classcTaxonSearchData
Container for transferring Taxonomy data
Public classcThreadWaitBase
Base Class to provide thread blocking for the Threaded Manager Classes
Public classcTimeSeries
Data for one time series contained in an Ecosim scenario.
Public classcTimeSeriesClipboardReader
Reads one or more time series from the clipboard.
Public classcTimeSeriesCSVReader
Reads one or more time series from a CSV file.
Public classcTimeSeriesCSVWriter
Write a time series dataset to a text output source.
Public classcTimeSeriesDataset
Public classcTimeSeriesDataStructures
Class that holds and manages all time series-related data in the EwE core.
Public classcTimeSeriesFactory
The one access point in EwE to create cTimeSeries -derived objects, and to translate between time series types and categories.
Public classcTimeSeriesImport
TimeSeries import class
Public classcTimeSeriesReaderFactory
Helper class; creates a Time series reader for a given type of Time series input source.
Public classcTimeSeriesTextReader
Reads one or more time series from a text input source.
Public classcTimeSeriesTextReadercPreview
Helper class; showing how a cTimeSeriesTextReader has interpreted the incoming time series data. The preview allows a user interface to interactively adjust the reader to correctly import time series.
Public classcTrapezoidShapeFunction
Public classcValidatorCore
Have the core do the data validation via it's cCore.Validate() method
Public classcValidatorCounter
Validate the value via one of the core counters
Public classcValidatorDefault
Default validator for all data types
Public classcValidatorEnum
Public classcValidatorManager
Manager for data validators. This provides access to data validator objects through its getValidator(eVarNameFlags) method
Public classcValidatorNumericSetToNull
Public classcValidatorOddEven
Public classcValueID

Helper class; assists in uniquely identifying EwE values.

Public classcVariableMetaData
Meta data for a variable, describing its value range and default value.
Public classcVariableStatus
Status or Message that applies to a variable (VarType) for a Group (iGroup) This is used by the message passing system to pass the status of a variable without passing the variable itself
Structures
  StructureDescription
Public structurecEcosimDatastructuresShapeParameters
Structure to contain all settings that wrap the primitive defining the contents of a forcing or time shape
Interfaces
  InterfaceDescription
Public interfaceICoreGroup
Interface for defining a group.
Public interfaceICoreInputOutput
Interface for accessing Core input or output objects.
Public interfaceICoreInterface
Interface for exposing Core data entities.
Public interfaceIEnviroInputData
Interface for defining Ecospace Environmental Input maps
Public interfaceIEnvironmentalResponseManager
Public interfaceIMPASearchModel
Public interfaceIThreadedProcess
Delegates
  DelegateDescription
Public delegatecCoreCoreMessageDelegate
Delegate defintion used to pass a message from the core to the interface.
Public delegatecCoreEcoSpaceInterfaceDelegate
Delegate defintion used to inform external processes on the progress of Ecospace.
Public delegatecCoreMessagePumpDelegate
Delegate used by cThreadWaitBase to run the interface message pump when waiting for a thread to complete
Public delegatecCoreStopRunDelegate
Delegate that can be passed to the core to allow interruption of a run or search
Public delegatecCoreStateMonitorCoreDataStateDelegate
Delegate, invoked to broadcast a core data state change event.
Public delegatecCoreStateMonitorCoreExecutionStateDelegate
Delegate, invoked to broadcast a core execution state change event.
Public delegatecEcoSpaceSolverErrorDelegate
Public delegatecGameServerInterfaceGetCoreIOObjectDelegate
Public delegatecLPSolverlpsolve55abortfunc
Public delegatecLPSolverlpsolve55logfunc
Public delegatecLPSolverlpsolve55msgfunc
Public delegatecMPAOptManagerSearchIterationDelegate
MPA Search has computed the value of a cell
Public delegatecMPAOptManagerSearchRunStateDelegate
MPA Search run state delegate.
Public delegatecMPAOptManagerSendMessageDelegate
Message sending delegate
Public delegatecShapeDataOnChangedEventHandler
Public delegateEcoSpaceRunCompletedDelegate
Public delegateEcoSpaceTimeStepDelegate
Definition of Time Step Delegate used for notification of an Ecospace time step
Public delegateMonteCarloCompletedDelegate
Call at the completion of the monte carlo trials
Public delegateMonteCarloEcopathProgressDelegate
Call each time a Ecopath model has been run
Public delegateMonteCarloSendMessageDelegate
Public delegateMonteCarloTrialProgressDelegate
Call each time a monte carlo trial has been completed
Enumerations
  EnumerationDescription
Public enumerationcCoreeBatchChangeLevelFlags
Enum describing the impact level of batch operations on EwE
Public enumerationcCoreeBatchLockType
Enum describing the type of batch lock that is currently active.
Public enumerationcEcopathModelFromEcosimeBACalcTypes
Enumerated type indicating how BA should be calculated.
Public enumerationcEcosimDatastructureseEcosimPreyPredResults
Public enumerationcEcosimDatastructureseEcosimResults
Enumerated index to the type of Ecosim Data saved over time
Public enumerationcLPSolverlpsolve55lpsolve_anti_degen
Public enumerationcLPSolverlpsolve55lpsolve_basiscrash
Public enumerationcLPSolverlpsolve55lpsolve_BBstrategies
Public enumerationcLPSolverlpsolve55lpsolve_branch
Public enumerationcLPSolverlpsolve55lpsolve_constr_types
Public enumerationcLPSolverlpsolve55lpsolve_improves
Public enumerationcLPSolverlpsolve55lpsolve_msgmask
Public enumerationcLPSolverlpsolve55lpsolve_piv_rules
Public enumerationcLPSolverlpsolve55lpsolve_presolve
Public enumerationcLPSolverlpsolve55lpsolve_return
Public enumerationcLPSolverlpsolve55lpsolve_scales
Public enumerationcLPSolverlpsolve55lpsolve_simplextypes
Public enumerationcMPAOptManagereRunStates
ENumerated type, defines MPA search run states.
Public enumerationcPathUtilityePathPlaceholderTypes
Enumerated type defining supported path mask placeholders.
Public enumerationcTimeSeriesReaderFactoryeTimeSeriesReaderTypes
Enumerated type stating all supported time series input formats.
Public enumerationeClimateTypes
The three climate zones for PSD analysis.
Public enumerationeDiversityIndexType
Selected biodiversity index to display in the UI
Public enumerationeEstimateParameterFor
Enumerated type that indicates for which purpose Ecopath parameters are being estimated.
Public enumerationeInitOption
Public enumerationeMCDietSamplingMethod
Public enumerationeMCParams
Public enumerationeMPAOptimizationModels
Public enumerationeOperators
Enumerated type indicating logical operators.
Public enumerationeOptimizeApproachTypes
Public enumerationeOptimizeOptionTypes
Public enumerationePrimaryProductionTypes
Enumerated type specifying Group Primary Production types
Public enumerationeProgressState
Public enumerationePSDMortalityTypes
Mortality types for PSD analysis
Public enumerationeSearchModes
Enumerated type, indicating the different search and optimization modes.
Public enumerationeSearchOptionTypes
Public enumerationeSpaceResultsFleets
Public enumerationeSpaceResultsFleetsGroups
Public enumerationeSpaceResultsGroups
Index of results from Ecospace saved over time by group
Public enumerationeTimeSeriesAliases
Enumerated type, defining aliases for time series types.
Public enumerationeTimeSeriesCategoryType
Enumerated type stating whether a time series is group-related, fleet-related or is a forcing function.
Public enumerationeTimeSeriesType
Types of time series
Public enumerationeTSDataSetInterval
Enumerated type, defining time series data point spacing types.