catapult::state::Namespace Class Reference

A catapult namespace. More...

Collaboration diagram for catapult::state::Namespace:

Public Types
using	Path = utils::CheckedArray< NamespaceId, Namespace_Max_Depth >

Public Member Functions
	Namespace (const Path &path)
	Creates a namespace around path. More...
NamespaceId	id () const
	Gets the namespace id. More...
NamespaceId	parentId () const
	Gets the parent namespace id. More...
NamespaceId	rootId () const
	Gets the corresponding root namespace id. More...
bool	isRoot () const
	Gets a value indicating whether or not this namespace is a root namespace. More...
const Path &	path () const
	Gets the path. More...
Namespace	createChild (NamespaceId id) const
	Creates a child namespace of this namespace with namespace identifier id. More...
bool	operator== (const Namespace &rhs) const
	Returns true if this namespace is equal to rhs. More...
bool	operator!= (const Namespace &rhs) const
	Returns true if this namespace is not equal to rhs. More...

Private Attributes
Path	m_path

Detailed Description

A catapult namespace.

Member Typedef Documentation

Path

using catapult::state::Namespace::Path = utils::CheckedArray<NamespaceId, Namespace_Max_Depth>

Constructor & Destructor Documentation

Namespace()

catapult::state::Namespace::Namespace ( const Path &  path )

inlineexplicit

Creates a namespace around path.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

createChild()

Namespace catapult::state::Namespace::createChild ( NamespaceId  id ) const

inline

Creates a child namespace of this namespace with namespace identifier id.

Here is the call graph for this function:

id()

NamespaceId catapult::state::Namespace::id ( ) const

inline

Gets the namespace id.

Here is the call graph for this function:

Here is the caller graph for this function:

isRoot()

bool catapult::state::Namespace::isRoot ( ) const

inline

Gets a value indicating whether or not this namespace is a root namespace.

Here is the call graph for this function:

operator!=()

bool catapult::state::Namespace::operator!= ( const Namespace &  rhs ) const

inline

Returns true if this namespace is not equal to rhs.

operator==()

bool catapult::state::Namespace::operator== ( const Namespace &  rhs ) const

inline

Returns true if this namespace is equal to rhs.

parentId()

NamespaceId catapult::state::Namespace::parentId ( ) const

inline

Gets the parent namespace id.

Here is the call graph for this function:

Here is the caller graph for this function:

path()

const Path& catapult::state::Namespace::path ( ) const

inline

Gets the path.

Here is the caller graph for this function:

rootId()

NamespaceId catapult::state::Namespace::rootId ( ) const

inline

Gets the corresponding root namespace id.

Here is the caller graph for this function:

Member Data Documentation

m_path

Path catapult::state::Namespace::m_path

private

---

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

• Namespace.h