grail::UtilityEvaluatorSnapshot Class Reference

The UtilityEvaluatorSnapshot class - debug snapshot of whole evaluator tree assigned to evaluated object. More...

#include <UtilityEvaluatorSnapshot.h>

Public Member Functions
	UtilityEvaluatorSnapshot (const std::string &evaluatedObjectName, const std::string &metadata, int rank=0)
	UtilityEvaluatorSnapshot - constructs snapshot initializing evaluated object name and its rank. More...
void	AddEvaluation (EvaluationDebugData &&debugData)
	AddEvaluation - add debug data describing singular evaluator node to this snapshot. More...
std::size_t	AddNode (const void *nodePointer)
	AddNode - assign index indicating position in debug tree to the given node pointer. More...
const std::vector< EvaluationDebugData > &	GetEvaluations () const
	GetEvaluations. More...
const std::string &	GetEvaluatedObjectName () const
	GetEvaluatedObjectName. More...
const std::string &	GetEvaluatedObjectMetadata () const
	GetEvaluatedObjectMetadata. More...
const int &	GetRank () const
	GetRank. More...
const std::map< const void *, std::size_t > &	GetNodeMapping () const
	GetNodeMapping. More...

Friends
struct	YAML::convert< UtilityEvaluatorSnapshot >

Detailed Description

The UtilityEvaluatorSnapshot class - debug snapshot of whole evaluator tree assigned to evaluated object.

Constructor & Destructor Documentation

UtilityEvaluatorSnapshot()

grail::UtilityEvaluatorSnapshot::UtilityEvaluatorSnapshot	(	const std::string &	evaluatedObjectName,
		const std::string &	metadata,
		int	rank = 0
	)

UtilityEvaluatorSnapshot - constructs snapshot initializing evaluated object name and its rank.

Parameters

evaluatedObjectName	- name of object evaluated with evaluator described by this data
rank	- rank of object evaluated with evaluator described by this data

Member Function Documentation

AddEvaluation()

void grail::UtilityEvaluatorSnapshot::AddEvaluation

(

EvaluationDebugData &&

debugData

)

AddEvaluation - add debug data describing singular evaluator node to this snapshot.

Parameters

debugData

- data describing singular evaluator node

AddNode()

std::size_t grail::UtilityEvaluatorSnapshot::AddNode

(

const void *

nodePointer

)

AddNode - assign index indicating position in debug tree to the given node pointer.

Parameters

nodePointer

- pointer to node added to this tree

Returns

index assigned to provided pointer

GetEvaluatedObjectMetadata()

const std::string & grail::UtilityEvaluatorSnapshot::GetEvaluatedObjectMetadata

(

)

const

GetEvaluatedObjectMetadata.

Returns

evaluated object metadata

GetEvaluatedObjectName()

const std::string & grail::UtilityEvaluatorSnapshot::GetEvaluatedObjectName

(

)

const

GetEvaluatedObjectName.

Returns

name of evaluated object

GetEvaluations()

const std::vector< EvaluationDebugData > & grail::UtilityEvaluatorSnapshot::GetEvaluations

(

)

const

GetEvaluations.

Returns

vector of debug data from all evaluators contained in this snapshot

GetNodeMapping()

const std::map< const void *, std::size_t > & grail::UtilityEvaluatorSnapshot::GetNodeMapping

(

)

const

GetNodeMapping.

Returns

mapped node pointers to their tree indexes

GetRank()

const int & grail::UtilityEvaluatorSnapshot::GetRank

(

)

const

GetRank.

Returns

rank of evaluated object

---

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

• GrailData/DebugInfo/UtilityEvaluatorSnapshot.h
• GrailData/DebugInfo/UtilityEvaluatorSnapshot.cpp