Sequence Class |
A series of Loconet packets that can be played back onto the network.
Inheritance HierarchyNamespace: RRAutoLib.CTC
Assembly: RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax<SerializableAttribute> Public NotInheritable Class Sequence Inherits CtcObjectBase
The Sequence type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | DefaultName | Gets the default identifiable name assigned to this CTC object. (Inherited from CtcObjectBase.) |
| 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.) |
| 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.) |
| Status | Gets the current status of the sequence. (Idle, Recording, or Playing) |
| 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.) |
| GetItems | Gets a list of SequenceSeqItem objects associated with the sequence. |
| NotifyObjectChanged | Raises the ObjectChanged event for this object. (Inherited from CtcObjectBase.) |
| Play | Plays the sequence. |
| Record | Starts recording the sequence. |
| SetItems | Sets the list of SequenceSeqItem objects associated with the sequence. |
| Stop | Stops recording or playing the sequence. |
| SubstituteSlot | Substitutes slot numbers, of packets, that target command station slots. |
| ToString | (Overrides ObjectToString.) |
Remarks
A sequence contains a series of ordered Loconet packets, each with event timing information, so that when played, can perform a scripted action.
Since sequences record raw packet traffic, playing them could cause the state integrity of CTC managed objects to be poluted.
For example if the CTC had the state of a turnout locked through a route, it would not be prudent to run a sequence changing the state of that turnout.
Examples of appropriate sequence use might be: accessory automated behaviors (i.e. cranes, turntables, street lights), special engine beaviors (i.e. yard movements, decoupling, etc.)
See Also