Class for Scenario Analyzer messages that provides simple message building and writing. More...

#include <ScenarioAnalyzerMessage.hpp>

Inherits UtScriptAccessible.

Public Types
enum	SeverityLevel { cNOTE , cWARNING , cERROR }

Public Member Functions
	ScenarioAnalyzerMessage ()
	Construct a default ScenarioAnalyzerMessage as a note.
	ScenarioAnalyzerMessage (const ScenarioAnalyzerMessage &aSrc)
	Construct a ScenarioAnalyzerMessage from another.
	ScenarioAnalyzerMessage (const std::string &aSuiteName, const std::string &aCheckName, const std::string &aDetails, SeverityLevel aSeverityLevel, const std::vector< ScenarioFileLocation > &aLocations)
	Construct a ScenarioAnalyzerMessage with a full set of details.
	ScenarioAnalyzerMessage (const std::string &aSuiteName, const std::string &aCheckName, const std::string &aDetails, SeverityLevel aSeverityLevel)
	Construct a ScenarioAnalyzerMessage without related files.
	ScenarioAnalyzerMessage (const std::string &aCategory, const std::string &aDetails)
	Construct a ScenarioAnalyzerMessage that is a basic session note.
void	Clear ()
	Clear all message details, and set severity back to default.
void	ClearDetails ()
const char *	GetScriptClassName () const override
bool	IsSuccessfulResult () const
std::string	GetSuiteName () const
std::string	GetCheckName () const
std::string	GetDetails () const
SeverityLevel	GetSeverity () const
const std::vector< ScenarioFileLocation > &	GetScenarioFileLocations () const
void	SetSuiteName (const std::string &aSuiteName)
void	SetCheckName (const std::string &aCheckName)
void	SetDetails (const std::string &aDetails)
void	AddDetails (const std::string &aDetails)
void	SetSeverity (SeverityLevel aSeverityLevel)
void	AddScenarioFileLocation (const ScenarioFileLocation &aLocation)
void	SetSuccessful ()
	Set default details and type for a successful message.
void	Write (std::ostream &aOut=std::cout) const

Static Public Member Functions
static std::vector< ScenarioAnalyzerMessage >	ParseFromIStream (std::istream &aInputStream)
static std::string	SeverityString (SeverityLevel aSeverityLevel)
	Get the severity level as a string.
static SeverityLevel	SeverityLevelFromString (std::string aString)
	Get the severity level from a string.

Static Public Attributes
static const int	cNUM_SEVERITIES = 3
	The number of severity levels.
static const char *	cSCRIPT_CLASS_NAME = "ScenarioAnalyzerMessage"

Protected Attributes
bool	mSuccessful
	The message represents a successful result.
std::string	mSuiteName
	Name of the suite.
std::string	mCheckName
	Name of the check.
std::string	mDetails
	Details of the message.
SeverityLevel	mSeverity
	Severity level of the message.
std::vector< ScenarioFileLocation >	mLocations
	Location of input blocks related to the message being generated.

Detailed Description

Class for Scenario Analyzer messages that provides simple message building and writing.

Member Enumeration Documentation

◆ SeverityLevel

enum ScenarioAnalyzerMessage::SeverityLevel

Enumerator
cNOTE	Message provides information.
cWARNING	Message is a warning (may or may not be problematic).
cERROR	Message is a critical error.

Constructor & Destructor Documentation

◆ ScenarioAnalyzerMessage() [1/5]

ScenarioAnalyzerMessage::ScenarioAnalyzerMessage ( )

Construct a default ScenarioAnalyzerMessage as a note.

References cNOTE, mSeverity, and mSuccessful.

Referenced by ParseFromIStream(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), and ScenarioAnalyzerMessage().

◆ ScenarioAnalyzerMessage() [2/5]

ScenarioAnalyzerMessage::ScenarioAnalyzerMessage ( const ScenarioAnalyzerMessage & aSrc )

Construct a ScenarioAnalyzerMessage from another.

References begin(), end(), mCheckName, mDetails, mLocations, mSeverity, mSuccessful, mSuiteName, and ScenarioAnalyzerMessage().

◆ ScenarioAnalyzerMessage() [3/5]

ScenarioAnalyzerMessage::ScenarioAnalyzerMessage	(	const std::string &	aSuiteName,
		const std::string &	aCheckName,
		const std::string &	aDetails,
		SeverityLevel	aSeverityLevel,
		const std::vector< ScenarioFileLocation > &	aLocations )

Construct a ScenarioAnalyzerMessage with a full set of details.

References begin(), end(), mCheckName, mDetails, mLocations, mSeverity, mSuccessful, and mSuiteName.

◆ ScenarioAnalyzerMessage() [4/5]

ScenarioAnalyzerMessage::ScenarioAnalyzerMessage	(	const std::string &	aSuiteName,
		const std::string &	aCheckName,
		const std::string &	aDetails,
		SeverityLevel	aSeverityLevel )

Construct a ScenarioAnalyzerMessage without related files.

References ScenarioAnalyzerMessage().

◆ ScenarioAnalyzerMessage() [5/5]

ScenarioAnalyzerMessage::ScenarioAnalyzerMessage	(	const std::string &	aCategory,
		const std::string &	aDetails )

Construct a ScenarioAnalyzerMessage that is a basic session note.

References cNOTE, and ScenarioAnalyzerMessage().

Member Function Documentation

◆ AddDetails()

void ScenarioAnalyzerMessage::AddDetails ( const std::string & aDetails )

inline

References mDetails.

Referenced by isC2CapableHelper().

◆ AddScenarioFileLocation()

void ScenarioAnalyzerMessage::AddScenarioFileLocation ( const ScenarioFileLocation & aLocation )

inline

References mLocations.

Referenced by ParseFromIStream(), and UT_DEFINE_SCRIPT_METHOD().

◆ Clear()

void ScenarioAnalyzerMessage::Clear ( )

Clear all message details, and set severity back to default.

References ClearDetails(), cNOTE, mCheckName, mSeverity, and mSuiteName.

◆ ClearDetails()

void ScenarioAnalyzerMessage::ClearDetails ( )

Clear only message details and locations- useful when using one message object and wanting to clear unshared details.

References mDetails, and mLocations.

Referenced by Clear().

◆ GetCheckName()

std::string ScenarioAnalyzerMessage::GetCheckName ( ) const

inline

References mCheckName.

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ GetDetails()

std::string ScenarioAnalyzerMessage::GetDetails ( ) const

inline

References mDetails.

Referenced by ParseFromIStream(), and UT_DEFINE_SCRIPT_METHOD().

◆ GetScenarioFileLocations()

const std::vector< ScenarioFileLocation > & ScenarioAnalyzerMessage::GetScenarioFileLocations ( ) const

inline

References mLocations.

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ GetScriptClassName()

const char * ScenarioAnalyzerMessage::GetScriptClassName ( ) const

inlineoverride

References cSCRIPT_CLASS_NAME.

◆ GetSeverity()

SeverityLevel ScenarioAnalyzerMessage::GetSeverity ( ) const

inline

References mSeverity.

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ GetSuiteName()

std::string ScenarioAnalyzerMessage::GetSuiteName ( ) const

inline

References mSuiteName.

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ IsSuccessfulResult()

bool ScenarioAnalyzerMessage::IsSuccessfulResult ( ) const

inline

References mSuccessful.

◆ ParseFromIStream()

std::vector< ScenarioAnalyzerMessage > ScenarioAnalyzerMessage::ParseFromIStream ( std::istream & aInputStream )

static

Attempt to parse messages out of an input stream NOTE: This must change when ScenarioAnalyzerMessage::Write format changes!!

References AddScenarioFileLocation(), GetDetails(), ScenarioFileLocation::mName, ScenarioFileLocation::mType, ScenarioAnalyzerMessage(), SetCheckName(), SetDetails(), SetSeverity(), SetSuccessful(), SetSuiteName(), and SeverityLevelFromString().

◆ SetCheckName()

void ScenarioAnalyzerMessage::SetCheckName ( const std::string & aCheckName )

inline

References mCheckName.

Referenced by ParseFromIStream(), and runSuiteCheck().

◆ SetDetails()

void ScenarioAnalyzerMessage::SetDetails ( const std::string & aDetails )

inline

References mDetails.

Referenced by ParseFromIStream().

◆ SetSeverity()

void ScenarioAnalyzerMessage::SetSeverity ( SeverityLevel aSeverityLevel )

inline

References mSeverity.

Referenced by ParseFromIStream(), and runSuiteCheck().

◆ SetSuccessful()

void ScenarioAnalyzerMessage::SetSuccessful ( )

Set default details and type for a successful message.

References cNOTE, mDetails, mSeverity, and mSuccessful.

Referenced by ParseFromIStream(), runSuiteCheck(), and UT_DEFINE_SCRIPT_METHOD().

◆ SetSuiteName()

void ScenarioAnalyzerMessage::SetSuiteName ( const std::string & aSuiteName )

inline

References mSuiteName.

Referenced by ParseFromIStream(), and runSuiteCheck().

◆ SeverityLevelFromString()

ScenarioAnalyzerMessage::SeverityLevel ScenarioAnalyzerMessage::SeverityLevelFromString ( std::string aString )

static

Get the severity level from a string.

References cERROR, cNOTE, and cWARNING.

Referenced by ParseFromIStream(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ SeverityString()

std::string ScenarioAnalyzerMessage::SeverityString ( SeverityLevel aSeverityLevel )

static

Get the severity level as a string.

References cERROR, cNOTE, and cWARNING.

Referenced by UT_DEFINE_SCRIPT_METHOD(), and Write().

◆ Write()

void ScenarioAnalyzerMessage::Write ( std::ostream & aOut = std::cout ) const

Write the message to an output stream. Standard output stream is used if no output stream is specified by the caller. NOTE: ScenarioAnalyzerMessage::ParseFromIStream must change when this format changes!!

References mCheckName, mDetails, mLocations, mSeverity, mSuiteName, and SeverityString().

Referenced by notifyOfPlatformsNotPresentInSimulation(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

Member Data Documentation

◆ cNUM_SEVERITIES

const int ScenarioAnalyzerMessage::cNUM_SEVERITIES = 3

static

The number of severity levels.

◆ cSCRIPT_CLASS_NAME

const char * ScenarioAnalyzerMessage::cSCRIPT_CLASS_NAME = "ScenarioAnalyzerMessage"

static

Referenced by ConvertMessagesToScript(), GetScriptClassName(), and ScriptScenarioAnalyzerMessageClass::ScriptScenarioAnalyzerMessageClass().

◆ mCheckName

std::string ScenarioAnalyzerMessage::mCheckName

protected

Name of the check.

Referenced by Clear(), GetCheckName(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), SetCheckName(), and Write().

◆ mDetails

std::string ScenarioAnalyzerMessage::mDetails

protected

Details of the message.

Referenced by AddDetails(), ClearDetails(), GetDetails(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), SetDetails(), SetSuccessful(), and Write().

◆ mLocations

std::vector<ScenarioFileLocation> ScenarioAnalyzerMessage::mLocations

protected

Location of input blocks related to the message being generated.

Referenced by AddScenarioFileLocation(), ClearDetails(), GetScenarioFileLocations(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), and Write().

◆ mSeverity

SeverityLevel ScenarioAnalyzerMessage::mSeverity

protected

Severity level of the message.

Referenced by Clear(), GetSeverity(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), SetSeverity(), SetSuccessful(), and Write().

◆ mSuccessful

bool ScenarioAnalyzerMessage::mSuccessful

protected

The message represents a successful result.

Referenced by IsSuccessfulResult(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), and SetSuccessful().

◆ mSuiteName

std::string ScenarioAnalyzerMessage::mSuiteName

protected

Name of the suite.

Referenced by Clear(), GetSuiteName(), ScenarioAnalyzerMessage(), ScenarioAnalyzerMessage(), SetSuiteName(), and Write().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ SeverityLevel

Constructor & Destructor Documentation

◆ ScenarioAnalyzerMessage() [1/5]

◆ ScenarioAnalyzerMessage() [2/5]

◆ ScenarioAnalyzerMessage() [3/5]

◆ ScenarioAnalyzerMessage() [4/5]

◆ ScenarioAnalyzerMessage() [5/5]

Member Function Documentation

◆ AddDetails()

◆ AddScenarioFileLocation()

◆ Clear()

◆ ClearDetails()

◆ GetCheckName()

◆ GetDetails()

◆ GetScenarioFileLocations()

◆ GetScriptClassName()

◆ GetSeverity()

◆ GetSuiteName()

◆ IsSuccessfulResult()

◆ ParseFromIStream()

◆ SetCheckName()

◆ SetDetails()

◆ SetSeverity()

◆ SetSuccessful()

◆ SetSuiteName()

◆ SeverityLevelFromString()

◆ SeverityString()

◆ Write()

Member Data Documentation

◆ cNUM_SEVERITIES

◆ cSCRIPT_CLASS_NAME

◆ mCheckName

◆ mDetails

◆ mLocations

◆ mSeverity

◆ mSuccessful

◆ mSuiteName