cLandingsMediationFunction Class |
A derived mediation function, dedicated to modelling fleet-group interactions
based on landings.
Inheritance HierarchySystemObject
EwECorecShapeData
EwECorecForcingFunction
EwECorecMediationBaseFunction
EwECorecLandingsMediationFunction
EwECorecShapeData
EwECorecForcingFunction
EwECorecMediationBaseFunction
EwECorecLandingsMediationFunction
Namespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe cLandingsMediationFunction type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CoreComponent | (Inherited from cShapeData.) |
| DataType | (Inherited from cShapeData.) |
| DBID | (Inherited from cShapeData.) |
| EndEditPoint |
Last X Index of the current edit block
(Inherited from cShapeData.) |
| Fleet | (Overrides cMediationBaseFunctionFleetInt32.) |
| Group | (Overrides cMediationBaseFunctionGroupInt32.) |
| ID |
Index of the shape in the list managers list of shape
(Inherited from cForcingFunction.) |
| Index |
Get/set the index of the time series in a time series dataset.
(Inherited from cShapeData.) |
| IsSeasonal |
Get/set whether a shape is supposed to reflect a monthly pattern.
(Inherited from cShapeData.) |
| Mean | (Inherited from cShapeData.) |
| Name |
Get/set the name of a time series.
(Inherited from cShapeData.) |
| nParams |
Get the number of shape function parameters.
(Inherited from cForcingFunction.) |
| nPoints |
Get the upper bound of the array.
(Inherited from cShapeData.) |
| NumFleet | (Overrides cMediationBaseFunctionNumFleet.) |
| NumGroups | (Overrides cMediationBaseFunctionNumGroups.) |
| NYears | (Inherited from cForcingFunction.) |
| ShapeData |
Returns the actual shape values. Note that his method returns a copy
of the original data array; making changes to the array returned here
will not be reflected in the original shape.
(Inherited from cShapeData.) |
| ShapeDataInt32 |
Get/set a value in the shape for a given point.
(Inherited from cShapeData.) |
| ShapeFunctionParameter |
Get/set the value of a shape function parameter.
(Inherited from cForcingFunction.) |
| ShapeFunctionParameters |
Get an array with the values for all shape function parameters.
(Inherited from cForcingFunction.) |
| ShapeFunctionType |
Get/set the eShapeFunctionType that defines the forcing function.
(Inherited from cForcingFunction.) |
| StartEditPoint |
First X Index of the current edit block
(Inherited from cShapeData.) |
| TimeResolution |
Get/set the eTSDataSetInterval temporal resolution of a shape.
(Inherited from cShapeData.) |
| XBase |
X Axis base value for sum of x biomass
(Inherited from cMediationBaseFunction.) |
| XBaseIndex |
X Axis base index for biomass
(Inherited from cMediationBaseFunction.) |
| XMax | Obsolete.
Obsolete please use cShapeData.nPoints instead.
(Inherited from cShapeData.) |
| YMax |
Get the maximum value in the shape.
(Inherited from cShapeData.) |
Methods| Name | Description | |
|---|---|---|
 | AddFleet | (Overrides cMediationBaseFunctionAddFleet(Int32, Single).) |
| AddGroup | (Overrides cMediationBaseFunctionAddGroup(Int32, Single, Int32).) |
| Clear | (Overrides cForcingFunctionClear.) |
| 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.) |
| GetID | (Inherited from cShapeData.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Init(Int32) | (Inherited from cShapeData.) |
| Init(Single) | (Inherited from cShapeData.) |
| IsLockedUpdates | (Inherited from cShapeData.) |
| Load |
Initialize the propeties from the underlying EcoSim data structures at the existing array index (iEcoSimIndex)
(Inherited from cMediationBaseFunction.) |
| LockUpdates | (Inherited from cShapeData.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RemoveGroup(Int32) | |
| RemoveGroup(cLandingsMediatingGroup) | |
| Reshape |
Update the shape from a shape function. This updates the shape data,
the ShapeFunctionType, and ShapeFunctionParameterInt32
values.
(Inherited from cForcingFunction.) |
| SetValue | (Inherited from cShapeData.) |
| ToCSVString | (Inherited from cForcingFunction.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnlockUpdates | (Inherited from cShapeData.) |
| Update |
Update the underlying EcoSim data structures
(Overrides cMediationBaseFunctionUpdate.) |
Events| Name | Description | |
|---|---|---|
 | OnChanged | (Inherited from cShapeData.) |
Fields| Name | Description | |
|---|---|---|
 | m_bInInit | (Inherited from cForcingFunction.) |
| m_bLockUpdates | (Inherited from cForcingFunction.) |
| m_coreComponent | (Inherited from cShapeData.) |
| m_data | (Inherited from cForcingFunction.) |
| m_datatype | (Inherited from cShapeData.) |
| m_iDBID | (Inherited from cShapeData.) |
| m_iEcoSimIndex | (Inherited from cShapeData.) |
| m_iIndex | (Inherited from cForcingFunction.) |
| m_iMedXBase | (Inherited from cMediationBaseFunction.) |
| m_manager | (Inherited from cForcingFunction.) |
| m_medData | (Inherited from cMediationBaseFunction.) |
| m_nYears | (Inherited from cForcingFunction.) |
| m_params | (Inherited from cForcingFunction.) |
| m_ShapeFunctionType | (Inherited from cForcingFunction.) |
| m_timeresolution | (Inherited from cShapeData.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |
RemarksSee Also