Miind
Public Member Functions | Public Attributes | List of all members
MPILib::report::handler::GraphKey Struct Reference

#include <libs/MPILib/include/report/handler/GraphKey.hpp>

Collaboration diagram for MPILib::report::handler::GraphKey:
Collaboration graph

Public Member Functions

 GraphKey ()
 
 GraphKey (const std::string &key_string)
 
 GraphKey (NodeId id, Time time)
 
std::string generateName () const
 

Public Attributes

NodeId _id = NodeId(0)
 
Time _time = 0.0
 
GraphType _type = STATEGRAPH
 

Detailed Description

Serves to interpret the name of a graph assigned by any AbstractReportHandler, and serves as a key for searches on graphs in simulation files.

Given the size of root files nowadays, the Node and time stamp of state graphs in any handler must not only be stored, but also be retrieved in subsequent analysis. The GraphKey object is the central object to code and decode the names of state graphs.

Definition at line 41 of file GraphKey.hpp.

Constructor & Destructor Documentation

MPILib::report::handler::GraphKey::GraphKey ( )

Default constructor for use in containers

Definition at line 34 of file GraphKey.cpp.

MPILib::report::handler::GraphKey::GraphKey ( const std::string &  key_string)

construct a graph key from the key in the root file. If the string does not represent a valid key, no object will be constructed, but otherwise nothing will happen. This allows parsing of heterogeneous object files.

Parameters
key_stringThe graph key

Definition at line 37 of file GraphKey.cpp.

References _id, _time, _type, MPILib::report::handler::RATEGRAPH, and MPILib::report::handler::STATEGRAPH.

MPILib::report::handler::GraphKey::GraphKey ( NodeId  id,
Time  time 
)

construct a graph key from a Report information

Parameters
idThe NodeId of the Node
timeThe Time point

Definition at line 30 of file GraphKey.cpp.

Member Function Documentation

std::string MPILib::report::handler::GraphKey::generateName ( ) const

generates a name of the graph

Returns
A name for the graph

Definition at line 56 of file GraphKey.cpp.

References _id, _time, _type, MPILib::KEY_PRECISION, and MPILib::report::handler::RATEGRAPH.

Member Data Documentation

NodeId MPILib::report::handler::GraphKey::_id = NodeId(0)

The nodeId of the node

Definition at line 46 of file GraphKey.hpp.

Referenced by generateName(), and GraphKey().

Time MPILib::report::handler::GraphKey::_time = 0.0

The time point of the node

Definition at line 50 of file GraphKey.hpp.

Referenced by generateName(), and GraphKey().

GraphType MPILib::report::handler::GraphKey::_type = STATEGRAPH

The GraphType

Definition at line 54 of file GraphKey.hpp.

Referenced by generateName(), and GraphKey().


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