Ocean::DebugElements::ScopedHierarchyBase Class Reference

This class implements a scoped hierarchy. More...

#include <DebugElements.h>

Inheritance diagram for Ocean::DebugElements::ScopedHierarchyBase:

Public Member Functions
	~ScopedHierarchyBase ()
	Releases the hierarchy and disposes this object.
void	change (const std::string &newHierarchyItem)
	Explicitly exchanges the hierarchy instead of releasing it and creating a new one.
void	release ()
	Explicitly releases the hierarchy (already before the destructor is called).

Protected Member Functions
	ScopedHierarchyBase (const ScopedHierarchyBase &scopedHierarchy)=delete
	Disabled copy constructor.
	ScopedHierarchyBase (DebugElements &owner, const std::string &hierarchyItem)
	Creates a new scoped object and pushes the given hierarchy.
ScopedHierarchyBase &	operator= (const ScopedHierarchyBase &scopedHierarchy)=delete
	Disabled copy operator.

Protected Attributes
DebugElements &	owner_
	The owner of this object.
std::string	hierarchyItem_
	The hierarchy item of this object.

Detailed Description

This class implements a scoped hierarchy.

The hierarchy exists as long as this object exists.

Constructor & Destructor Documentation

~ScopedHierarchyBase()

Ocean::DebugElements::ScopedHierarchyBase::~ScopedHierarchyBase ( )

inline

Releases the hierarchy and disposes this object.

ScopedHierarchyBase() [1/2]

Ocean::DebugElements::ScopedHierarchyBase::ScopedHierarchyBase ( const ScopedHierarchyBase &  scopedHierarchy )

protecteddelete

Disabled copy constructor.

Parameters

scopedHierarchy

The hierarchy object which would have been copied

ScopedHierarchyBase() [2/2]

Ocean::DebugElements::ScopedHierarchyBase::ScopedHierarchyBase ( DebugElements &  owner, const std::string &  hierarchyItem  )

inlineprotected

Creates a new scoped object and pushes the given hierarchy.

Parameters

owner	The owner of the scoped object
hierarchyItem	The hierarchy item to be pushed, must be valid

Member Function Documentation

change()

void Ocean::DebugElements::ScopedHierarchyBase::change

(

const std::string &

newHierarchyItem

)

Explicitly exchanges the hierarchy instead of releasing it and creating a new one.

Actually pops the current hierarchy and pushes the new one.

Parameters

newHierarchyItem

The new hierarchy item to be pushed, must be valid

operator=()

ScopedHierarchyBase & Ocean::DebugElements::ScopedHierarchyBase::operator= ( const ScopedHierarchyBase &  scopedHierarchy )

protecteddelete

Disabled copy operator.

Parameters

scopedHierarchy

The hierarchy object which would have been copied

Returns

Reference to this object

release()

void Ocean::DebugElements::ScopedHierarchyBase::release

(

)

Explicitly releases the hierarchy (already before the destructor is called).

Field Documentation

hierarchyItem_

std::string Ocean::DebugElements::ScopedHierarchyBase::hierarchyItem_

protected

The hierarchy item of this object.

owner_

DebugElements& Ocean::DebugElements::ScopedHierarchyBase::owner_

protected

The owner of this object.

---

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

• DebugElements.h