Model Railroad System 2.2.2
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
CTCPanel::ThroughYard Class Reference

Through Yard object type. More...

Public Member Functions

 ThroughYard (name, _ctcpanel, _canvas,...)
 Construct a ThroughYard object. More...
 
 ~ThroughYard ()
 Clean up all data objects and free up all resources. More...
 
 setv (value)
 Method to set out value (state). More...
 
 geti (ind)
 Method to get the state of one of our indicators (none). More...
 
 seti (ind, value)
 Method to set an indicator's state (none). More...
 
 invoke ()
 Method to invoke the ThroughYard. More...
 

Private Member Functions

 _configureLabel (option, value)
 Method to update the label option. More...
 

Private Attributes

 ctcpanel
 The CTC Panel component (parent widget). More...
 
 canvas
 The canvas component (parent widget component). More...
 

Static Private Attributes

static _ThroughYard_Poly
 Polygon coordinates for a through yard. More...
 

Detailed Description

Through Yard object type.

These are on the schematic and represent a piece of track on the Schematic.

Parameters
_ctcpanelThe CTCPanel megawidget.
_canvasThe schematic canvas to draw the ThroughYard on.
...Options:
  • -x The x coordinate of the object (readonly, default 0).
  • -y The y coordinate of the object (readonly, default 0).
  • -controlpoint The name of the control point this label is part of (readonly, default Yard).
  • -label The label of the ThroughYard (default "1").
  • -position The position of the label (readonly, default below).
  • -orientation The orientation (8-way) (readonly, default 0).
  • -flipped Whether the yard is flipped (readonly, default no).
  • -occupiedcommand A command to run to find out if the ThroughYard is occupied (default {}).
Defined coords terminals:
  • EntryL Left yard throat.
  • EntryR Right yard throat.
Defined values (states): none. Defined indicators: none.
Author
Robert Heller <heller@deepsoft.com>

Constructor & Destructor Documentation

◆ ThroughYard()

CTCPanel::ThroughYard::ThroughYard ( name  ,
_ctcpanel  ,
_canvas  ,
  ... 
)

Construct a ThroughYard object.

Parameters
_ctcpanelThe CTCPanel megawidget.
_canvasThe schematic canvas to draw the ThroughYard on.
...Option list.

◆ ~ThroughYard()

CTCPanel::ThroughYard::~ThroughYard ( )

Clean up all data objects and free up all resources.

Member Function Documentation

◆ _configureLabel()

CTCPanel::ThroughYard::_configureLabel ( option  ,
value   
)
private

Method to update the label option.

◆ geti()

CTCPanel::ThroughYard::geti ( ind  )

Method to get the state of one of our indicators (none).

◆ invoke()

CTCPanel::ThroughYard::invoke ( )

Method to invoke the ThroughYard.

◆ seti()

CTCPanel::ThroughYard::seti ( ind  ,
value   
)

Method to set an indicator's state (none).

◆ setv()

CTCPanel::ThroughYard::setv ( value  )

Method to set out value (state).

Parameters
valueThe new state to set.

Member Data Documentation

◆ _ThroughYard_Poly

CTCPanel::ThroughYard::_ThroughYard_Poly
staticprivate

Polygon coordinates for a through yard.

◆ canvas

CTCPanel::ThroughYard::canvas
private

The canvas component (parent widget component).

◆ ctcpanel

CTCPanel::ThroughYard::ctcpanel
private

The CTC Panel component (parent widget).