winIDEA SDK
isys::CScriptConfig Class Reference

Description

This class contains configuration for calling script functions from testIDEA.

Default operator =() can be used.

#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
 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. More...
 
std::string getWorkingDir ()
 Returns script working directory.
 
virtual bool isEmpty () const
 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. More...
 
void setWorkingDir (const std::string &workingDir)
 Sets script working directory.
 
virtual std::string toString ()
 Returns object data as YAML string.
 

Static Public Member Functions

static CScriptConfigSPtr cast (const CTestBaseSPtr &testBase)
 Casts the given object to this class. More...
 

Protected Member Functions

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

Member Function Documentation

◆ cast()

static 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.

◆ 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!

◆ 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!