Sage Modeling and Simulation Library

PfcStep Members

The PfcStep type exposes the following members.

Constructors


  Name Description
Public method PfcStep()()()()
Creates a new instance of the PfcStep class.
Public method PfcStep(IProcedureFunctionChart, String, String, Guid)
Creates a new instance of the PfcStep class.

Methods


  Name Description
Public method AddAction
Adds a child Pfc into the actions list under this step.
Public method AddPredecessor
Adds the new predecessor link to this node's list of predecessors.
(Inherited from PfcNode.)
Public method AddSuccessor
Adds the new successor link to this node's list of successors.
(Inherited from PfcNode.)
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method Find
Finds the child node, if any, at the specified path relative to this node.
Public method GetChildren
Gets all of the elements that are contained in or under this Pfc, to a depth specified by the 'depth' parameter, and that pass the 'filter' criteria.
Public method GetHashCode
Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from PfcElement.)
Public method GetLabel
Gets the label from the context indicated by the provided context, or if null or String.Empty has been selected, then from the default context.
Public method GetLinkForPredecessorNode
Gets the link that connects this node to a predecessor node. Returns null if there is no such link.
(Inherited from PfcNode.)
Public method GetLinkForSuccessorNode
Gets the link that connects this node to a successor node. Returns null if there is no such link.
(Inherited from PfcNode.)
Public method GetPermissionToStart
Gets permission from the step to transition to run.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method InitializeIdentity
Initialize the identity of this model object, once.
(Inherited from PfcElement.)
Public method IsConnected
Determines whether this instance is connected to anything upstream or downstream.
(Inherited from PfcNode.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method RemovePredecessor
Removes the predecessor link from this node's list of predecessors.
(Inherited from PfcNode.)
Public method RemoveSuccessor
Removes the successor link from this node's list of successors.
(Inherited from PfcNode.)
Public method Reset
Resets this instance. Used at, or pertaining to, runtime execution.
(Inherited from PfcNode.)
Public method SetActor
Sets the Actor that will determine the behavior behind this step. The actor provides the leaf level action, as well as preconditiond for running.
Public method SetLabel
Sets the label in the context indicated by the provided context, or if null or String.Empty has been selected, then in the default context.
Public method SetLinkHighestPriority
Gives the specified link (which must be one of the outbound links from this node) the highest priority of all links outbound from this node. Retuens false if the specified link is not a successor link to this node. NOTE: This API will renumber the outbound links' priorities.
(Inherited from PfcNode.)
Public method SetLinkLowestPriority
Gives the specified link (which must be one of the outbound links from this node) the lowest priority of all links outbound from this node. Retuens false if the specified link is not a successor link to this node. NOTE: This API will renumber the outbound links' priorities.
(Inherited from PfcNode.)
Public method SetName
Sets the name of this step node to the new value.
(Inherited from PfcElement.)
Public method ToProcedureFunctionChart()()()()
Returns the actions under this Step as a procedure function chart.
Public method ToProcedureFunctionChart(Boolean)
Returns the actions under this Step as a procedure function chart.
Public method ToString
Returns a String that represents the current Object.
(Inherited from PfcElement.)
Public method UpdateStructure
Updates the portion of the structure of the SFC that relates to this element. This is called after any structural changes in the Sfc, but before the resultant data are requested externally.
(Inherited from PfcNode.)

Properties


  Name Description
Public property Actions
Gets the actions associated with this PFC Step. They are keyed by ActionName, and are themselves, PFCs. This dictionary should not be changed - use AddAction(string ,IProcedureFunctionChart).
Public property Description
The description for this SfcStep. Typically used for human-readable representations.
(Inherited from PfcElement.)
Public property EarliestStart
Gets or sets the earliest time that this element can start.
(Inherited from PfcNode.)
Public property ElementType
Gets the type of this element.
Public property GraphicsData
A string dictionary containing name/value pairs that represent graphics & layout-related values.
(Inherited from PfcNode.)
Public property GraphOrdinal
Gets or sets the graph ordinal of this node - a number that roughly (but consistently) represents its place in the execution order for this graph. Loopbacks' ordinals indicate their place in the execution order as of their first execution.
(Inherited from PfcNode.)
Public property Guid
The Guid for this SfcStep. Typically required to be unique.
(Inherited from PfcElement.)
Public property IsFinishNode
Gets a value indicating whether this instance is finish node.
(Inherited from PfcNode.)
Public property IsNullNode
Gets a value indicating whether this instance is null. A node that is null can be eliminated when PFCs are combined.
(Inherited from PfcNode.)
Public property IsSimple
Gets a value indicating whether this instance is simple. A node is simple if it has one input and one output and performs no tasks beyond a pass-through. In the case of a Step, a Simple step is a Null step. This also facilitates graph reduction.
(Inherited from PfcNode.)
Public property IsStartNode
Gets a value indicating whether this instance is start node.
(Inherited from PfcNode.)
Public property LeafLevelAction
Public property Model
The model that owns this SfcStep, or from which it gets time, etc. data.
(Inherited from PfcElement.)
Public property MyStepStateMachine
Public property Name
The user-friendly name for this SfcStep. Required to be unique if there is a Participant directory listing this element - which there will be, if the element is attached to a Pfc.
(Inherited from PfcElement.)
Public property NodeColor (Inherited from PfcNode.)
Public property Parent
The parent ProcedureFunctionChart of this node.
(Inherited from PfcElement.)
Public property Precondition
Public property PredecessorNodes
Gets the predecessor node list for this node.
(Inherited from PfcNode.)
Public property Predecessors
Gets the predecessor list for this node.
(Inherited from PfcNode.)
Public property RecipeSourceGuid
Returns the Guid of the element in the source recipe that is represented by this PfcStep.
Public property SEID
Gets the SEID, or Source Element ID of this element. If the PFC of which this element is a member is cloned, then this SEID will be the Guid of the element in the source PFC that is semantically/structurally equivalent to this one.
(Inherited from PfcElement.)
Public property StructureDirty
Gets or sets a value indicating whether the structure of this SFC is dirty (in effect, whether it has changed since consolidation was last done.
(Inherited from PfcNode.)
Public property SuccessorNodes
Gets the successor list for this node. Do not modify this list.
(Inherited from PfcNode.)
Public property Successors
Gets the successor list for this node. Do not modify this list.
(Inherited from PfcNode.)
Public property UnitInfo
Gets the unit with which this step is associated.
Public property UserData
Gets or sets some piece of arbitrary user data. This data is (currently) not serialized.
(Inherited from PfcElement.)

Events


  Name Description
Public event PfcStarting
Occurs when PFC is starting.