PersonId Struct Reference

CPP API: mio::abm::PersonId Struct Reference

Unique ID for a Person within a Model. More...

#include <person_id.h>

Inheritance diagram for mio::abm::PersonId:
Collaboration diagram for mio::abm::PersonId:

Public Member Functions

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

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from mio::TypeSafe< uint64_t, PersonId >
using ValueType = uint64_t
 

Detailed Description

Unique ID for a Person within a Model.

Constructor & Destructor Documentation

◆ PersonId() [1/2]

mio::abm::PersonId::PersonId ( uint64_t  id)
inline

Create an ID.

◆ PersonId() [2/2]

mio::abm::PersonId::PersonId ( )
inline

Create an invalid ID.

Member Function Documentation

◆ invalid_ID()

static const PersonId mio::abm::PersonId::invalid_ID ( )
inlinestatic

Value for invalid IDs.