axom::sina::ID Class Reference

The ID of a Record. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sina/core/ID.hpp>

Public Member Functions
	ID (std::string id, IDType type)
	Create a new ID. More...
std::string const &	getId () const noexcept
	Get the value of the ID. More...
IDType	getType () const noexcept
	Get the type of the ID. More...

Detailed Description

The ID of a Record.

An ID is used to represent the ID of a Record. This class holds both the actual ID and whether it is a local or global ID.

Constructor & Destructor Documentation

ID()

axom::sina::ID::ID	(	std::string	id,
		IDType	type
	)

Create a new ID.

Parameters

id	the actual value of the ID
type	whether the ID is local or global

Member Function Documentation

getId()

std::string const& axom::sina::ID::getId ( ) const

inlinenoexcept

Get the value of the ID.

Returns

the actual ID

getType()

IDType axom::sina::ID::getType ( ) const

inlinenoexcept

Get the type of the ID.

Returns

whether the ID is local or global

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/sina/core/ID.hpp