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

Container of both a NodeID and NodeAlias. More...

#include <Defs.hxx>

Public Member Functions

 NodeHandle (NodeID _id)
 
 NodeHandle (NodeAlias _alias)
 
 NodeHandle (NodeID _id, NodeAlias _alias)
 
void clear ()
 Resets node handle to global (broadcast) handle.
 
bool operator== (const NodeHandle &o) const
 Compares two NodeHandle instances.
 

Public Attributes

NodeID id
 48-bit NMRAnet Node ID
 
NodeAlias alias
 alias to NMRAnet Node ID
 

Detailed Description

Container of both a NodeID and NodeAlias.

Definition at line 58 of file openlcb/Defs.hxx.

Constructor & Destructor Documentation

◆ NodeHandle() [1/4]

openlcb::NodeHandle::NodeHandle ( NodeID  _id)
inlineexplicit

Definition at line 63 of file openlcb/Defs.hxx.

◆ NodeHandle() [2/4]

openlcb::NodeHandle::NodeHandle ( NodeAlias  _alias)
inlineexplicit

Definition at line 64 of file openlcb/Defs.hxx.

◆ NodeHandle() [3/4]

openlcb::NodeHandle::NodeHandle ( NodeID  _id,
NodeAlias  _alias 
)
inline

Definition at line 65 of file openlcb/Defs.hxx.

◆ NodeHandle() [4/4]

openlcb::NodeHandle::NodeHandle ( )
inline

Definition at line 66 of file openlcb/Defs.hxx.

Member Function Documentation

◆ clear()

void openlcb::NodeHandle::clear ( )
inline

Resets node handle to global (broadcast) handle.

Definition at line 69 of file openlcb/Defs.hxx.

◆ operator==()

bool openlcb::NodeHandle::operator== ( const NodeHandle o) const
inline

Compares two NodeHandle instances.

Parameters
oobject to compare to
Returns
boolean result of compare

Definition at line 79 of file openlcb/Defs.hxx.

Member Data Documentation

◆ alias

NodeAlias openlcb::NodeHandle::alias

alias to NMRAnet Node ID

Definition at line 61 of file openlcb/Defs.hxx.

◆ id

NodeID openlcb::NodeHandle::id

48-bit NMRAnet Node ID

Definition at line 60 of file openlcb/Defs.hxx.


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