The tracker result interface. More...

#include "murl_graph_i_tracker_result.h"

Inherited by Murl::Graph::TrackerResult.

Public Types

enum  Type { TYPE_INFO, TYPE_WARNING, TYPE_ERROR }
 The result type. More...
 

Public Member Functions

virtual const ITrackerResultClone () const =0
 Clone the result object. More...
 
virtual const INodeGetNode () const =0
 Get the graph node the result applies to. More...
 
virtual const IControllerGetController () const =0
 Get the graph controller the result applies to. More...
 
virtual Type GetType () const =0
 Get the result type. More...
 
virtual const StringGetFunction () const =0
 Get the fully qualified name of the function/method that posted this result. More...
 
virtual UInt32 GetLine () const =0
 Get the line number within the source file where the result was posted. More...
 
virtual const StringGetMessage () const =0
 Get the result message string. More...
 
virtual const StringArrayGetParameters () const =0
 Get the array of result parameter strings. More...
 

Detailed Description

The tracker result interface.

Member Enumeration Documentation

◆ Type

The result type.

Enumerator
TYPE_INFO 

Info result.

TYPE_WARNING 

A warning.

TYPE_ERROR 

An error.

Member Function Documentation

◆ Clone()

virtual const ITrackerResult* Murl::Graph::ITrackerResult::Clone ( ) const
pure virtual

Clone the result object.

Returns
The newly created clone.

◆ GetNode()

virtual const INode* Murl::Graph::ITrackerResult::GetNode ( ) const
pure virtual

Get the graph node the result applies to.

Returns
The affected node, or null if not a node.

◆ GetController()

virtual const IController* Murl::Graph::ITrackerResult::GetController ( ) const
pure virtual

Get the graph controller the result applies to.

Returns
The affected controller, or null if not a controller.

◆ GetType()

virtual Type Murl::Graph::ITrackerResult::GetType ( ) const
pure virtual

Get the result type.

Returns
The result type.

◆ GetFunction()

virtual const String& Murl::Graph::ITrackerResult::GetFunction ( ) const
pure virtual

Get the fully qualified name of the function/method that posted this result.

Returns
The function.

◆ GetLine()

virtual UInt32 Murl::Graph::ITrackerResult::GetLine ( ) const
pure virtual

Get the line number within the source file where the result was posted.

Returns
The line number.

◆ GetMessage()

virtual const String& Murl::Graph::ITrackerResult::GetMessage ( ) const
pure virtual

Get the result message string.

This method returns the plain message string, which may optionally contain any number of parameter place holders in the form {N}, with N being a number between 0 and GetParameters().GetCount()-1. To obtain the full message, use Util::FillInParameters(GetMessage(), GetParameters()).

Returns
The plain message string.

◆ GetParameters()

virtual const StringArray& Murl::Graph::ITrackerResult::GetParameters ( ) const
pure virtual

Get the array of result parameter strings.

This method returns the array of parameters to be inserted into the plain message string. See GetMessage().

Returns
The array of parameter strings.

The documentation for this interface was generated from the following file:
  • murl_graph_i_tracker_result.h


Copyright © 2011-2018 Spraylight GmbH.