Engine Class |
A DCC locomotive to be controled.
Inheritance HierarchyNamespace: RRAutoLib.CTC
Assembly: RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax<SerializableAttribute> Public NotInheritable Class Engine Inherits CtcObjectBase Implements ISupportsScriptEvents
The Engine type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Address | Gets or sets the DCC address of the engine. |
| AutoBindInOpr | Gets or sets whether the engine should automatically bind to a slot when starting the CTC service. |
| DefaultName | Gets the default identifiable name assigned to this CTC object. (Inherited from CtcObjectBase.) |
| Direction | Gets or sets the engine's direction of travel. |
| Functions | Gets the engine's function states. |
| FunctionsByte | Gets or sets the engine's function states. |
| ID | Gets the CTC object's globaly unique static identifier. (Inherited from CtcObjectBase.) |
| IsBound | Gets a value indicating whether the engine has been bound to a command station slot. |
| IsDeleted | Gets an indication whether this CTC object has been flaged for deletion by DeleteSelf. (Inherited from CtcObjectBase.) |
| Length | Gets or sets the engine's length over buffers. |
| 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.) |
| ReqCatenary | Gets or sets whether the engine is electric and requires overhead catenary. |
| ScriptEventBinder | |
| Slot | Gets the slot number assigned to the Engine by the command station. |
| Speed | Gets or sets the speed of the engine. |
| SpeedStepMax | Gets the maximum speed value that can be assigned to the engine. |
| SpeedSteps | Gets or sets the speed step type of the engine. |
| Tag | Gets or sets an arbitrary object that provides additional data but is disposed between sessions. (Inherited from CtcObjectBase.) |
Methods| Name | Description | |
|---|---|---|
 | BindSlot | Binds the engine to the command station so that it can be controlled. |
 | Clone | Used internally. (Inherited from CtcObjectBase.) |
| DeleteSelf | (Overrides CtcObjectBaseDeleteSelf.) |
| EmergencyStop | Stops the engine immediately ignoring deceleration curves that might be programmed with the engine's decoder. |
| NotifyObjectChanged | Raises the ObjectChanged event for this object. (Inherited from CtcObjectBase.) |
| SetSpeed | Sets the speed of the engine. |
| StartSpeedRamp | Creates a task that performs a gradual engine speed increase/decrease. |
| StopSpeedRamp | Stops a previously started speed ramp. |
| ToString | (Overrides ObjectToString.) |
| UnbindSlot | Unbinds the engine from the command station and frees the slot. |
Events| Name | Description | |
|---|---|---|
 | BindSlotResponse | Occurs after an attempt to bind an engine to a slot. |
| DirectionChanged | Occurs when the direction of the engine's bound slot has changed. |
| FunctionChanged | Occurs when any function of the engine's bound slot has changed. |
| SpeedChanged | Occurs when the speed of the engine's bound slot has changed. |
| UnbindSlotResponse | Occurs after an attempt to unbind an engine from a slot. |
See Also