LocationId Struct Reference

CPP API: mio::abm::LocationId Struct Reference

Unique identifier for a Location within a Model. More...

#include <location_id.h>

Inheritance diagram for mio::abm::LocationId:
Collaboration diagram for mio::abm::LocationId:

Public Member Functions

 LocationId ()
 Create an invalid ID. More...
 
 LocationId (uint32_t id)
 Create an ID. More...
 
- Public Member Functions inherited from mio::TypeSafe< uint32_t, LocationId >
uint32_t get () const
 
 operator uint32_t () const
 conversion to underlying type. More...
 
void serialize (IOContext &io) const
 serialize this. More...
 
 TypeSafe ()=default
 default constructor. More...
 
 TypeSafe (uint32_t t)
 value constructor. More...
 
- Public Member Functions inherited from mio::OperatorComparison< LocationId >
bool operator< (const LocationId &other) const
 
bool operator<= (const LocationId &other) const
 
bool operator> (const LocationId &other) const
 
bool operator>= (const LocationId &other) const
 

Static Public Member Functions

static const LocationId invalid_id ()
 Value for invalid IDs. More...
 
- Static Public Member Functions inherited from mio::TypeSafe< uint32_t, LocationId >
static IOResult< LocationIddeserialize (IOContext &io)
 deserialize an object of this class. More...
 

Additional Inherited Members

- Public Types inherited from mio::TypeSafe< uint32_t, LocationId >
using ValueType = uint32_t
 

Detailed Description

Unique identifier for a Location within a Model.

Constructor & Destructor Documentation

◆ LocationId() [1/2]

mio::abm::LocationId::LocationId ( uint32_t  id)
inline

Create an ID.

◆ LocationId() [2/2]

mio::abm::LocationId::LocationId ( )
inline

Create an invalid ID.

Member Function Documentation

◆ invalid_id()

static const LocationId mio::abm::LocationId::invalid_id ( )
inlinestatic

Value for invalid IDs.