Click or drag to resize

cTimeSeriesDataStructures Class

Class that holds and manages all time series-related data in the EwE core.
Inheritance Hierarchy
SystemObject
  EwECorecTimeSeriesDataStructures

Namespace:  EwECore
Assembly:  EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
Syntax
public class cTimeSeriesDataStructures

The cTimeSeriesDataStructures type exposes the following members.

Constructors
  NameDescription
Public methodcTimeSeriesDataStructures
Initializes a new instance of the cTimeSeriesDataStructures class
Top
Properties
  NameDescription
Public propertynNumTimeSeries Obsolete.
Public propertynYears
Number of years in the reference data set
Top
Methods
  NameDescription
Public methodDoDatValCalculations
Load data from datval() into forcing arrays used by the models. Calculate the
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasData
Is there reference data for this model timestep
Public methodisTimeStepValid
Protected methodLoadEnabledTimeSeries
Public methodLoadForcingData
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRedimEnabledTimeSeries
Public methodredimForcingData
Redim time series forcing data PoolForceBB(nGroups, nYears),PoolForceZ(nGroups, nYears) and PoolForceCatch(nGroups, nYears)
Public methodSetBiomassForcing
Set whether a given group is biomass forced through time series.
Public methodSetDiscardForcing
Set whether a given group is discard forced through time series.
Public methodsetRefDataIndex
Get the reference data timestep index for this model timestep
Public methodtoForcingTimeStep
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldActiveDatasetIndex
Public fieldStatic memberANNUAL_DATA_MONTH
Public fieldbEnable
Array of flags indicating which a time series must be applied.
Public fieldDataSetInterval
Time interval of the currently selected dataset (monthly or annual).
Public fieldDataSetIntervals
Public fieldDatPool
Index of the core object that each applied time series links to. The type of the core object is implied by DatType.
Public fieldDatPoolSec
Index of the second core object that each applied time series links to. The type of the core object is implied by DatType.
Public fieldDatQ
mean(sumof(log(observed/predicted))) by data type
Public fieldDatSS
Sum of squares contribution (x time series)
Public fieldDatType
Type of each applied time series.
Public fieldDatVal
Public fieldDatYear
Year of the datum point.
Public fieldeDatQ
Public fieldErpred
log(observed/predicted) by observation
Public fieldForcedFs
Public fieldiDatasetDBID
Dataset database IDs
Public fieldIobs
Index to the current year/datatype
Public fieldiPool
Index of the core object that each time series links to. The type of the core object is implied by TimeSeriesType.
Public fieldiPoolSec
Index of the core object of a secundary time series target, if applicable. The type of the core object is implied by TimeSeriesType.
Public fieldiTimeSeriesDBID
Database ID for each time series.
Public fieldnAICTimeSeries
Public fieldnDatasetFirstYear
Public fieldnDatasetNumPoints
The number of data points in the dataset.
Public fieldnDatasetNumTimeSeries
Number of time series contained in each dataset.
Public fieldnDatasets
Number of available datasets.
Public fieldnDatPoints
Number of datum points across all applied time series.
Public fieldNdatType
Number of applied time series.
Public fieldnFleets
Public fieldnGroups
Public fieldnMaxYears
Maximum number of years across all time series.
Public fieldnTimeSeries
Number of time series in the model.
Public fieldPoolForceBB
Public fieldPoolForceCatch
Public fieldPoolForceDiscardMort
Proportion of discards that incur mortality. By Fleet,Group,Time
Public fieldPoolForceDiscardProp
Proportion of total catch that is discarded. By Fleet,Group,Time
Public fieldPoolForceZ
Public fieldsCV
CV for each time series.
Public fieldsDatQ
Public fieldsDatSS
Public fieldsEDatQ
Public fieldSSPredErr
Sum of Squared Prediction Error by time series data set sumof(log(observed(i)/predicted(i))^2) * [timeseries weight(i)].
Public fieldsSSPredErr
Weighted Sum of Squared Prediction Error by time series data set sumof(log(observed(i)/predicted(i))^2) * [timeseries weight(i)].
Public fieldstrDatasetAuthor
Authors of available datasets.
Public fieldstrDatasetContact
Public fieldstrDatasetDescription
Descriptions of available datasets.
Public fieldstrDatasetNames
Names of available datasets.
Public fieldstrName
Name of each time series.
Public fieldsValues
Annual values for each time series, indexed as (iYear, iSeries).
Public fieldsWeight
Weight type for each time series.
Public fieldTimeSeriesType
Type of each time series.
Public fieldWt
Public fieldWtType
Weight type for each applied time series.
Public fieldYhat
Top
Extension Methods
  NameDescription
Public Extension MethodValue
Extension method; extract a value from an object by property name.
(Defined by Extensions.)
Top
See Also