cPredPreyInteraction Class

Class to wrap the shape and function type modifiers for a pred/prey interaction

Inheritance Hierarchy

SystemObject
EwECorecMediatedInteraction
EwECorecPredPreyInteraction

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

Syntax

Copy

public class cPredPreyInteraction : cMediatedInteraction

Public Class cPredPreyInteraction
	Inherits cMediatedInteraction

type cPredPreyInteraction =  
    class
        inherit cMediatedInteraction
    end

The cPredPreyInteraction type exposes the following members.

Constructors

	Name	Description
	cPredPreyInteraction	Create a new interaction.

Top

Properties

	Name	Description
	CoreComponent	(Inherited from cMediatedInteraction.)
	DataType	(Overrides cMediatedInteractionDataType.)
	DBID	(Inherited from cMediatedInteraction.)
	Index	(Inherited from cMediatedInteraction.)
	isProdRate	Get whether this interaction denotes a production rate interaction.
	LockUpdates	Get/set whether updates should not be sent to the core. This functionality is particularly useful when making a series of changes to pred/prey interactions. (Inherited from cMediatedInteraction.)
	MaxNumShapes	(Overrides cMediatedInteractionMaxNumShapes.)
	Name	(Inherited from cMediatedInteraction.)
	nAppliedShapes	Get the number of shapes that are used by this predator/prey interaction. (Inherited from cMediatedInteraction.)
	PredIndex	Get the index of the predator for this interaction.
	PreyIndex	Get the index of the prey for this interaction.

Top

Methods

	Name	Description
	Clear	(Inherited from cMediatedInteraction.)
	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	(Overrides cMediatedInteractionGetID.)
	getShape	Get a shape modifier, consisting of a forcing funtion and a Type of variable, defined at a given index. (Inherited from cMediatedInteraction.)
	getShapeFromEcosimIndex	(Inherited from cMediatedInteraction.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	setShape	Set a shape modifier, consisting of a forcing function and function type, for a given index. (Inherited from cMediatedInteraction.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	m_dbid	(Inherited from cMediatedInteraction.)
	m_lstAppTypes	List of Application types this that this interation applies to Passed into the Constructor (Inherited from cMediatedInteraction.)
	m_manager	(Inherited from cMediatedInteraction.)
	m_SFPairs	(Inherited from cMediatedInteraction.)

Top

Extension Methods

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

Top

Remarks

This will populate a list of five(MaxFunctions) shapes/functiontype pairs on construction. A user calls setShape(,,,) or getShape(,,,) to modify the shape or functiontype for this Pred Prey interaction.

Reference

EwECore Namespace