winIDEA SDK
Loading...
Searching...
No Matches
isys::CScriptConfig Class Reference

This class contains configuration for calling script functions from testIDEA. More...

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CScriptConfig:
isys::CTestBase

Public Types

enum  ETestScriptConfigSectionIds
 Ids of test specification sections.

Public Member Functions

CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const override
 Creates a new empty instance of this class.
std::string getExtensionClass ()
 Returns class to use as a extension object during tests.
void getModules (iconnect::StrVector &modules)
 Returns vector of modules/libraries to import/load by script interpreter before execution of tests.
void getSysPaths (iconnect::StrVector &paths)
 Returns the module/library search path for script interpreter.
int getTimeout ()
 Returns how long in seconds caller should wait for script calls to return.
std::string getWorkingDir ()
 Returns script working directory.
bool isEmpty () const override
 This method returns true, if the object contains no data.
virtual void serialize (const isys::IEmitterSPtr &emitter)
 Sends contents of this class to emitter.
void setExtensionClass (const std::string &extensionClass)
 Sets class to use as a callback object during tests.
void setModules (const iconnect::StrVector &modules)
 Setss vector of modules/libraries to import/load by script interpreter before execution of tests.
void setSysPaths (const iconnect::StrVector &sysPaths)
 Sets modules/libraries to import/load by script interpreter before execution of tests.
void setTimeout (int timeout)
 Sets how long in seconds caller should wait for script calls to return.
void setWorkingDir (const std::string &workingDir)
 Sets script working directory.
std::string toString () override
 Returns object data as YAML string.

Static Public Member Functions

static CScriptConfigSPtr 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 configuration for calling script functions from testIDEA.

Default operator =() can be used.

Member Function Documentation

◆ cast()

CScriptConfigSPtr isys::CScriptConfig::cast ( const CTestBaseSPtr & testBase)
static

Casts the given object to this class.

Returns NULL if input is NULL.

Exceptions
IllegalArgumentExceptionif input object is not instance of this class.

◆ createInstance()

CTestBaseSPtr isys::CScriptConfig::createInstance ( const CTestBaseSPtr & parent) const
overridevirtual

Creates a new empty instance of this class.

Since
9.12.288

Implements isys::CTestBase.

◆ getExtensionClass()

std::string isys::CScriptConfig::getExtensionClass ( )

Returns class to use as a extension object during tests.

Since
9.12.288

◆ getModules()

void isys::CScriptConfig::getModules ( iconnect::StrVector & modules)

Returns vector of modules/libraries to import/load by script interpreter before execution of tests.

Since
9.12.288

◆ getSysPaths()

void isys::CScriptConfig::getSysPaths ( iconnect::StrVector & paths)

Returns the module/library search path for script interpreter.

Since
9.12.288

◆ getTimeout()

int isys::CScriptConfig::getTimeout ( )

Returns how long in seconds caller should wait for script calls to return.

If it does not return in this time, the test is considered as failed!

Since
9.12.288

◆ getWorkingDir()

std::string isys::CScriptConfig::getWorkingDir ( )

Returns script working directory.

Since
9.12.288

◆ isEmpty()

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

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

Since
9.12.288

◆ serialize()

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

Sends contents of this class to emitter.

Since
9.12.288

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

◆ setExtensionClass()

void isys::CScriptConfig::setExtensionClass ( const std::string & extensionClass)

Sets class to use as a callback object during tests.

Since
9.12.288

◆ setModules()

void isys::CScriptConfig::setModules ( const iconnect::StrVector & modules)

Setss vector of modules/libraries to import/load by script interpreter before execution of tests.

Since
9.12.288

◆ setSysPaths()

void isys::CScriptConfig::setSysPaths ( const iconnect::StrVector & sysPaths)

Sets modules/libraries to import/load by script interpreter before execution of tests.

Since
9.12.288

◆ setTimeout()

void isys::CScriptConfig::setTimeout ( int timeout)

Sets how long in seconds caller should wait for script calls to return.

If it does not return in this time, the test is considered as failed!

Since
9.12.288

◆ setWorkingDir()

void isys::CScriptConfig::setWorkingDir ( const std::string & workingDir)

Sets script working directory.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288