This class implements the base class for a container for debug elements. More...

#include <DebugElements.h>

Inheritance diagram for Ocean::DebugElements:

Data Structures
class	ScopedHierarchyBase
	This class implements a scoped hierarchy. More...

Public Types
typedef std::vector< std::string >	Hierarchy
	Definition of a vector holding strings (a hierarchy).

typedef Callback< void, const uint32_t, const Frame , const Hierarchy >	ElementUpdateCallback
	Definition of a callback function for an updated debug element.

Public Member Functions
bool	isElementActive (const uint32_t elementId) const
	Returns whether a specific debug elements is activated.

void	activateElement (const uint32_t elementId)
	Activates a specific debug element.

void	deactivateElement (const uint32_t elementId)
	Deactivates a specific debug element.

void	activateAllElements ()
	Explicitly activates all elements (to avoid defining all active elements individually).

void	pushHierarchyItem (const std::string &hierarchyItem)
	Pushes a new hierarchy.

void	popHierarchyItem ()
	Pops the most recent hierarchy item.

void	updateElement (const uint32_t elementId, Frame &&frame)
	Updates the debug information of a specific debug element.

void	updateElement (const uint32_t elementId, Frame &&frame, const Hierarchy &explicitHierarchy)
	Updates the debug information of a specific debug element.

void	updateElement (const uint32_t elementId, const Frame &frame)
	Updates the debug information of a specific debug element.

void	updateElement (const uint32_t elementId, const Frame &frame, const Hierarchy &explicitHierarchy)
	Updates the debug information of a specific debug element.

Frame	element (const uint32_t elementId, const bool popElement=false)
	Returns the most recent debug frame of a specific debug element.

Frame	element (const uint32_t elementId, const Hierarchy &hierarchy, const bool popElement=false)
	Returns the most recent debug frame of a specific debug element.

bool	elementIfActivate (const uint32_t elementId, Frame &frame, const bool popElement=false)
	Returns the most recent debug frame of a specific debug element if the debug element is activate and exists.

bool	elementIfActivate (const uint32_t elementId, Frame &frame, const Hierarchy &hierarchy, const bool popElement=false)
	Returns the most recent debug frame of a specific debug element if the debug element is activate and exists.

std::vector< Hierarchy >	hierarchies (const uint32_t elementId) const
	Returns all existing hierarchies for a given element id.

void	setElementUpdateCallback (const ElementUpdateCallback &callback)
	Sets the optional callback function for updated debug element.

Protected Types
typedef std::map< Hierarchy, Frame >	HierarchyMap
	Definition of a map mapping hierarchies to frames.

typedef std::map< uint32_t, HierarchyMap >	ElementMap
	Definition of a map mapping element ids to hierarchy maps.

typedef std::unordered_set< uint32_t >	ElementSet
	Definition of a set holding element ids.

Protected Member Functions
	DebugElements ()
	Protected default constructor.

Protected Attributes
ElementSet	activeElements_
	The set holding activate debug element ids.

bool	allElementsActivate_
	True, if all debug elements are activated (this state overrides the individual ids of `activeIds_`).

ElementMap	elementMap_
	The map mapping ids to frames.

Hierarchy	hierarchy_
	The current hierarchy.

ElementUpdateCallback	elementUpdateCallback_
	Optional callback function for updated debug elements.

Lock	lock_
	The data lock.

Detailed Description

This class implements the base class for a container for debug elements.

To use this class, create an own singleton class and derive from this object.

Member Typedef Documentation

◆ ElementMap

typedef std::map<uint32_t, HierarchyMap> Ocean::DebugElements::ElementMap

protected

Definition of a map mapping element ids to hierarchy maps.

◆ ElementSet

typedef std::unordered_set<uint32_t> Ocean::DebugElements::ElementSet

protected

Definition of a set holding element ids.

◆ ElementUpdateCallback

typedef Callback<void, const uint32_t, const Frame*, const Hierarchy*> Ocean::DebugElements::ElementUpdateCallback

Definition of a callback function for an updated debug element.

◆ Hierarchy

typedef std::vector<std::string> Ocean::DebugElements::Hierarchy

Definition of a vector holding strings (a hierarchy).

◆ HierarchyMap

typedef std::map<Hierarchy, Frame> Ocean::DebugElements::HierarchyMap

protected

Definition of a map mapping hierarchies to frames.

Constructor & Destructor Documentation

◆ DebugElements()

Ocean::DebugElements::DebugElements ( )

inlineprotected

Protected default constructor.

Member Function Documentation

◆ activateAllElements()

void Ocean::DebugElements::activateAllElements ( )

Explicitly activates all elements (to avoid defining all active elements individually).

Beware: Activating a couple of debug elements (and preparing the debug data in particular) can reduce the performance.

◆ activateElement()

void Ocean::DebugElements::activateElement ( const uint32_t elementId )

Activates a specific debug element.

Parameters

elementId The id of the element to activate

See also: isElementActivated(), deactivateElement().

◆ deactivateElement()

void Ocean::DebugElements::deactivateElement ( const uint32_t elementId )

Deactivates a specific debug element.

Parameters

elementId The id of the element to activate

See also: activateElement().

◆ element() [1/2]

Frame Ocean::DebugElements::element	(	const uint32_t	elementId,
		const bool	popElement = `false`
	)

Returns the most recent debug frame of a specific debug element.

If more than one debug element with individual hierarchies exist, one of the elements will be returned.
Beware: Due to performance reasons, the specific debug element must be activated before calling this function.

Parameters

elementId	The id for which the frame will be returned
popElement	True, to remove the debug element; False, to keep the debug element until it gets updated again

Returns: The copy of the frame which is associated with the id, an invalid frame in case the id does not exist

See also: isElementActive().

◆ element() [2/2]

Frame Ocean::DebugElements::element	(	const uint32_t	elementId,
		const Hierarchy &	hierarchy,
		const bool	popElement = `false`
	)

Returns the most recent debug frame of a specific debug element.

Beware: Due to performance reasons, the specific debug element must be activated before calling this function.

Parameters

elementId	The id for which the frame will be returned
hierarchy	The hierarchy for which the element will be returned
popElement	True, to remove the debug element; False, to keep the debug element until it gets updated again

Returns: The copy of the frame which is associated with the id, an invalid frame in case the id does not exist

See also: isElementActive().

◆ elementIfActivate() [1/2]

bool Ocean::DebugElements::elementIfActivate	(	const uint32_t	elementId,
		Frame &	frame,
		const bool	popElement = `false`
	)

Returns the most recent debug frame of a specific debug element if the debug element is activate and exists.

If more than one debug element with individual hierarchies exist, one of the elements will be returned.

Parameters

elementId	The id for which the frame will be returned
frame	The resulting copy of the debug frame which is associated with the id
popElement	True, to remove the debug element; False, to keep the debug element until it gets updated again

Returns: True, if the debug element is activate and exists

◆ elementIfActivate() [2/2]

bool Ocean::DebugElements::elementIfActivate	(	const uint32_t	elementId,
		Frame &	frame,
		const Hierarchy &	hierarchy,
		const bool	popElement = `false`
	)

Returns the most recent debug frame of a specific debug element if the debug element is activate and exists.

Parameters

elementId	The id for which the frame will be returned
frame	The resulting copy of the debug frame which is associated with the id
hierarchy	The hierarchy for which the element will be returned
popElement	True, to remove the debug element; False, to keep the debug element until it gets updated again

Returns: True, if the debug element is activate and exists

◆ hierarchies()

std::vector< Hierarchy > Ocean::DebugElements::hierarchies ( const uint32_t elementId ) const

Returns all existing hierarchies for a given element id.

Parameters

elementId The id for which all hierarchies will be returned

Returns: The hierarchies of the element, an empty vector if the element does not exist

◆ isElementActive()

bool Ocean::DebugElements::isElementActive ( const uint32_t elementId ) const

Returns whether a specific debug elements is activated.

Call this function before preparing the debug information (and updating via updateElement) to reduce the performance overhead when debugging.

Parameters

elementId The id for which the activation state is returned

Returns: True, if the debug element is activate; False, if the debug element is deactivated

◆ popHierarchyItem()

void Ocean::DebugElements::popHierarchyItem ( )

Pops the most recent hierarchy item.

◆ pushHierarchyItem()

void Ocean::DebugElements::pushHierarchyItem ( const std::string & hierarchyItem )

Pushes a new hierarchy.

Parameters

hierarchyItem The hierarchy item to be pushed

◆ setElementUpdateCallback()

void Ocean::DebugElements::setElementUpdateCallback ( const ElementUpdateCallback & callback )

inline

Sets the optional callback function for updated debug element.

The callback function will be called whenever a debug element is updated.

Parameters

callback The callback function to be set, can be invalid to remove a previously set function

◆ updateElement() [1/4]

void Ocean::DebugElements::updateElement	(	const uint32_t	elementId,
		const Frame &	frame
	)

Updates the debug information of a specific debug element.

Beware: Due to performance reasons, the specific debug element must be activated before it can be updated,
as the preparation of debug information for disabled elements can be skipped.

Parameters

elementId	The id of the debug element, should be a value from `DebugId`
frame	The new debug frame of the debug element, will be copied

See also: activateElement(), activateAllElements().

◆ updateElement() [2/4]

void Ocean::DebugElements::updateElement	(	const uint32_t	elementId,
		const Frame &	frame,
		const Hierarchy &	explicitHierarchy
	)

Updates the debug information of a specific debug element.

Beware: Due to performance reasons, the specific debug element must be activated before it can be updated,
as the preparation of debug information for disabled elements can be skipped.

Parameters

elementId	The id of the debug element, should be a value from `DebugId`
frame	The new debug frame of the debug element, will be copied
explicitHierarchy	The explicit hierarchy which will be used instead of the actual internal known hierarchy

See also: activateElement(), activateAllElements().

◆ updateElement() [3/4]

void Ocean::DebugElements::updateElement	(	const uint32_t	elementId,
		Frame &&	frame
	)

Updates the debug information of a specific debug element.

In case one (or several) sub-element bits are set, the element with matching sub-element bit mask will be updated only. Beware: Due to performance reasons, the specific debug element must be activated before it can be updated,
as the preparation of debug information for disabled elements can be skipped.

Parameters

elementId	The id of the debug element, should be a value from `DebugId`
frame	The new debug frame of the debug element, will be moved

See also: setSubElementBit(), activateElement().

◆ updateElement() [4/4]

void Ocean::DebugElements::updateElement	(	const uint32_t	elementId,
		Frame &&	frame,
		const Hierarchy &	explicitHierarchy
	)

Updates the debug information of a specific debug element.

In case one (or several) sub-element bits are set, the element with matching sub-element bit mask will be updated only. Beware: Due to performance reasons, the specific debug element must be activated before it can be updated,
as the preparation of debug information for disabled elements can be skipped.

Parameters

elementId	The id of the debug element, should be a value from `DebugId`
frame	The new debug frame of the debug element, will be moved
explicitHierarchy	The explicit hierarchy which will be used instead of the actual internal known hierarchy

See also: setSubElementBit(), activateElement().

Field Documentation

◆ activeElements_

ElementSet Ocean::DebugElements::activeElements_

protected

The set holding activate debug element ids.

◆ allElementsActivate_

bool Ocean::DebugElements::allElementsActivate_

protected

True, if all debug elements are activated (this state overrides the individual ids of activeIds_).

◆ elementMap_

ElementMap Ocean::DebugElements::elementMap_

protected

The map mapping ids to frames.

◆ elementUpdateCallback_

ElementUpdateCallback Ocean::DebugElements::elementUpdateCallback_

protected

Optional callback function for updated debug elements.

◆ hierarchy_

Hierarchy Ocean::DebugElements::hierarchy_

protected

The current hierarchy.

◆ lock_

Lock Ocean::DebugElements::lock_

mutableprotected

The data lock.

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

DebugElements.h

Data Structures

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ElementMap

◆ ElementSet

◆ ElementUpdateCallback

◆ Hierarchy

◆ HierarchyMap

Constructor & Destructor Documentation

◆ DebugElements()

Member Function Documentation

◆ activateAllElements()

◆ activateElement()

◆ deactivateElement()

◆ element() [1/2]

◆ element() [2/2]

◆ elementIfActivate() [1/2]

◆ elementIfActivate() [2/2]

◆ hierarchies()

◆ isElementActive()

◆ popHierarchyItem()

◆ pushHierarchyItem()

◆ setElementUpdateCallback()

◆ updateElement() [1/4]

◆ updateElement() [2/4]

◆ updateElement() [3/4]

◆ updateElement() [4/4]

Field Documentation

◆ activeElements_

◆ allElementsActivate_

◆ elementMap_

◆ elementUpdateCallback_

◆ hierarchy_

◆ lock_