diff --git a/DCCEXLoco_8h_source.html b/DCCEXLoco_8h_source.html index cf8cf67..1e0d9d6 100644 --- a/DCCEXLoco_8h_source.html +++ b/DCCEXLoco_8h_source.html @@ -224,16 +224,18 @@
232 
235  ConsistLoco* getFirst();
236 
-
237 private:
-
238  char* _name;
-
239  int _locoCount;
-
240  ConsistLoco* _first;
-
241 
-
242  void _addLocoToConsist(ConsistLoco* consistLoco);
-
243 
-
244 };
+
239  ConsistLoco* getByAddress(int address);
+
240 
+
241 private:
+
242  char* _name;
+
243  int _locoCount;
+
244  ConsistLoco* _first;
245 
-
246 #endif
+
246  void _addLocoToConsist(ConsistLoco* consistLoco);
+
247 
+
248 };
+
249 
+
250 #endif
ConsistLoco
Class to add an additional attribute to a Loco object to specify the direction it is facing in a cons...
Definition: DCCEXLoco.h:139
ConsistLoco::setFacing
void setFacing(Facing facing)
Set which way the loco is facing in the consist (FacingForward, FacingReversed)
Definition: DCCEXLoco.cpp:176
ConsistLoco::getLoco
Loco * getLoco()
Get the associated Loco object for this consist entry.
Definition: DCCEXLoco.cpp:172
@@ -243,17 +245,18 @@
ConsistLoco::getFacing
Facing getFacing()
Get which way the loco is facing in the consist (FacingForward, FacingReversed)
Definition: DCCEXLoco.cpp:180
Consist
Class to create a software consist of one or more ConsistLoco objects.
Definition: DCCEXLoco.h:176
Consist::setName
void setName(char *name)
Set consist name.
Definition: DCCEXLoco.cpp:201
+
Consist::getByAddress
ConsistLoco * getByAddress(int address)
Get the loco in the consist with the specified address.
Definition: DCCEXLoco.cpp:319
Consist::addLoco
void addLoco(Loco *loco, Facing facing)
Add a loco to the consist using a Loco object.
Definition: DCCEXLoco.cpp:209
Consist::getName
char * getName()
Get consist name.
Definition: DCCEXLoco.cpp:205
-
Consist::getFirst
ConsistLoco * getFirst()
Get the first loco in the consist.
Definition: DCCEXLoco.cpp:312
-
Consist::getDirection
Direction getDirection()
Get consist direction - obtained from first linked loco.
Definition: DCCEXLoco.cpp:306
-
Consist::setLocoFacing
void setLocoFacing(Loco *loco, Facing facing)
Update the direction of a loco in the consist.
Definition: DCCEXLoco.cpp:270
+
Consist::getFirst
ConsistLoco * getFirst()
Get the first loco in the consist.
Definition: DCCEXLoco.cpp:315
+
Consist::getDirection
Direction getDirection()
Get consist direction - obtained from first linked loco.
Definition: DCCEXLoco.cpp:309
+
Consist::setLocoFacing
void setLocoFacing(Loco *loco, Facing facing)
Update the direction of a loco in the consist.
Definition: DCCEXLoco.cpp:273
Consist::removeLoco
void removeLoco(Loco *loco)
Remove a loco from the consist.
Definition: DCCEXLoco.cpp:232
-
Consist::removeAllLocos
void removeAllLocos()
Remove all locos from a consist.
Definition: DCCEXLoco.cpp:256
-
Consist::getSpeed
int getSpeed()
Get consist speed - obtained from first linked loco.
Definition: DCCEXLoco.cpp:300
-
Consist::getLocoCount
int getLocoCount()
Get the count of locos in the consist.
Definition: DCCEXLoco.cpp:278
+
Consist::removeAllLocos
void removeAllLocos()
Remove all locos from a consist.
Definition: DCCEXLoco.cpp:258
+
Consist::getSpeed
int getSpeed()
Get consist speed - obtained from first linked loco.
Definition: DCCEXLoco.cpp:303
+
Consist::getLocoCount
int getLocoCount()
Get the count of locos in the consist.
Definition: DCCEXLoco.cpp:281
Consist::Consist
Consist()
Constructor.
Definition: DCCEXLoco.cpp:195
-
Consist::inConsist
bool inConsist(Loco *loco)
Check if the provided loco is in the consist.
Definition: DCCEXLoco.cpp:282
+
Consist::inConsist
bool inConsist(Loco *loco)
Check if the provided loco is in the consist.
Definition: DCCEXLoco.cpp:285
Loco
Class for a Loco object representing a DCC addressed locomotive.
Definition: DCCEXLoco.h:54
Loco::isFunctionOn
bool isFunctionOn(int function)
Test if function is on.
Definition: DCCEXLoco.cpp:134
Loco::setDirection
void setDirection(Direction direction)
Set loco direction (enums Forward, Reverse)
Definition: DCCEXLoco.cpp:77
diff --git a/DCCEXProtocol_8h_source.html b/DCCEXProtocol_8h_source.html index ef08069..0f93b01 100644 --- a/DCCEXProtocol_8h_source.html +++ b/DCCEXProtocol_8h_source.html @@ -432,18 +432,18 @@
DCCEXProtocol::receivedRoster
bool receivedRoster()
Check if roster has been received.
Definition: DCCEXProtocol.cpp:292
DCCEXProtocol::roster
Loco * roster
Linked list of Loco objects to form the roster.
Definition: DCCEXProtocol.h:397
DCCEXProtocol::powerTrackOff
void powerTrackOff(char track)
Turn power off for the specified track.
Definition: DCCEXProtocol.cpp:449
-
DCCEXProtocol::deactivateAccessory
void deactivateAccessory(int accessoryAddress, int accessorySubAddr)
Deactivate DCC accessory at the specified address and subaddress.
Definition: DCCEXProtocol.cpp:486
+
DCCEXProtocol::deactivateAccessory
void deactivateAccessory(int accessoryAddress, int accessorySubAddr)
Deactivate DCC accessory at the specified address and subaddress.
Definition: DCCEXProtocol.cpp:491
DCCEXProtocol::turntables
Turntable * turntables
Linked list of Turntable objects to form the list of turntables.
Definition: DCCEXProtocol.h:406
DCCEXProtocol::functionOn
void functionOn(Loco *loco, int function)
Turn the specified function on for the provided loco.
Definition: DCCEXProtocol.cpp:202
DCCEXProtocol::getRouteCount
int getRouteCount()
Get the number of route entries.
Definition: DCCEXProtocol.cpp:353
DCCEXProtocol::setTrackType
void setTrackType(char track, TrackManagerMode type, int address)
set track type for the specified track
Definition: DCCEXProtocol.cpp:456
DCCEXProtocol::getRosterCount
int getRosterCount()
Get the number of roster entries.
Definition: DCCEXProtocol.cpp:288
DCCEXProtocol::readLoco
void readLoco()
Initiate reading a loco address from the programming track, response will be a delegate notification.
Definition: DCCEXProtocol.cpp:270
-
DCCEXProtocol::activateAccessory
void activateAccessory(int accessoryAddress, int accessorySubAddr)
Activate DCC accessory at the specified address and subaddress.
Definition: DCCEXProtocol.cpp:477
+
DCCEXProtocol::activateAccessory
void activateAccessory(int accessoryAddress, int accessorySubAddr)
Activate DCC accessory at the specified address and subaddress.
Definition: DCCEXProtocol.cpp:482
DCCEXProtocol::receivedLists
bool receivedLists()
Check if all lists have been received (roster, routes, turnouts, turntables)
Definition: DCCEXProtocol.cpp:144
DCCEXProtocol::getMajorVersion
int getMajorVersion()
Retrieve the major version of EX-CommandStation.
Definition: DCCEXProtocol.cpp:161
DCCEXProtocol::getLists
void getLists(bool rosterRequired, bool turnoutListRequired, bool routeListRequired, bool turntableListRequired)
Request DCC-EX object lists (Roster, Turnouts, Routes, Turntables)
Definition: DCCEXProtocol.cpp:111
-
DCCEXProtocol::activateLinearAccessory
void activateLinearAccessory(int linearAddress)
Activate DCC accessory at the specified linear address.
Definition: DCCEXProtocol.cpp:495
+
DCCEXProtocol::activateLinearAccessory
void activateLinearAccessory(int linearAddress)
Activate DCC accessory at the specified linear address.
Definition: DCCEXProtocol.cpp:500
DCCEXProtocol::closeTurnout
void closeTurnout(int turnoutId)
Close the specified turnout/point.
Definition: DCCEXProtocol.cpp:326
DCCEXProtocol::powerTrackOn
void powerTrackOn(char track)
Turn power on for the specified track.
Definition: DCCEXProtocol.cpp:442
DCCEXProtocol::isFunctionOn
bool isFunctionOn(Loco *loco, int function)
Test if the specified function for the provided loco is on.
Definition: DCCEXProtocol.cpp:226
@@ -458,7 +458,7 @@
DCCEXProtocol::resumeRoutes
void resumeRoutes()
Resume all routes/automations.
Definition: DCCEXProtocol.cpp:379
DCCEXProtocol::findLocoInRoster
Loco * findLocoInRoster(int address)
Search for the specified DCC address in the roster.
Definition: DCCEXProtocol.cpp:297
DCCEXProtocol::requestLocoUpdate
void requestLocoUpdate(int address)
Explicitly request an update for the specified loco.
Definition: DCCEXProtocol.cpp:261
-
DCCEXProtocol::deactivateLinearAccessory
void deactivateLinearAccessory(int linearAddress)
Deactivate DCC accessory at the specified linear address.
Definition: DCCEXProtocol.cpp:504
+
DCCEXProtocol::deactivateLinearAccessory
void deactivateLinearAccessory(int linearAddress)
Deactivate DCC accessory at the specified linear address.
Definition: DCCEXProtocol.cpp:509
DCCEXProtocol::setDelegate
void setDelegate(DCCEXProtocolDelegate *delegate)
Set the delegate object for callbacks.
Definition: DCCEXProtocol.cpp:66
DCCEXProtocol::requestServerVersion
void requestServerVersion()
Request server version information.
Definition: DCCEXProtocol.cpp:148
DCCEXProtocol::check
void check()
Check for incoming DCC-EX broadcasts/responses and parse them.
Definition: DCCEXProtocol.cpp:86
diff --git a/_sources/examples.rst.txt b/_sources/examples.rst.txt index c34dc5c..7768478 100644 --- a/_sources/examples.rst.txt +++ b/_sources/examples.rst.txt @@ -68,7 +68,7 @@ This ensures that the user of the throttle sees the accurate results of what the DCCEXProtocol_Track_type ------------------------------------ -This example demonstrates how client throttle software can change the Track type of any track/chanbel. (MAIN\|PROG\|DC\|DCX\|NONE) +This example demonstrates how client throttle software can change the Track type of any track/channel. (MAIN\|PROG\|DC\|DCX\|NONE) ---- diff --git a/bugs-requests.html b/bugs-requests.html index 305f10a..8ccf266 100644 --- a/bugs-requests.html +++ b/bugs-requests.html @@ -98,6 +98,7 @@
  • Consist::getSpeed()
  • Consist::getDirection()
  • Consist::getFirst()
  • +
  • Consist::getByAddress()
  • Consist::_addLocoToConsist()
  • Consist::_name
  • Consist::_locoCount
  • diff --git a/classConsist-members.html b/classConsist-members.html index 00151e7..46702e7 100644 --- a/classConsist-members.html +++ b/classConsist-members.html @@ -72,17 +72,18 @@ addLoco(Loco *loco, Facing facing)Consist addLoco(int address, Facing facing)Consist Consist()Consist - getDirection()Consist - getFirst()Consist - getLocoCount()Consist - getName()Consist - getSpeed()Consist - inConsist(Loco *loco)Consist - inConsist(int address)Consist - removeAllLocos()Consist - removeLoco(Loco *loco)Consist - setLocoFacing(Loco *loco, Facing facing)Consist - setName(char *name)Consist + getByAddress(int address)Consist + getDirection()Consist + getFirst()Consist + getLocoCount()Consist + getName()Consist + getSpeed()Consist + inConsist(Loco *loco)Consist + inConsist(int address)Consist + removeAllLocos()Consist + removeLoco(Loco *loco)Consist + setLocoFacing(Loco *loco, Facing facing)Consist + setName(char *name)Consist