isys::CTestBase Class Reference

This is a base class for all data objects in itest. More...

#include <CTestBase.h>

Inheritance diagram for isys::CTestBase:

Public Member Functions
virtual void	assign (const CTestObjectSPtr &base)
	Assigns members of base to this.
bool	containsSection (int section) const
	Returns true, if the specified section exists for this object.
virtual CTestObjectSPtr	copy () const
	Creates a deep copy of this object.
std::string	getClassName () const
virtual CTestTreeNodeSPtr	getContainerTestNode ()
	virtual CTestSpecificationSPtr getContainerTestSpec();
int	getEnumTagValue (int section)
	Returns value of enum type.
CTestBaseSPtr	getParent () const
	Returns parent.
int	getSectionId (const std::string &sectionName)
	Returns section ID for the given section name.
CTestBaseSPtr	getTestBase (int section, bool isConst)
CTestBaseListSPtr	getTestBaseList (int section, bool isConst)
CTestObject::ETestObjType	getTestObjType () const
	Returns type of this object, which is CTestObject::ETestBase.
virtual bool	isEmpty () const
	This method returns true, if the object contains no data.
bool	isSectionEmpty (int sectionId)
	Returns true, if the given section is empty.
virtual bool	isSerializedAsList (bool isParsing)
	Returns true if object should be serialized as list, for example CTestFunction.
virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.
virtual void	setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void	setEnumTagValue (int section, int enumValue)
	Sets value of enum type.
virtual void	setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
	Sets style of the mapping for complete object.
void	setParent (CTestBaseSPtr parent)
	Sets parent.
virtual std::string	toString ()
	Returns object data as YAML string.
virtual	~CTestBase ()

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 is a base class for all data objects in itest.

It may contain other objects of derived types, lists of derived types, scalars, mappings and lists.

Constructor & Destructor Documentation

~CTestBase()

virtual isys::CTestBase::~CTestBase ( )

virtual

Since

9.12.288

Member Function Documentation

assign()

virtual void isys::CTestBase::assign ( const CTestObjectSPtr & base )

virtual

Assigns members of base to this.

Since

9.12.288

Reimplemented in isys::CTestFunction.

containsSection()

bool isys::CTestBase::containsSection

(

int

section

)

const

Returns true, if the specified section exists for this object.

Since

9.12.288

copy()

virtual CTestObjectSPtr isys::CTestBase::copy ( ) const

virtual

Creates a deep copy of this object.

Parent is set.

Since

9.12.288

getClassName()

std::string isys::CTestBase::getClassName

(

)

const

Since

9.12.288

getContainerTestNode()

virtual CTestTreeNodeSPtr isys::CTestBase::getContainerTestNode ( )

virtual

virtual CTestSpecificationSPtr getContainerTestSpec();

Since

9.12.288

getEnumTagValue()

int isys::CTestBase::getEnumTagValue

(

int

section

)

Returns value of enum type.

Since

9.12.288

getParent()

CTestBaseSPtr isys::CTestBase::getParent

(

)

const

Returns parent.

Since

9.12.288

getSectionId()

int isys::CTestBase::getSectionId

(

const std::string &

sectionName

)

Returns section ID for the given section name.

Since

9.12.288

getTestBase()

CTestBaseSPtr isys::CTestBase::getTestBase	(	int	section,
		bool	isConst )

Since

9.12.288

getTestBaseList()

CTestBaseListSPtr isys::CTestBase::getTestBaseList	(	int	section,
		bool	isConst )

Since

9.12.288

getTestObjType()

CTestObject::ETestObjType isys::CTestBase::getTestObjType

(

)

const

Returns type of this object, which is CTestObject::ETestBase.

Since

9.12.288

isEmpty()

virtual bool isys::CTestBase::isEmpty ( ) const

virtual

This method returns true, if the object contains no data.

Since

9.12.288

isSectionEmpty()

bool isys::CTestBase::isSectionEmpty

(

int

sectionId

)

Returns true, if the given section is empty.

Since

9.12.288

isSerializedAsList()

virtual bool isys::CTestBase::isSerializedAsList ( bool isParsing )

virtual

Returns true if object should be serialized as list, for example CTestFunction.

Since

9.12.288

Reimplemented in isys::CTestFunction.

serialize()

virtual void isys::CTestBase::serialize ( const isys::IEmitterSPtr & emitter )

virtual

Sends contents of this class to emitter.

Since

9.12.288

Reimplemented in isys::CLogResult, and isys::CTestEnvironmentConfig.

setComment()

virtual void isys::CTestBase::setComment ( int section, int idx, const std::string & nlComment, const std::string & eolComment )

virtual

Since

9.12.288

setEnumTagValue()

void isys::CTestBase::setEnumTagValue	(	int	section,
		int	enumValue )

Sets value of enum type.

Since

9.12.288

setMainMapStyle()

virtual void isys::CTestBase::setMainMapStyle ( isys::IEmitter::EYamlStyle mappingStyle )

virtual

Sets style of the mapping for complete object.

Since

9.12.288

setParent()

void isys::CTestBase::setParent

(

CTestBaseSPtr

parent

)

Sets parent.

Since

9.12.288

toString()

virtual std::string isys::CTestBase::toString ( )

virtual

Returns object data as YAML string.

Since

9.12.288