kamping::measurements::internal::TimerTreeNode< TimePoint, Duration > Class Template Reference

Class representing a node in the timer tree. Each node represents a time measurement (or multiple with the same key). A node can have multiple children which represent nested time measurements. The measurements associated with a node's children are executed while the node's measurement is still active. More...

#include <measurement_utils.hpp>

Inheritance diagram for kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >:

Collaboration diagram for kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >:

Public Member Functions
TimePoint	startpoint () const
	Returns the point in time at which the currently active measurement has been started.
void	startpoint (TimePoint start)
	Sets the point in time at which the currently active measurement has been started.
void	is_active (bool is_active)
	Sets the activity status of this node (i.e. is there a currently active measurement).
bool	is_active () const
	Getter for activity status.
Public Member Functions inherited from kamping::measurements::internal::TreeNode< TimerTreeNode< TimePoint, Duration > >
	TreeNode ()
	Constructs node without pointer to parent and empty name.
	TreeNode (std::string const &name)
	Constructs node without pointer to parent.
	TreeNode (std::string const &name, TimerTreeNode< TimePoint, Duration > *parent)
	Constructs node pointer to parent.
auto &	find_or_insert (std::string const &name)
	Searches the node's children for a node with the given name. If there is no such child a new node is inserted.
auto &	parent_ptr ()
	Access to the parent pointer.
auto const &	children () const
	Access to the node's children.
auto const &	name () const
	Access to the node's children.
Public Member Functions inherited from kamping::measurements::internal::NodeMeasurements< Duration, GlobalAggregationMode::max >
void	aggregate_measurements_locally (Duration const &datapoint, LocalAggregationMode const &mode)
	Add the result of a time measurement (i.e. a duration) to the node.
auto const &	measurements () const
	Access to stored duration(s).
auto &	measurements_aggregation_operations ()
	Access to the data aggregation operations (used during the evaluation).
auto const &	measurements_aggregation_operations () const
	Access to the data aggregation operations (used during the evaluation).

Detailed Description

template<typename TimePoint, typename Duration>
class kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >

Class representing a node in the timer tree. Each node represents a time measurement (or multiple with the same key). A node can have multiple children which represent nested time measurements. The measurements associated with a node's children are executed while the node's measurement is still active.

Template Parameters

TimePoint	Type of a point in time.
Duration	Type of a duration.

Member Function Documentation

is_active() [1/2]

template<typename TimePoint , typename Duration >

bool kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >::is_active ( ) const

inline

Getter for activity status.

Returns

Returns whether this node is associated with a currently active measurement.

is_active() [2/2]

template<typename TimePoint , typename Duration >

void kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >::is_active ( bool is_active )

inline

Sets the activity status of this node (i.e. is there a currently active measurement).

Parameters

is_active

Activity status to set.

startpoint() [1/2]

template<typename TimePoint , typename Duration >

TimePoint kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >::startpoint ( ) const

inline

Returns the point in time at which the currently active measurement has been started.

Returns

Point in time at which the currently active measurement has been started.

startpoint() [2/2]

template<typename TimePoint , typename Duration >

void kamping::measurements::internal::TimerTreeNode< TimePoint, Duration >::startpoint ( TimePoint start )

inline

Sets the point in time at which the currently active measurement has been started.

Parameters

start

New start point for currently active measurement.

---

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

• include/kamping/measurements/internal/measurement_utils.hpp