TractionModem.hxx File Reference

#include "traction_modem/TractionModemDefs.hxx"
#include "hardware.hxx"
#include "executor/StateFlow.hxx"
#include "openlcb/MemoryConfig.hxx"
#include "openlcb/TrainInterface.hxx"
#include "utils/format_utils.hxx"

Go to the source code of this file.

Classes
struct	traction_modem::TxMessage
class	traction_modem::TxFlow
	Object responsible for writing messages to the modem interface. More...
class	traction_modem::RxFlow
	Object responsible for reading in a stream of bytes over the modem interface and forming the stream of bytes into complete messages. More...
class	traction_modem::CvSpace
class	traction_modem::ModemTrain

Namespaces
namespace	traction_modem

Typedefs
using	traction_modem::PacketFlowInterface = FlowInterface< Buffer< TxMessage > >
using	traction_modem::TxFlowBase = StateFlow< Buffer< TxMessage >, QList< 2 > >

Detailed Description

Copyright

Copyright (c) 2024, Balazs Racz All rights reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Class for interacting with the decoder chip via the traction modem protocol.

Author

Balazs Racz

Date

9 Feb 2024

Definition in file TractionModem.hxx.