StepScript Class

A script that can be started, stopped and resumed from defined step points.

Inheritance Hierarchy

Namespace: RRAutoLib.CTC
Assembly: RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884

Syntax

<SerializableAttribute>
Public NotInheritable Class StepScript
	Inherits CtcObjectBase
	Implements IScript, ISupportsScriptEvents

[SerializableAttribute]
public sealed class StepScript : CtcObjectBase, 
	IScript, ISupportsScriptEvents

The StepScript type exposes the following members.

Constructors

	Name	Description
	StepScript	Initializes a new instance of the StepScript class

Properties

	Name	Description
	CancelToken	Gets the cancellation token of the running script that can be used to cancel individial script methods.
	DefaultName	Gets the default identifiable name assigned to this CTC object. (Inherited from CtcObjectBase.)
	Enabled	Gets or sets whether the script will be compiled and be made available for operation.
	ID	Gets the CTC object's globaly unique static identifier. (Inherited from CtcObjectBase.)
	IsDeleted	Gets an indication whether this CTC object has been flaged for deletion by DeleteSelf. (Inherited from CtcObjectBase.)
	Loop	Gets or sets whether the script should restart from the beginning when it reaches the end.
	Name	Gets or sets the identifiable name assigned to this CTC object. (Inherited from CtcObjectBase.)
	Parent	Gets the parent list that contains this CTC object. (Inherited from CtcObjectBase.)
	PersistedTag	Gets or sets the binary representation of an arbitrary object that provides additional data to be stored with the layout data. (Inherited from CtcObjectBase.)
	Running	Gets a value indicating whether the step script is currently running.
	Script	Gets or sets the user script used to initialize the execution steps.
	ScriptEventBinder
	StepNames	Gets a list of previously defined step names.
	StepPos	Gets the step position at which execution is or will occur next.
	StepPosName	Gets the step name associated with the StepPos index.
	Tag	Gets or sets an arbitrary object that provides additional data but is disposed between sessions. (Inherited from CtcObjectBase.)

Methods

	Name	Description
	Clone	Used internally. (Inherited from CtcObjectBase.)
	DeleteSelf	(Overrides CtcObjectBaseDeleteSelf.)
	NotifyObjectChanged	Raises the ObjectChanged event for this object. (Inherited from CtcObjectBase.)
	StartAt	Starts script execution at a given step position.
	Step	Adds a step definition to the step script list.
	Stop	Stops script execution.
	ToString	(Overrides ObjectToString.)

Remarks

Use this type of script object to sequentially execute a list of steps. Examples: running a locomotive, scripting actions of a craine, etc.