isys::CTestAnalyzer Class Reference

This class contains specification for analyzer document. More...

#include <CTestAnalyzer.h>

Inheritance diagram for isys::CTestAnalyzer:

Public Types
enum	EAnalyzerSectionId
	Ids of test specification sections.
enum	EOpenMode {   EUpdate , EWrite ,   EAppend }
	Open modes for analyzer file. More...
enum	ERunMode { M_OFF , M_START }
	Run modes. More...

Public Member Functions
	CTestAnalyzer (const CTestBaseSPtr &parent)
	Initializes new instance.
CTestAnalyzerCoverageSPtr	getCoverage (bool isConst)
	Returns coverage configuration.
std::string	getDocumentFileName ()
	Returns name of the document to contain trace results.
EOpenMode	getOpenMode ()
	Returns open mode.
CTestAnalyzerProfilerSPtr	getProfiler (bool isConst)
	Returns profiler configuration.
ERunMode	getRunMode ()
	Returns run mode.
CTestAnalyzerTraceSPtr	getTrace (bool isConst)
	Returns trace configuration.
std::string	getTriggerName ()
	Returns the name of the trigger to be used for trace start.
iconnect::ETristate	isCloseAfterTest ()
	Returns true, if the document should be closed after test.
virtual bool	isEmpty () const
	This method returns true, if the object contains no data.
virtual bool	isMerged () const
	Returns true, if the CTestSpecification section containing this object is merged.
iconnect::ETristate	isPredefinedTrigger ()
	Returns E_TRUE, if existing trigger from trd file should be used.
iconnect::ETristate	isSaveAfterTest ()
	Returns true, if the document should be saved after test.
iconnect::ETristate	isSlowRun ()
	Returns E_TRUE, if slow run should be used for analyzer.
virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.
void	setCloseAfterTest (iconnect::ETristate isClose)
	Sets close operation for trace document after test.
void	setDocumentFileName (const std::string &docFileName)
	Sets the name of the trace document.
void	setOpenMode (EOpenMode openMode)
	Sets open mode for document.
void	setPredefinedTrigger (iconnect::ETristate isPredefinedTrigger)
	If isPredefinedTrigger == E_TRUE, then analyzer trigger is not modified by testIDEA.
void	setRunMode (ERunMode mode)
	Sets run mode.
void	setSaveAfterTest (iconnect::ETristate isSave)
	Sets save operation for trace document after test.
void	setSlowRun (iconnect::ETristate isSlowRun)
	If parameter is true, then slow run is used for analyzer.
void	setTriggerName (const std::string &triggerName)
	Sets name of the trigger to be used for trace start.
virtual std::string	toString ()
	Returns object data as YAML string.

Static Public Member Functions
static CTestAnalyzerSPtr	cast (const CTestBaseSPtr &testBase)
	Casts the given object to this class.

Protected Member Functions
void	setStaticTagsAsConst ()
	This method is called by all objects which are immediately contained in CTestSpecification, for example CTestCoverage, CTestHIL, ...

Detailed Description

This class contains specification for analyzer document.

 

Member Enumeration Documentation

EOpenMode

enum isys::CTestAnalyzer::EOpenMode

Open modes for analyzer file.

Enumerator
EUpdate	When document is opened, data is not erased. The document must exist.
EWrite	When document is opened, data is erased, configuration is kept. If the doc. does not exist, it is created.
EAppend	When document is opened, data is preserved, start will append new recording to existing data. Currently available only for coverage, and only when profiler analysis is not performed.

ERunMode

enum isys::CTestAnalyzer::ERunMode

Run modes.

Enumerator
M_OFF	analyzer will not be configured or started
M_START	start analyzer

Constructor & Destructor Documentation

CTestAnalyzer()

isys::CTestAnalyzer::CTestAnalyzer

(

const CTestBaseSPtr &

parent

)

Initializes new instance.

Parameters

parent

an instance of parent CTestSpecification class. Used only when parsing YAML declaration. Can be specified as NULL if the object is not initialized by parser.

Member Function Documentation

cast()

CTestAnalyzerSPtr isys::CTestAnalyzer::cast ( const CTestBaseSPtr & testBase )

static

Casts the given object to this class.

Returns NULL if input is NULL.

Exceptions

IllegalArgumentException

if input object is not instance of this class.

getTriggerName()

std::string isys::CTestAnalyzer::getTriggerName

(

)

Returns the name of the trigger to be used for trace start.

The trigger should be defined in winIDEA GUI.

isPredefinedTrigger()

iconnect::ETristate isys::CTestAnalyzer::isPredefinedTrigger

(

)

Returns E_TRUE, if existing trigger from trd file should be used.

testIDEA does not modify trigger settings in such case.

setPredefinedTrigger()

void isys::CTestAnalyzer::setPredefinedTrigger

(

iconnect::ETristate

isPredefinedTrigger

)

If isPredefinedTrigger == E_TRUE, then analyzer trigger is not modified by testIDEA.

User has to define it in trd file in advance.

setTriggerName()

void isys::CTestAnalyzer::setTriggerName

(

const std::string &

triggerName

)

Sets name of the trigger to be used for trace start.

The trigger must be defined in winIDEA GUI.