Click or drag to resize

cForcingFunction Class

Provides access to Forcing and EggProduction shapes, and a base class for Mediation functions.
Inheritance Hierarchy

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

The cForcingFunction type exposes the following members.

Properties
  NameDescription
Public propertyCoreComponent (Inherited from cShapeData.)
Public propertyDataType (Inherited from cShapeData.)
Public propertyDBID (Inherited from cShapeData.)
Public propertyEndEditPoint
Last X Index of the current edit block
(Inherited from cShapeData.)
Public propertyID
Index of the shape in the list managers list of shape
Public propertyIndex
Get/set the index of the time series in a time series dataset.
(Inherited from cShapeData.)
Public propertyIsSeasonal
Get/set whether a shape is supposed to reflect a monthly pattern.
(Inherited from cShapeData.)
Public propertyMean (Inherited from cShapeData.)
Public propertyName
Get/set the name of a time series.
(Inherited from cShapeData.)
Public propertynParams
Get the number of shape function parameters.
Public propertynPoints
Get the upper bound of the array.
(Inherited from cShapeData.)
Public propertyNYears
Public propertyShapeData
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.)
Public propertyShapeDataInt32
Get/set a value in the shape for a given point.
(Inherited from cShapeData.)
Public propertyShapeFunctionParameter
Get/set the value of a shape function parameter.
Public propertyShapeFunctionParameters
Get an array with the values for all shape function parameters.
Public propertyShapeFunctionType
Get/set the eShapeFunctionType that defines the forcing function.
Public propertyStartEditPoint
First X Index of the current edit block
(Inherited from cShapeData.)
Public propertyTimeResolution
Get/set the eTSDataSetInterval temporal resolution of a shape.
(Inherited from cShapeData.)
Public propertyXMax Obsolete.
Obsolete please use cShapeData.nPoints instead.
(Inherited from cShapeData.)
Public propertyYMax
Get the maximum value in the shape.
(Inherited from cShapeData.)
Top
Methods
  NameDescription
Public methodClear (Overrides cShapeDataClear.)
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 methodGetID (Inherited from cShapeData.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInit(Int32) (Inherited from cShapeData.)
Protected methodInit(Single)
(Inherited from cShapeData.)
Public methodIsLockedUpdates (Inherited from cShapeData.)
Protected methodLoad
Initialize the propeties from the underlying EcoSim data structures for this shapes Database ID
Public methodLockUpdates (Inherited from cShapeData.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReshape
Public methodSetValue (Inherited from cShapeData.)
Public methodToCSVString
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnlockUpdates (Inherited from cShapeData.)
Public methodUpdate
Update the already existing underlying EcoSim data structures (m_data)
(Overrides cShapeDataUpdate.)
Top
Events
  NameDescription
Public eventOnChanged (Inherited from cShapeData.)
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodValue
Extension method; extract a value from an object by property name.
(Defined by Extensions.)
Top
See Also