tim::component::properties< Tp > Struct Template Reference

This is a critical specialization for mapping string and integers to component types at runtime. The enum_string() function is the enum id as a string. The id() function is (typically) the name of the C++ component as a string. The ids() function returns a set of strings which are alternative string identifiers to the enum string or the string ID. Additionally, it provides serializaiton of these values. More...

#include "timemory/components/properties.hpp"

Collaboration diagram for tim::component::properties< Tp >:

Public Types
using	type = Tp
using	value_type = TIMEMORY_COMPONENT

Public Member Functions
template<typename Archive >
void	serialize (Archive &, const unsigned int)
TIMEMORY_COMPONENT	operator() ()
constexpr	operator TIMEMORY_COMPONENT () const

Static Public Member Functions
static constexpr bool	specialized ()
static constexpr const char *	enum_string ()
static constexpr const char *	id ()
static idset_t	ids ()

Static Public Attributes
static constexpr TIMEMORY_COMPONENT	value = TIMEMORY_COMPONENTS_END

Detailed Description

template<typename Tp>
struct tim::component::properties< Tp >

This is a critical specialization for mapping string and integers to component types at runtime. The enum_string() function is the enum id as a string. The id() function is (typically) the name of the C++ component as a string. The ids() function returns a set of strings which are alternative string identifiers to the enum string or the string ID. Additionally, it provides serializaiton of these values.

Template Parameters

Tp	Component type

A macro is provides to simplify this specialization:

TIMEMORY_PROPERTY_SPECIALIZATION(wall_clock, TIMEMORY_WALL_CLOCK, "wall_clock",
                                 "real_clock", "virtual_clock")

In the above, the first parameter is the C++ type, the second is the enumeration id, the enum string is automatically generated via preprocessor # on the second parameter, the third parameter is the string ID, and the remaining values are placed in the ids(). Additionally, this macro specializes the tim::component::enumerator.

Definition at line 213 of file properties.hpp.

Member Typedef Documentation

type

template<typename Tp >

using tim::component::properties< Tp >::type = Tp

Definition at line 215 of file properties.hpp.

value_type

template<typename Tp >

using tim::component::properties< Tp >::value_type = TIMEMORY_COMPONENT

Definition at line 216 of file properties.hpp.

Member Function Documentation

enum_string()

template<typename Tp >

static constexpr const char * tim::component::properties< Tp >::enum_string ( )

inlinestaticconstexpr

Definition at line 220 of file properties.hpp.

{ return "TIMEMORY_COMPONENTS_END"; }

id()

template<typename Tp >

static constexpr const char * tim::component::properties< Tp >::id ( )

inlinestaticconstexpr

Definition at line 221 of file properties.hpp.

{ return ""; }

Referenced by tim::runtime::do_enumerator_enumerate(), and tim::component::papi_rate_tuple< RateT, EventTypes >::label().

ids()

template<typename Tp >

static idset_t tim::component::properties< Tp >::ids ( )

inlinestatic

Definition at line 222 of file properties.hpp.

{ return idset_t{}; }

operator TIMEMORY_COMPONENT()

template<typename Tp >

constexpr tim::component::properties< Tp >::operator TIMEMORY_COMPONENT ( ) const

inlineconstexpr

Definition at line 228 of file properties.hpp.

{ return TIMEMORY_COMPONENTS_END; }

References TIMEMORY_COMPONENTS_END.

operator()()

template<typename Tp >

TIMEMORY_COMPONENT tim::component::properties< Tp >::operator() ( )

inline

Definition at line 226 of file properties.hpp.

{ return TIMEMORY_COMPONENTS_END; }

References TIMEMORY_COMPONENTS_END.

serialize()

template<typename Tp >

template<typename Archive >

void tim::component::properties< Tp >::serialize ( Archive &  , const unsigned int    )

inline

Definition at line 224 of file properties.hpp.

    {}

specialized()

template<typename Tp >

static constexpr bool tim::component::properties< Tp >::specialized ( )

inlinestaticconstexpr

Definition at line 219 of file properties.hpp.

{ return false; }

Member Data Documentation

value

template<typename Tp >

constexpr TIMEMORY_COMPONENT tim::component::properties< Tp >::value = TIMEMORY_COMPONENTS_END

staticconstexpr

Definition at line 217 of file properties.hpp.

---

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

• timemory/components/properties.hpp