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

Class representing a particular location in the configuration space. More...

#include <ConfigEntry.hxx>

Inheritance diagram for openlcb::ConfigReference:
openlcb::ConfigEntryBase openlcb::GroupBase openlcb::GroupBaseEntry openlcb::NoopGroupEntry openlcb::BytesConfigEntry< SIZE > openlcb::EmptyGroup< N > openlcb::NumericConfigEntry< TR > openlcb::RepeatedGroup< Group, N > openlcb::StringConfigEntry< SIZE > openlcb::ToplevelEntryBase openlcb::EventConfigEntry openlcb::Acdi openlcb::Identification

Public Member Functions

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 Attributes

unsigned offset_
 zero-based offset from the beginning of the configuration file.
 

Detailed Description

Class representing a particular location in the configuration space.

All typed configuration objects (atoms as well as groups) will be subclasses of this.

Definition at line 53 of file ConfigEntry.hxx.

Constructor & Destructor Documentation

◆ ConfigReference() [1/2]

constexpr openlcb::ConfigReference::ConfigReference ( unsigned  offset)
inlineexplicitconstexpr

Initializes the config reference from a configuration space offset.

Parameters
offsetis the integer offset (0-based) in the address space for configuration.

Definition at line 60 of file ConfigEntry.hxx.

◆ ConfigReference() [2/2]

constexpr openlcb::ConfigReference::ConfigReference ( const ConfigReference ref)
inlineexplicitconstexpr

Initializes the config reference from an existing config reference.

Parameters
refis the existing (or saved) config reference.

Definition at line 68 of file ConfigEntry.hxx.

Member Function Documentation

◆ offset()

constexpr unsigned openlcb::ConfigReference::offset ( ) const
inlineconstexpr

Definition at line 73 of file ConfigEntry.hxx.

Member Data Documentation

◆ offset_

unsigned openlcb::ConfigReference::offset_
protected

zero-based offset from the beginning of the configuration file.

Definition at line 80 of file ConfigEntry.hxx.


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