Autonomic Performance Environment for eXascale (APEX)  2.3.1
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
apex::task_wrapper Struct Reference

A wrapper around APEX tasks. More...

#include <task_wrapper.hpp>

Public Member Functions

 task_wrapper (void)
 Constructor.
 
task_identifier * get_task_id (void)
 Get the task_identifier for this task_wrapper. More...
 

Static Public Member Functions

static std::shared_ptr< task_wrapper > & get_apex_main_wrapper (void)
 Static method to get a pre-defined task_wrapper around "main". More...
 

Public Attributes

task_identifier * task_id
 A pointer to the task_identifier for this task_wrapper.
 
profiler * prof
 A pointer to the active profiler object timing this task.
 
uint64_t guid
 An internally generated GUID for this task.
 
uint64_t parent_guid
 An internally generated GUID for the parent task of this task.
 
std::shared_ptr< task_wrapperparent
 A managed pointer to the parent task_wrapper for this task.
 
std::vector< profiler * > data_ptr
 Internal usage, used to manage HPX direct actions when their parent task is yielded by the runtime.
 
task_identifier * alias
 If the task changes names after creation (due to the application of an annotation) then the alias becomes the new task_identifier for the task.
 

Detailed Description

A wrapper around APEX tasks.

Member Function Documentation

◆ get_apex_main_wrapper()

static std::shared_ptr<task_wrapper>& apex::task_wrapper::get_apex_main_wrapper ( void  )
inlinestatic

Static method to get a pre-defined task_wrapper around "main".

Returns
A shared pointer to the task_wrapper

◆ get_task_id()

task_identifier* apex::task_wrapper::get_task_id ( void  )
inline

Get the task_identifier for this task_wrapper.

Returns
A pointer to the task_identifier

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