MPILib::report::Report Struct Reference

#include <libs/MPILib/include/report/Report.hpp>

Collaboration diagram for MPILib::report::Report:

Public Member Functions
	Report (Time time, Rate rate, NodeId id)
	Report (Time time, Rate rate, NodeId id, AlgorithmGrid grid, ReportType type, std::vector< ReportValue > vec_values, int nrNodes=0)
void	addValue (const ReportValue &value)

Public Attributes
AlgorithmGrid	_grid = (0)
NodeId	_id
unsigned int	_nrNodes
Rate	_rate
Time	_time
ReportType	_type
std::vector< ReportValue >	_values

Detailed Description

A Report is sent by a MPINode when it is queried.

The information compiled by individual nodes is sent at a request of the agent that drives the simulation, typically a MPINetwork. Such Reports are collected by an instance of an AbstractReportHandler, which is responsible for entering this information into a simulation file.

Definition at line 41 of file Report.hpp.

Constructor & Destructor Documentation

MPILib::report::Report::Report	(	Time	time,
		Rate	rate,
		NodeId	id
	)

Constructor

Parameters

time	Current time at this node.
rate	Current firing rate of this node.
id	NodeId of this node.

Definition at line 25 of file Report.cpp.

MPILib::report::Report::Report	(	Time	time,
		Rate	rate,
		NodeId	id,
		AlgorithmGrid	grid,
		ReportType	type,
		std::vector< ReportValue >	vec_values,
		int	nrNodes = 0
	)

Parameters

time	Current time at this node.
rate	Current firing rate of this node.
id	NodeId of this node.
grid	The state space of the Algorithm
type	Information for the handler on how to treat the Report
vec_values	Ad hoc values that need to be logged in the simulation file
nrNodes	The number of nodes on this processor

Definition at line 29 of file Report.cpp.

Member Function Documentation

void MPILib::report::Report::addValue

(

const ReportValue &

value

)

Add a ReportValue to the report

Parameters

value

The ReportValue added to the Report

Definition at line 35 of file Report.cpp.

References _values.

Member Data Documentation

AlgorithmGrid MPILib::report::Report::_grid = (0)

The state space of the Algorithm

Definition at line 57 of file Report.hpp.

NodeId MPILib::report::Report::_id

NodeId of this node.

Definition at line 53 of file Report.hpp.

Referenced by MPILib::report::handler::MinimalReportHandler::writeReport().

unsigned int MPILib::report::Report::_nrNodes

Number of nodes on the process, should be the same for all reports on one node

Definition at line 69 of file Report.hpp.

Rate MPILib::report::Report::_rate

Current firing rate of this node.

Definition at line 49 of file Report.hpp.

Referenced by MPILib::report::handler::MinimalReportHandler::writeReport().

Time MPILib::report::Report::_time

Current time at this node.

Definition at line 45 of file Report.hpp.

Referenced by MPILib::report::handler::MinimalReportHandler::writeReport().

ReportType MPILib::report::Report::_type

Information for the handler on how to treat the Report

Definition at line 61 of file Report.hpp.

std::vector<ReportValue> MPILib::report::Report::_values

Ad hoc values that need to be logged in the simulation file

Definition at line 65 of file Report.hpp.

Referenced by addValue().

---

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

• /Users/scsmdk/miind-git/libs/MPILib/include/report/Report.hpp
• /Users/scsmdk/miind-git/libs/MPILib/src/report/Report.cpp