Stores the global definitions of a tracing experiment.

#include <pearl/GlobalDefs.h>

Public Member Functions
Query functions for CallingContext definitions
std::size_t	numCallingContexts () const
	Get number of CallingContext definitions. More...

const CallingContext &	getCallingContext (CallingContext::IdType id) const
	CallingContext lookup by identifier. More...

const CallingContext &	getCallingContextByIndex (std::size_t index) const
	CallingContext lookup by index. More...

Query functions for Callpath definitions
std::size_t	numCallpaths () const
	Get number of Callpath definitions. More...

const Callpath &	getCallpath (Callpath::IdType id) const
	Callpath lookup by identifier. More...

const Callpath &	getCallpathByIndex (std::size_t index) const
	Callpath lookup by index. More...

Query functions for Callsite definitions
std::size_t	numCallsites () const
	Get number of Callsite definitions. More...

const Callsite &	getCallsite (Callsite::IdType id) const
	Callsite lookup by identifier. More...

const Callsite &	getCallsiteByIndex (std::size_t index) const
	Callsite lookup by index. More...

Query functions for CartDimension definitions
std::size_t	numCartDimensions () const
	Get number of CartDimension definitions. More...

const CartDimension &	getCartDimension (CartDimension::IdType id) const
	CartDimension lookup by identifier. More...

const CartDimension &	getCartDimensionByIndex (std::size_t index) const
	CartDimension lookup by index. More...

Query functions for CartTopology definitions
std::size_t	numCartTopologies () const
	Get number of CartTopology definitions. More...

const CartTopology &	getCartTopology (CartTopology::IdType id) const
	CartTopology lookup by identifier. More...

const CartTopology &	getCartTopologyByIndex (std::size_t index) const
	CartTopology lookup by index. More...

Query functions for Communicator definitions
std::size_t	numCommunicators () const
	Get number of Communicator definitions. More...

const Communicator &	getCommunicator (Communicator::IdType id) const
	Communicator lookup by identifier. More...

const Communicator &	getCommunicatorByIndex (std::size_t index) const
	Communicator lookup by index. More...

Query functions for GroupingSet definitions
std::size_t	numGroupingSets () const
	Get number of GroupingSet definitions. More...

const GroupingSet &	getGroupingSet (GroupingSet::IdType id) const
	GroupingSet lookup by identifier. More...

const GroupingSet &	getGroupingSetByIndex (std::size_t index) const
	GroupingSet lookup by index. More...

Query functions for Location definitions
std::size_t	numLocations () const
	Get number of Location definitions. More...

const Location &	getLocation (Location::IdType id) const
	Location lookup by identifier. More...

const Location &	getLocationByIndex (std::size_t index) const
	Location lookup by index. More...

Query functions for LocationGroup definitions
std::size_t	numLocationGroups () const
	Get number of LocationGroup definitions. More...

const LocationGroup &	getLocationGroup (LocationGroup::IdType id) const
	LocationGroup lookup by identifier. More...

const LocationGroup &	getLocationGroupByIndex (std::size_t index) const
	LocationGroup lookup by index. More...

Query functions for Metric definitions
std::size_t	numMetrics () const
	Get number of Metric definitions. More...

const Metric &	getMetric (Metric::IdType id) const
	Metric lookup by identifier. More...

const Metric &	getMetricByIndex (std::size_t index) const
	Metric lookup by index. More...

Query functions for Region definitions
std::size_t	numRegions () const
	Get number of Region definitions. More...

const Region &	getRegion (Region::IdType id) const
	Region lookup by identifier. More...

const Region &	getRegionByIndex (std::size_t index) const
	Region lookup by index. More...

Query functions for RmaWindow definitions
std::size_t	numRmaWindows () const
	Get number of RmaWindow definitions. More...

const RmaWindow &	getRmaWindow (RmaWindow::IdType id) const
	RmaWindow lookup by identifier. More...

const RmaWindow &	getRmaWindowByIndex (std::size_t index) const
	RmaWindow lookup by index. More...

Query functions for SourceLocation definitions
std::size_t	numSourceLocations () const
	Get number of SourceLocation definitions. More...

const SourceLocation &	getSourceLocation (SourceLocation::IdType id) const
	SourceLocation lookup by identifier. More...

const SourceLocation &	getSourceLocationByIndex (std::size_t index) const
	SourceLocation lookup by index. More...

Query functions for String definitions
std::size_t	numStrings () const
	Get number of String definitions. More...

const String &	getString (String::IdType id) const
	String lookup by identifier. More...

const String &	getStringByIndex (std::size_t index) const
	String lookup by index. More...

Query functions for SystemNode definitions
std::size_t	numSystemNodes () const
	Get number of SystemNode definitions. More...

const SystemNode &	getSystemNode (SystemNode::IdType id) const
	SystemNode lookup by identifier. More...

const SystemNode &	getSystemNodeByIndex (std::size_t index) const
	SystemNode lookup by index. More...

Get stored definitions by ID
Callpath *	get_cnode (Callpath::IdType id) const

GroupingSet *	get_group (GroupingSet::IdType id) const

Communicator *	get_comm (Communicator::IdType id) const

RmaWindow *	get_window (RmaWindow::IdType id) const

Get internal regions
const Region &	getPausingRegion () const

const Region &	getFlushingRegion () const

const Region &	getTaskRootRegion () const

const Region &	getThreadRootRegion () const

Protected Types
typedef detail::DefinitionTree< CallingContext >	CallingContextContainer
	Container type for CallingContext definitions. More...

typedef detail::DefinitionContainer< Callsite >	CallsiteContainer
	Container type for Callsite definitions. More...

typedef detail::DefinitionContainer< CartDimension >	CartDimensionContainer
	Container type for CartDimension definitions. More...

typedef detail::DefinitionContainer< CartTopology >	CartTopologyContainer
	Container type for CartTopology definitions. More...

typedef detail::DefinitionContainer< Communicator >	CommunicatorContainer
	Container type for Communicator definitions. More...

typedef detail::DefinitionContainer< GroupingSet >	GroupingSetContainer
	Container type for GroupingSet definitions. More...

typedef detail::DefinitionContainer< Location >	LocationContainer
	Container type for Location definitions. More...

typedef detail::DefinitionContainer< LocationGroup >	LocationGroupContainer
	Container type for LocationGroup definitions. More...

typedef detail::DefinitionContainer< Metric >	MetricContainer
	Container type for Metric definitions. More...

typedef detail::DefinitionContainer< Region >	RegionContainer
	Container type for Region definitions. More...

typedef detail::DefinitionContainer< RmaWindow >	RmaWindowContainer
	Container type for RmaWindow definitions. More...

typedef detail::DefinitionContainer< SourceLocation >	SourceLocationContainer
	Container type for SourceLocation definitions. More...

typedef detail::DefinitionContainer< String >	StringContainer
	Container type for String definitions. More...

typedef detail::DefinitionTree< SystemNode >	SystemNodeContainer
	Container type for SystemNode definitions. More...

Protected Attributes
const ScopedPtr< CallingContextContainer >	mContextTree
	Global calling context tree → CallingContext definitions. More...

ScopedPtr< detail::CallTree >	mCallTree
	Global call tree → Callpath definitions. More...

const ScopedPtr< CallsiteContainer >	mCallsites
	Callsite definitions More...

const ScopedPtr< CartDimensionContainer >	mCartDimensions
	CartDimension definitions More...

const ScopedPtr< CartTopologyContainer >	mCartTopologies
	CartTopology definitions More...

const ScopedPtr< CommunicatorContainer >	mCommunicators
	Communicator definitions More...

const ScopedPtr< GroupingSetContainer >	mGroupingSets
	GroupingSet definitions More...

const ScopedPtr< LocationContainer >	mLocations
	Location definitions More...

const ScopedPtr< LocationGroupContainer >	mLocationGroups
	LocationGroup definitions More...

const ScopedPtr< MetricContainer >	mMetrics
	Metric definitions More...

const ScopedPtr< RegionContainer >	mRegions
	Region definitions More...

const ScopedPtr< RmaWindowContainer >	mRmaWindows
	RmaWindow definitions More...

const ScopedPtr< SourceLocationContainer >	mSourceLocations
	SourceLocation definitions More...

const ScopedPtr< StringContainer >	mStrings
	String definitions More...

const ScopedPtr< SystemNodeContainer >	mSystemTree
	Global system hierarchy → SystemNode definitions. More...

Region *	mPausingRegion
	Pointer to a Region object representing code regions where measurement was temporarily turned off by the user. More...

Region *	mFlushingRegion
	Pointer to a Region object representing a trace buffer flush triggered by the measurement system. More...

Region *	mTaskRootRegion
	Pointer to a Region object representing the task root in the generic tasking model. More...

Region *	mThreadRootRegion
	Pointer to a Region object representing the THREADS root node for create/wait threading models. More...

Constructors & destructor
virtual	~GlobalDefs ()
	Destructor. More...

	GlobalDefs ()
	Default constructor. More...

Member Typedef Documentation

◆ CallingContextContainer

typedef detail::DefinitionTree< CallingContext > pearl::GlobalDefs::CallingContextContainer

protected

◆ CallsiteContainer

typedef detail::DefinitionContainer< Callsite > pearl::GlobalDefs::CallsiteContainer

protected

◆ CartDimensionContainer

typedef detail::DefinitionContainer< CartDimension > pearl::GlobalDefs::CartDimensionContainer

protected

◆ CartTopologyContainer

typedef detail::DefinitionContainer< CartTopology > pearl::GlobalDefs::CartTopologyContainer

protected

◆ CommunicatorContainer

typedef detail::DefinitionContainer< Communicator > pearl::GlobalDefs::CommunicatorContainer

protected

◆ GroupingSetContainer

typedef detail::DefinitionContainer< GroupingSet > pearl::GlobalDefs::GroupingSetContainer

protected

◆ LocationContainer

typedef detail::DefinitionContainer< Location > pearl::GlobalDefs::LocationContainer

protected

◆ LocationGroupContainer

typedef detail::DefinitionContainer< LocationGroup > pearl::GlobalDefs::LocationGroupContainer

protected

◆ MetricContainer

typedef detail::DefinitionContainer< Metric > pearl::GlobalDefs::MetricContainer

protected

◆ RegionContainer

typedef detail::DefinitionContainer< Region > pearl::GlobalDefs::RegionContainer

protected

◆ RmaWindowContainer

typedef detail::DefinitionContainer< RmaWindow > pearl::GlobalDefs::RmaWindowContainer

protected

◆ SourceLocationContainer

typedef detail::DefinitionContainer< SourceLocation > pearl::GlobalDefs::SourceLocationContainer

protected

◆ StringContainer

typedef detail::DefinitionContainer< String > pearl::GlobalDefs::StringContainer

protected

◆ SystemNodeContainer

typedef detail::DefinitionTree< SystemNode > pearl::GlobalDefs::SystemNodeContainer

protected

Constructor & Destructor Documentation

◆ ~GlobalDefs()

virtual pearl::GlobalDefs::~GlobalDefs ( )

virtual

Destroys the GlobalDefs instance. This implicitly deletes all global definition objects stored for the tracing experiment.

            \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ GlobalDefs()

pearl::GlobalDefs::GlobalDefs ( )

protected

Constructs a new, empty instance.

            \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

std::bad_alloc on failure to allocate storage space

Member Function Documentation

◆ get_cnode()

Callpath* pearl::GlobalDefs::get_cnode ( Callpath::IdType id ) const

◆ get_comm()

Communicator* pearl::GlobalDefs::get_comm ( Communicator::IdType id ) const

◆ get_group()

GroupingSet* pearl::GlobalDefs::get_group ( GroupingSet::IdType id ) const

◆ get_window()

RmaWindow* pearl::GlobalDefs::get_window ( RmaWindow::IdType id ) const

◆ getCallingContext()

const CallingContext& pearl::GlobalDefs::getCallingContext ( CallingContext::IdType id ) const

Returns a constant reference to the CallingContext definition object with the given global identifier id.

Parameters

id	Global identifier of the CallingContext definition object to be retrieved

Returns

Constant reference to the corresponding CallingContext object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a CallingContext definition object with the given id

◆ getCallingContextByIndex()

const CallingContext& pearl::GlobalDefs::getCallingContextByIndex ( std::size_t index ) const

Returns a constant reference to the CallingContext definition object stored at the given index.

Parameters

index Index in the range [0,#calling_contexts-1]

Returns

Constant reference to the corresponding CallingContext object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getCallpath()

const Callpath& pearl::GlobalDefs::getCallpath ( Callpath::IdType id ) const

Returns a constant reference to the Callpath definition object with the given global identifier id.

Parameters

id	Global identifier of the Callpath definition object to be retrieved

Returns

Constant reference to the corresponding Callpath object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Callpath definition object with the given id

◆ getCallpathByIndex()

const Callpath& pearl::GlobalDefs::getCallpathByIndex ( std::size_t index ) const

Returns a constant reference to the Callpath definition object stored at the given index.

Parameters

index Index in the range [0,#callpaths-1]

Returns

Constant reference to the corresponding Callpath object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getCallsite()

const Callsite& pearl::GlobalDefs::getCallsite ( Callsite::IdType id ) const

Returns a constant reference to the Callsite definition object with the given global identifier id.

Parameters

id	Global identifier of the Callsite definition object to be retrieved

Returns

Constant reference to the corresponding Callsite object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Callsite definition object with the given id

◆ getCallsiteByIndex()

const Callsite& pearl::GlobalDefs::getCallsiteByIndex ( std::size_t index ) const

Returns a constant reference to the Callsite definition object stored at the given index.

Parameters

index Index in the range [0,#callsites-1]

Returns

Constant reference to the corresponding Callsite object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getCartDimension()

const CartDimension& pearl::GlobalDefs::getCartDimension ( CartDimension::IdType id ) const

Returns a constant reference to the Cartesian grid topology dimension definition object with the given global identifier id.

Parameters

id	Global identifier of the Cartesian grid topology dimension definition object to be retrieved

Returns

Constant reference to the corresponding CartDimension object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Cartesian grid topology dimension definition object with the given id

◆ getCartDimensionByIndex()

const CartDimension& pearl::GlobalDefs::getCartDimensionByIndex ( std::size_t index ) const

Returns a constant reference to the Cartesian grid topology dimension definition object stored at the given index.

Parameters

index Index in the range [0,#cart_dimensions-1]

Returns

Constant reference to the corresponding CartDimension object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getCartTopology()

const CartTopology& pearl::GlobalDefs::getCartTopology ( CartTopology::IdType id ) const

Returns a constant reference to the Cartesian grid topology definition object with the given global identifier id.

Parameters

id	Global identifier of the Cartesian grid topology definition object to be retrieved

Returns

Constant reference to the corresponding CartTopology object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Cartesian grid topology definition object with the given id

◆ getCartTopologyByIndex()

const CartTopology& pearl::GlobalDefs::getCartTopologyByIndex ( std::size_t index ) const

Returns a constant reference to the Cartesian grid topology definition object stored at the given index.

Parameters

index Index in the range [0,#cart_topologies-1]

Returns

Constant reference to the corresponding CartTopology object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getCommunicator()

const Communicator& pearl::GlobalDefs::getCommunicator ( Communicator::IdType id ) const

Returns a constant reference to the Communicator definition object with the given global identifier id.

Parameters

id	Global identifier of the Communicator definition object to be retrieved

Returns

Constant reference to the corresponding Communicator object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Communicator definition object with the given id

◆ getCommunicatorByIndex()

const Communicator& pearl::GlobalDefs::getCommunicatorByIndex ( std::size_t index ) const

Returns a constant reference to the Communicator definition object stored at the given index.

Parameters

index Index in the range [0,#communicators-1]

Returns

Constant reference to the corresponding Communicator object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getFlushingRegion()

const Region& pearl::GlobalDefs::getFlushingRegion ( ) const

◆ getGroupingSet()

const GroupingSet& pearl::GlobalDefs::getGroupingSet ( GroupingSet::IdType id ) const

Returns a constant reference to the GroupingSet definition object with the given global identifier id.

Parameters

id	Global identifier of the GroupingSet definition object to be retrieved

Returns

Constant reference to the corresponding GroupingSet object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a GroupingSet definition object with the given id

◆ getGroupingSetByIndex()

const GroupingSet& pearl::GlobalDefs::getGroupingSetByIndex ( std::size_t index ) const

Returns a constant reference to the GroupingSet definition object stored at the given index.

Parameters

index Index in the range [0,#grouping_sets-1]

Returns

Constant reference to the corresponding GroupingSet object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getLocation()

const Location& pearl::GlobalDefs::getLocation ( Location::IdType id ) const

Returns a constant reference to the Location definition object with the given global identifier id.

Parameters

id	Global identifier of the Location definition object to be retrieved

Returns

Constant reference to the corresponding Location object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Location definition object with the given id

◆ getLocationByIndex()

const Location& pearl::GlobalDefs::getLocationByIndex ( std::size_t index ) const

Returns a constant reference to the Location definition object stored at the given index.

Parameters

index Index in the range [0,#locations-1]

Returns

Constant reference to the corresponding Location object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getLocationGroup()

const LocationGroup& pearl::GlobalDefs::getLocationGroup ( LocationGroup::IdType id ) const

Returns a constant reference to the LocationGroup definition object with the given global identifier id.

Parameters

id	Global identifier of the LocationGroup definition object to be retrieved

Returns

Constant reference to the corresponding LocationGroup object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a LocationGroup definition object with the given id

◆ getLocationGroupByIndex()

const LocationGroup& pearl::GlobalDefs::getLocationGroupByIndex ( std::size_t index ) const

Returns a constant reference to the LocationGroup definition object stored at the given index.

Parameters

index Index in the range [0,#location_groups-1]

Returns

Constant reference to the corresponding LocationGroup object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getMetric()

const Metric& pearl::GlobalDefs::getMetric ( Metric::IdType id ) const

Returns a constant reference to the Metric definition object with the given global identifier id.

Parameters

id	Global identifier of the Metric definition object to be retrieved

Returns

Constant reference to the corresponding Metric object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Metric definition object with the given id

◆ getMetricByIndex()

const Metric& pearl::GlobalDefs::getMetricByIndex ( std::size_t index ) const

Returns a constant reference to the Metric definition object stored at the given index.

Parameters

index Index in the range [0,#metrics-1]

Returns

Constant reference to the corresponding Metric object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getPausingRegion()

const Region& pearl::GlobalDefs::getPausingRegion ( ) const

◆ getRegion()

const Region& pearl::GlobalDefs::getRegion ( Region::IdType id ) const

Returns a constant reference to the Region definition object with the given global identifier id.

Parameters

id	Global identifier of the Region definition object to be retrieved

Returns

Constant reference to the corresponding Region object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a Region definition object with the given id

◆ getRegionByIndex()

const Region& pearl::GlobalDefs::getRegionByIndex ( std::size_t index ) const

Returns a constant reference to the Region definition object stored at the given index.

Parameters

index Index in the range [0,#regions-1]

Returns

Constant reference to the corresponding Region object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getRmaWindow()

const RmaWindow& pearl::GlobalDefs::getRmaWindow ( RmaWindow::IdType id ) const

Returns a constant reference to the RmaWindow definition object with the given global identifier id.

Parameters

id	Global identifier of the RmaWindow definition object to be retrieved

Returns

Constant reference to the corresponding RmaWindow object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a RmaWindow definition object with the given id

◆ getRmaWindowByIndex()

const RmaWindow& pearl::GlobalDefs::getRmaWindowByIndex ( std::size_t index ) const

Returns a constant reference to the RmaWindow definition object stored at the given index.

Parameters

index Index in the range [0,#rma_windows-1]

Returns

Constant reference to the corresponding RmaWindow object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getSourceLocation()

const SourceLocation& pearl::GlobalDefs::getSourceLocation ( SourceLocation::IdType id ) const

Returns a constant reference to the SourceLocation definition object with the given global identifier id.

Parameters

id	Global identifier of the SourceLocation definition object to be retrieved

Returns

Constant reference to the corresponding SourceLocation object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a SourceLocation definition object with the given id

◆ getSourceLocationByIndex()

const SourceLocation& pearl::GlobalDefs::getSourceLocationByIndex ( std::size_t index ) const

Returns a constant reference to the SourceLocation definition object stored at the given index.

Parameters

index Index in the range [0,#source_locations-1]

Returns

Constant reference to the corresponding SourceLocation object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getString()

const String& pearl::GlobalDefs::getString ( String::IdType id ) const

Returns a constant reference to the String definition object with the given global identifier id.

Parameters

id	Global identifier of the String definition object to be retrieved

Returns

Constant reference to the corresponding String object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a String definition object with the given id

◆ getStringByIndex()

const String& pearl::GlobalDefs::getStringByIndex ( std::size_t index ) const

Returns a constant reference to the String definition object stored at the given index.

Parameters

index Index in the range [0,#strings-1]

Returns

Constant reference to the corresponding String object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getSystemNode()

const SystemNode& pearl::GlobalDefs::getSystemNode ( SystemNode::IdType id ) const

Returns a constant reference to the SystemNode definition object with the given global identifier id.

Parameters

id	Global identifier of the SystemNode definition object to be retrieved

Returns

Constant reference to the corresponding SystemNode object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError on failure to find a SystemNode definition object with the given id

◆ getSystemNodeByIndex()

const SystemNode& pearl::GlobalDefs::getSystemNodeByIndex ( std::size_t index ) const

Returns a constant reference to the SystemNode definition object stored at the given index.

Parameters

index Index in the range [0,#system_nodes-1]

Returns

Constant reference to the corresponding SystemNode object

        \n@par Exception safety\n        <b class="paramname">Strong guarantee:</b>         no effects in case an exception is thrown.        <br>\n

Exceptions

pearl::RuntimeError if index is out of bounds

◆ getTaskRootRegion()

const Region& pearl::GlobalDefs::getTaskRootRegion ( ) const

◆ getThreadRootRegion()

const Region& pearl::GlobalDefs::getThreadRootRegion ( ) const

◆ numCallingContexts()

std::size_t pearl::GlobalDefs::numCallingContexts ( ) const

Returns the total number of CallingContext definitions for this tracing experiment.

Returns

Number of CallingContext definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numCallpaths()

std::size_t pearl::GlobalDefs::numCallpaths ( ) const

Returns the total number of Callpath definitions for this tracing experiment.

Returns

Number of Callpath definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numCallsites()

std::size_t pearl::GlobalDefs::numCallsites ( ) const

Returns the total number of Callsite definitions for this tracing experiment.

Returns

Number of Callsite definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numCartDimensions()

std::size_t pearl::GlobalDefs::numCartDimensions ( ) const

Returns the total number of CartDimension definitions for this tracing experiment.

Returns

Number of CartDimension definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numCartTopologies()

std::size_t pearl::GlobalDefs::numCartTopologies ( ) const

Returns the total number of CartTopology definitions for this tracing experiment.

Returns

Number of CartTopology definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numCommunicators()

std::size_t pearl::GlobalDefs::numCommunicators ( ) const

Returns the total number of Communicator definitions for this tracing experiment.

Returns

Number of Communicator definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numGroupingSets()

std::size_t pearl::GlobalDefs::numGroupingSets ( ) const

Returns the total number of GroupingSet definitions for this tracing experiment.

Returns

Number of GroupingSet definitons

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numLocationGroups()

std::size_t pearl::GlobalDefs::numLocationGroups ( ) const

Returns the total number of LocationGroup definitions for this tracing experiment.

Returns

Number of LocationGroup definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numLocations()

std::size_t pearl::GlobalDefs::numLocations ( ) const

Returns the total number of Location definitions for this tracing experiment.

Returns

Number of Location definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numMetrics()

std::size_t pearl::GlobalDefs::numMetrics ( ) const

Returns the total number of Metric definitions for this tracing experiment.

Returns

Number of Metric definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numRegions()

std::size_t pearl::GlobalDefs::numRegions ( ) const

Returns the total number of Region definitions for this tracing experiment.

Returns

Number of Region definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numRmaWindows()

std::size_t pearl::GlobalDefs::numRmaWindows ( ) const

Returns the total number of RmaWindow definitions for this tracing experiment.

Returns

Number of RmaWindow definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numSourceLocations()

std::size_t pearl::GlobalDefs::numSourceLocations ( ) const

Returns the total number of SourceLocation definitions for this tracing experiment.

Returns

Number of SourceLocation definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numStrings()

std::size_t pearl::GlobalDefs::numStrings ( ) const

Returns the total number of String definitions for this tracing experiment.

Returns

Number of String definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

◆ numSystemNodes()

std::size_t pearl::GlobalDefs::numSystemNodes ( ) const

Returns the total number of SystemNode definitions for this tracing experiment.

Returns

Number of SystemNode definitions

        \n@par Exception safety\n        <b class="paramname">No-throw guarantee:</b>         never throws exceptions.        <br>\n

Member Data Documentation

◆ mCallsites

const ScopedPtr< CallsiteContainer > pearl::GlobalDefs::mCallsites

protected

◆ mCallTree

ScopedPtr< detail::CallTree > pearl::GlobalDefs::mCallTree

protected

◆ mCartDimensions

const ScopedPtr< CartDimensionContainer > pearl::GlobalDefs::mCartDimensions

protected

◆ mCartTopologies

const ScopedPtr< CartTopologyContainer > pearl::GlobalDefs::mCartTopologies

protected

◆ mCommunicators

const ScopedPtr< CommunicatorContainer > pearl::GlobalDefs::mCommunicators

protected

◆ mContextTree

const ScopedPtr< CallingContextContainer > pearl::GlobalDefs::mContextTree

protected

◆ mFlushingRegion

Region* pearl::GlobalDefs::mFlushingRegion

protected

◆ mGroupingSets

const ScopedPtr< GroupingSetContainer > pearl::GlobalDefs::mGroupingSets

protected

◆ mLocationGroups

const ScopedPtr< LocationGroupContainer > pearl::GlobalDefs::mLocationGroups

protected

◆ mLocations

const ScopedPtr< LocationContainer > pearl::GlobalDefs::mLocations

protected

◆ mMetrics

const ScopedPtr< MetricContainer > pearl::GlobalDefs::mMetrics

protected

◆ mPausingRegion

Region* pearl::GlobalDefs::mPausingRegion

protected

◆ mRegions

const ScopedPtr< RegionContainer > pearl::GlobalDefs::mRegions

protected

◆ mRmaWindows

const ScopedPtr< RmaWindowContainer > pearl::GlobalDefs::mRmaWindows

protected

◆ mSourceLocations

const ScopedPtr< SourceLocationContainer > pearl::GlobalDefs::mSourceLocations

protected

◆ mStrings

const ScopedPtr< StringContainer > pearl::GlobalDefs::mStrings

protected

◆ mSystemTree

const ScopedPtr< SystemNodeContainer > pearl::GlobalDefs::mSystemTree

protected

◆ mTaskRootRegion

Region* pearl::GlobalDefs::mTaskRootRegion

protected

◆ mThreadRootRegion

Region* pearl::GlobalDefs::mThreadRootRegion

protected

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

GlobalDefs.h

Public Member Functions

Protected Types

Protected Attributes

Constructors & destructor

Member Typedef Documentation

◆ CallingContextContainer

◆ CallsiteContainer

◆ CartDimensionContainer

◆ CartTopologyContainer

◆ CommunicatorContainer

◆ GroupingSetContainer

◆ LocationContainer

◆ LocationGroupContainer

◆ MetricContainer

◆ RegionContainer

◆ RmaWindowContainer

◆ SourceLocationContainer

◆ StringContainer

◆ SystemNodeContainer

Constructor & Destructor Documentation

◆ ~GlobalDefs()

◆ GlobalDefs()

Member Function Documentation

◆ get_cnode()

◆ get_comm()

◆ get_group()

◆ get_window()

◆ getCallingContext()

◆ getCallingContextByIndex()

◆ getCallpath()

◆ getCallpathByIndex()

◆ getCallsite()

◆ getCallsiteByIndex()

◆ getCartDimension()

◆ getCartDimensionByIndex()

◆ getCartTopology()

◆ getCartTopologyByIndex()

◆ getCommunicator()

◆ getCommunicatorByIndex()

◆ getFlushingRegion()

◆ getGroupingSet()

◆ getGroupingSetByIndex()

◆ getLocation()

◆ getLocationByIndex()

◆ getLocationGroup()

◆ getLocationGroupByIndex()

◆ getMetric()

◆ getMetricByIndex()

◆ getPausingRegion()

◆ getRegion()

◆ getRegionByIndex()

◆ getRmaWindow()

◆ getRmaWindowByIndex()

◆ getSourceLocation()

◆ getSourceLocationByIndex()

◆ getString()

◆ getStringByIndex()

◆ getSystemNode()

◆ getSystemNodeByIndex()

◆ getTaskRootRegion()

◆ getThreadRootRegion()

◆ numCallingContexts()

◆ numCallpaths()

◆ numCallsites()

◆ numCartDimensions()

◆ numCartTopologies()

◆ numCommunicators()

◆ numGroupingSets()

◆ numLocationGroups()

◆ numLocations()

◆ numMetrics()

◆ numRegions()

◆ numRmaWindows()

◆ numSourceLocations()

◆ numStrings()

◆ numSystemNodes()

Member Data Documentation

◆ mCallsites

◆ mCallTree

◆ mCartDimensions