A results rule printing the associated data sets to the logger. More...

#include <gmPrintResultsRule.h>

Inheritance diagram for GmPrintResultsRule:

Collaboration diagram for GmPrintResultsRule:

[legend]

Public Member Functions
virtual	~GmPrintResultsRule ()
	Destructor.

virtual GmResultsRuleType	type () const
	Returns the result rule type.

virtual void	print (const GmLogCategory &logger, GmLogLevel level) const
	Prints the rule description to the appointed logger / level.

virtual bool	run (const GmLogCategory &logger)
	Prints the data specified by the associated data sets to the logger.

Public Member Functions inherited from GmResultsRule
virtual	~GmResultsRule ()
	Destructor.

QString	id () const
	Returns the result rule name.

QString	description () const
	Returns the result rule description.

const QVector< GmResultsDataSet * > &	dataSets () const
	Returns the list of data sets acted upon by this rule.

const QVector< GmResultsTimeSet * > &	timeSets () const
	Returns the list of time sets defining when this rule should be acted upon.

bool	hasTimeSet () const
	Returns true if this rule is associated with a time set.

Static Public Member Functions
static GmPrintResultsRule *	loadFromTable (const GmResultsData data, LuaTable &tab, const GmLogCategory &parseLogger, const GmSimulationData simData)
	Parses either a save rule definition from the given Lua table, returning a save rule object.

Private Member Functions
	Q_DISABLE_COPY (GmPrintResultsRule)

	GmPrintResultsRule (QString id, QString description, const QVector< GmResultsDataSet * > &dataSets, const QVector< GmResultsTimeSet * > &timeSets, bool trackObj, const GmSimulationData *simData)
	Constructor.

void	printAttributeData (const GmResultsDataSet *dataSet, const GmLogCategory &logger, GmLogLevel level) const
	Print the attribute data for all attributes in the given data set.

void	printEvalSetData (const GmResultsDataSet *dataSet, GmResultsDataSrcType type, const GmLogCategory &logger, GmLogLevel level) const
	Print the values for all data srcs from the given eval set class in the given data set.

Additional Inherited Members
Protected Member Functions inherited from GmResultsRule
	GmResultsRule (QString id, QString description, const QVector< GmResultsDataSet * > &dataSets, const QVector< GmResultsTimeSet * > &timeSets, bool trackObj, const GmSimulationData *simData)
	Constructor. The rule does NOT own the data sets and time sets.

Static Protected Member Functions inherited from GmResultsRule
static bool	fillCommonFields (const GmResultsData data, LuaTable &tab, const GmLogCategory &logger, QString &id, QString &description, QVector< GmResultsDataSet > &dataSets, QVector< GmResultsTimeSet * > &timeSets, bool &trackObj)
	Helper function for the loadFromTable functions from derived classes. Parses the common fields for every result rule from the given Lua table. The logger is used to emmit messages during rule parsing. The data object is used to find data sets and time sets on the results data object.

Protected Attributes inherited from GmResultsRule
QString	_id
	The save rule id (name)

QString	_description
	A description of the save rule.

QVector< GmResultsDataSet * >	_dataSets
	The list of associated data sets.

QVector< GmResultsTimeSet * >	_timeSets
	The list of associated time sets.

const GmSimulationData *	_simData
	The simulation data object.

int	_itemId
	The run progress item id for result rules of this kind (subclass: save rules, print rules or monitor rules)

int	_objItemId
	The run progress item for this object if the user requested to monitor the time for this specific result rule.

Detailed Description

A results rule printing the associated data sets to the logger.

Member Function Documentation

◆ loadFromTable()

GmPrintResultsRule * GmPrintResultsRule::loadFromTable	(	const GmResultsData *	data,
		LuaTable &	tab,
		const GmLogCategory &	parseLogger,
		const GmSimulationData *	simData )

static

Parses either a save rule definition from the given Lua table, returning a save rule object.

The parseLogger is used to emmit messages during rule parsing.

◆ print()

void GmPrintResultsRule::print	(	const GmLogCategory &	logger,
		GmLogLevel	level ) const

virtual

Prints the rule description to the appointed logger / level.

Reimplemented from GmResultsRule.

◆ run()

bool GmPrintResultsRule::run ( const GmLogCategory & logger )

virtual

Prints the data specified by the associated data sets to the logger.

Implements GmResultsRule.

◆ type()

virtual GmResultsRuleType GmPrintResultsRule::type ( ) const

inlinevirtual

Returns the result rule type.

Implements GmResultsRule.

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

inc/results/gmPrintResultsRule.h
src/results/gmPrintResultsRule.cpp

Public Member Functions

Static Public Member Functions