cStanzaGroup Class

Multi-stanza group

Inheritance Hierarchy

SystemObject
EwECorecCoreInputOutputBase
EwECorecStanzaGroup

Namespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)

Syntax

Copy

public class cStanzaGroup : cCoreInputOutputBase

Public Class cStanzaGroup
	Inherits cCoreInputOutputBase

type cStanzaGroup =  
    class
        inherit cCoreInputOutputBase
    end

The cStanzaGroup type exposes the following members.

Constructors

	Name	Description
	cStanzaGroup	Initializes a new instance of the cStanzaGroup class

Top

Properties

	Name	Description
	Biomass
	BiomassAccumulationRate	Get/set the relative biomass accumulation rate for this stanza configuration.
	BiomassAtAge
	CB
	CoreComponent	Get the core component type that this object belongs to. Component types are useful for determining the level of impact that objects have on the EwE computing model. (Inherited from cCoreInputOutputBase.)
	DataType	Get the data type uniquely identifying the type of core data that this class implements. (Inherited from cCoreInputOutputBase.)
	DBID	Returns the persistent unique database ID for an ICoreInputOutput. (Inherited from cCoreInputOutputBase.)
	Disposed	(Inherited from cCoreInputOutputBase.)
	EggAtSpawn
	FixedFecundity
	HatchCode	Get/set the hatchery stocking forcing function number for this stanza configuration.
	iGroups	Get/set the index of a life stage in this multi-stanza grouping. Groups are stored in a one-based array.
	iLifeStage	Get the life stage index of a group index within this stanza configuration.
	Index	Get/set the one-based index of a cCoreInputOutputBase instance in the list that it is contained in. (Inherited from cCoreInputOutputBase.)
	isDirty
	IsFished	Get whether a group is being fished. This value is kept up to date by the core.
	LeadingB	Get/set the zero-based index of the life stage that determines B for this stanza.
	LeadingCB	Get/set the zero-based index of the life stage that determines CB for this stanza.
	MaxAge
	Mortality
	Name	Get/set the name of a core object. Every ICoreInterface derived instance in EwE6 has a name. (Inherited from cCoreInputOutputBase.)
	nLifeStages	Get the number of life stages in this Multi Stanza grouping.
	NStanzas	Obsolete. Get/set the number of groups in this Multi Stanza grouping.
	NumberAtAge
	OkToCalculate	Is it ok to run stanza calculation, cEcosim.CalculateStanzaParameters(), on this object. Have the leading stanza parameters been set.
	RecruitmentPower	Get/set the recruitment power for this stanza configuration.
	Remark	Get/set a remark. (Inherited from cCoreInputOutputBase.)
	SpawnProp
	StartAge
	Units	(Inherited from cCoreInputOutputBase.)
	ValidationStatus	Get the outcome of the most recently performed variable validation attempt on a cCoreInutOutputBase instance. (Inherited from cCoreInputOutputBase.)
	ValueDescriptor	Returns the Value descriptor for a given variable name, associated with this object. (Inherited from cCoreInputOutputBase.)
	WeightAtAge
	WmatWinf	Get/set the weight at maturity over weight at infancy ratio for this stanza configuration.

Top

Methods

	Name	Description
	Apply	Apply Stanza Calculation
	CalculateParameters	Calculate the Stanza parameters for this stanza group
	Cancel	Cancel edits made by a user by reloading the underlying Core data and re-calculating the stanza parameters.
	Clear	(Inherited from cCoreInputOutputBase.)
	Dispose	Destroy an instance. (Inherited from cCoreInputOutputBase.)
	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	Returns the unique ID for this object as a text string. (Inherited from cCoreInputOutputBase.)
	GetStatus	Returns the status of a variable in this object. (Inherited from cCoreInputOutputBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVariable	Return the value of a variable. (Inherited from cCoreInputOutputBase.)
	GetVariableMetadata	Return metadata associated with a variable. If the local instance does not have metadata associated the central metadata repository is consulted. (Inherited from cCoreInputOutputBase.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetStatus	Replaces current status flags for a given variable with a new set of status flags. (Inherited from cCoreInputOutputBase.)
	SetVariable	Overloaded to set the isDirty flag (Overrides cCoreInputOutputBaseSetVariable(eVarNameFlags, Object, Int32, Int32).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	m_bReadOnly	States whether an object will allow its values to be modified via SetVariable. (Inherited from cCoreInputOutputBase.)
	m_bValidate	States whether Variable validation is enabled for this object. (Inherited from cCoreInputOutputBase.)
	m_core	Reference to the EwE Core that exposes the object. (Inherited from cCoreInputOutputBase.)
	m_coreComponent	The EwE core component that this object belongs to (Inherited from cCoreInputOutputBase.)
	m_dataType	Container for the data type describing the object. (Inherited from cCoreInputOutputBase.)
	m_ValidationStatus	Container for the Validation status of the object. (Inherited from cCoreInputOutputBase.)

Top

Extension Methods

	Name	Description
	Value	Extension method; extract a value from an object by property name. (Defined by Extensions.)

Top

Remarks

This class acts as a buffer for the data. The core data is updated expilcitly by a user not implicitly by the core. The user of this class is responsible for calculating the stanza parameters and saving any changes.

Reference

EwECore Namespace