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

Base class for all entries that can appear in the MainCdi group. More...

#include <ConfigRepresentation.hxx>

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

Public Types

using base_type = ConfigEntryBase
 

Public Member Functions

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
 

Static Public Member Functions

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

- 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

Base class for all entries that can appear in the MainCdi group.

THe common property of these entries is that they do not rely on the offset/size propagation of the previous entries, because they either do not take part in the layout algorithm (e.g. the <identification> tag) or they specify the origin explcitly.

Definition at line 406 of file ConfigRepresentation.hxx.

Member Typedef Documentation

◆ base_type

Member Function Documentation

◆ end_offset()

constexpr unsigned openlcb::ToplevelEntryBase::end_offset ( ) const
inlineconstexpr

Definition at line 420 of file ConfigRepresentation.hxx.

◆ group_opts()

template<typename... Args>
static constexpr GroupConfigOptions openlcb::ToplevelEntryBase::group_opts ( Args...  args)
inlinestaticconstexpr

Definition at line 412 of file ConfigRepresentation.hxx.

◆ size()

static constexpr unsigned openlcb::ToplevelEntryBase::size ( )
inlinestaticconstexpr

Definition at line 416 of file ConfigRepresentation.hxx.


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