Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openlcb::Identification Class Reference

Add this entry to the beginning of the CDI group to render an "<identification>" tag at the beginning of the output cdi.xml. More...

#include <ConfigRepresentation.hxx>

Inheritance diagram for openlcb::Identification:
openlcb::ToplevelEntryBase openlcb::ConfigEntryBase openlcb::ConfigReference

Public Types

using base_type = ToplevelEntryBase
 
- Public Types inherited from openlcb::ToplevelEntryBase
using base_type = ConfigEntryBase
 

Static Public Member Functions

static constexpr IdentificationRenderer config_renderer ()
 
- Static Public Member Functions inherited from openlcb::ToplevelEntryBase
template<typename... Args>
static constexpr GroupConfigOptions group_opts (Args... args)
 
static constexpr unsigned size ()
 
- Static Public Member Functions inherited from openlcb::ConfigEntryBase
template<typename... Args>
static constexpr GroupConfigOptions group_opts (Args... args)
 
static void handle_events (const EventOffsetCallback &fn)
 

Additional Inherited Members

- Public Member Functions inherited from openlcb::ToplevelEntryBase
constexpr unsigned end_offset () const
 
- Public Member Functions inherited from openlcb::ConfigReference
constexpr ConfigReference (unsigned offset)
 Initializes the config reference from a configuration space offset.
 
constexpr ConfigReference (const ConfigReference &ref)
 Initializes the config reference from an existing config reference.
 
constexpr unsigned offset () const
 
- Protected Member Functions inherited from openlcb::ConfigEntryBase
template<class T >
raw_read (int fd) const
 Reads a given typed variable from the configuration file.
 
template<class T >
void raw_write (int fd, const T &value) const
 Writes a given typed variable to the configuration file.
 
void repeated_read (int fd, void *buf, size_t size) const
 Performs a reliable read from the given FD.
 
void repeated_write (int fd, const void *buf, size_t size) const
 Performs a reliable write to the given FD.
 
- Protected Attributes inherited from openlcb::ConfigReference
unsigned offset_
 zero-based offset from the beginning of the configuration file.
 

Detailed Description

Add this entry to the beginning of the CDI group to render an "<identification>" tag at the beginning of the output cdi.xml.

Requires a global symbol of openlcb::SNIP_STATIC_DATA to fill in the specific values of the identification tree.

Definition at line 430 of file ConfigRepresentation.hxx.

Member Typedef Documentation

◆ base_type

Member Function Documentation

◆ config_renderer()

static constexpr IdentificationRenderer openlcb::Identification::config_renderer ( )
inlinestaticconstexpr

Definition at line 435 of file ConfigRepresentation.hxx.


The documentation for this class was generated from the following file: