Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openlcb::AliasInfo Struct Reference

Information we know locally about an NMRAnet CAN alias. More...

#include <AliasAllocator.hxx>

Public Types

enum  State {
  STATE_EMPTY = 0 , STATE_CHECKING , STATE_RESERVED , STATE_ASSIGNED ,
  STATE_CONFLICT
}
 

Public Member Functions

void reset ()
 
void do_not_reallocate ()
 

Public Attributes

uint16_t alias: 12
 The current alias.
 
uint16_t state: 3
 
uint16_t return_to_reallocation: 1
 

Detailed Description

Information we know locally about an NMRAnet CAN alias.

Definition at line 50 of file AliasAllocator.hxx.

Member Enumeration Documentation

◆ State

enum openlcb::AliasInfo::State

Definition at line 76 of file AliasAllocator.hxx.

Constructor & Destructor Documentation

◆ AliasInfo()

openlcb::AliasInfo::AliasInfo ( )
inline

Definition at line 52 of file AliasAllocator.hxx.

Member Function Documentation

◆ do_not_reallocate()

void openlcb::AliasInfo::do_not_reallocate ( )
inline

Definition at line 66 of file AliasAllocator.hxx.

◆ reset()

void openlcb::AliasInfo::reset ( )
inline

Definition at line 59 of file AliasAllocator.hxx.

Member Data Documentation

◆ alias

uint16_t openlcb::AliasInfo::alias

The current alias.

This is 0 if the alias needs to be generated.

Definition at line 72 of file AliasAllocator.hxx.

◆ return_to_reallocation

uint16_t openlcb::AliasInfo::return_to_reallocation

Definition at line 74 of file AliasAllocator.hxx.

◆ state

uint16_t openlcb::AliasInfo::state

Definition at line 73 of file AliasAllocator.hxx.


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