Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
DccOutput.hxx File Reference
#include <atomic>
#include <cstdint>

Go to the source code of this file.

Classes

class  DccOutput
 Virtual base class for controlling outputs. More...
 
class  DccOutputImpl< HW >
 Default implementation class of the DccOutput that proxies the calls to a hardware-specific static structure. More...
 
struct  DccOutputHw< OUTPUT_NUMBER >
 This structure represents a single output channel for a DCC command station. More...
 
struct  DccOutputHwDummy< N >
 Interface that the actual outputs have to implement in their hardware-specific classes. More...
 
struct  DccOutputHwReal< N, BOOSTER_ENABLE, RAILCOM_ENABLE, DELAY_ON_1, DELAY_ON_2, DELAY_OFF >
 Generic implementation of the actual HW output with a booster enable and a railcom enable GPIO. More...
 

Functions

DccOutputget_dcc_output (DccOutput::Type type)
 Public API accessor for applications to get the object representing the output hardware.
 

Detailed Description

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.

Common definitions (base classes) for DCC output drivers. The role of the output driver is to control the output enable / disable and railcom cutout.

Author
Balazs Racz
Date
19 Apr 2020

Definition in file DccOutput.hxx.

Function Documentation

◆ get_dcc_output()

DccOutput * get_dcc_output ( DccOutput::Type  type)

Public API accessor for applications to get the object representing the output hardware.

Parameters
typewhich output reference to get.
Returns
an object to be used by the application to control the output.