ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::ObjectId Struct Reference

Strongly typed integer type to hold a unique identifier for a ObjectHandle object, using its memory address. More...

#include <ObjectId.hpp>

Public Types

using value_type = std::size_t
 

Public Member Functions

 ObjectId ()=default
 
 ObjectId (ObjectHandle const *p)
 
constexpr bool operator== (ObjectId const &) const =default
 
constexpr bool operator!= (ObjectId const &) const =default
 

Public Attributes

value_type m_id
 

Friends

class boost::serialization::access
 

Detailed Description

Strongly typed integer type to hold a unique identifier for a ObjectHandle object, using its memory address.

Therefore, this object can only be constructed from a ObjectHandle object on the head node.

Definition at line 37 of file ObjectId.hpp.

Member Typedef Documentation

◆ value_type

Definition at line 41 of file ObjectId.hpp.

Constructor & Destructor Documentation

◆ ObjectId() [1/2]

ScriptInterface::ObjectId::ObjectId ( )
default

◆ ObjectId() [2/2]

ScriptInterface::ObjectId::ObjectId ( ObjectHandle const p)
inline

Definition at line 46 of file ObjectId.hpp.

Member Function Documentation

◆ operator!=()

constexpr bool ScriptInterface::ObjectId::operator!= ( ObjectId const ) const
constexprdefault

◆ operator==()

constexpr bool ScriptInterface::ObjectId::operator== ( ObjectId const ) const
constexprdefault

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 54 of file ObjectId.hpp.

Member Data Documentation

◆ m_id

value_type ScriptInterface::ObjectId::m_id

Definition at line 51 of file ObjectId.hpp.


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