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

This class defines target initialization steps to be performed before running tests. More...

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CInitSequenceAction:
isys::CTestBase

Public Types

enum  EInitAction {
  EIAConnectToCore , EIADownload ,
  EIAReset , EIARun ,
  EIADeleteAllBreakpoints , EIACallTargetFunction ,
  EIACallScriptFunction , EIALoadSymbolsOnly ,
  EIAWaitUntilStopped
}
 This enum defines actions, which can be performed during target initialization before tests are run. More...
enum  EInitSequenceSectionIds
 Ids of test specification sections.

Public Member Functions

virtual void assign (const CTestObjectSPtr &base)
 Assigns members of base to this.
 CInitSequenceAction (const CTestBaseSPtr &parent)
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.
CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const
 Creates a new empty instance of this class.
CInitSequenceAction::EInitAction getAction ()
 Returns action to be performed.
std::string getActionName ()
 Returns action name as human readable string - may be used for logging and debugging.
std::string getClassName () const
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
std::string getCoreId ()
 Returns ID of the core where action should be performed.
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.
void setAction (CInitSequenceAction::EInitAction action)
virtual void setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void setCoreId (const std::string &coreId)
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.

Static Public Member Functions

static CInitSequenceActionSPtr 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 defines target initialization steps to be performed before running tests.

It supports initialization of multiple cores.

Member Enumeration Documentation

◆ EInitAction

This enum defines actions, which can be performed during target initialization before tests are run.

Enumerator
EIAConnectToCore 

establish connection to secondary core(s).

Normally primary winIDEA has to perform download before launching winIDEAs for other cores. Mandatory parameter is core index.

EIADownload 

Downloads executable.

EIAReset 

Resets target.

EIARun 

Runs target, optional parameter is stop function.

EIADeleteAllBreakpoints 

Deletes all breakpoints on core.

EIACallTargetFunction 

Calls function on target.

Requires function name as first parameter, other parameters are passed as function parameters.

EIACallScriptFunction 

Calls script function.

Requires function name as first parameter other parameters are passed as function parameters

EIALoadSymbolsOnly 

If the code is already downloaded to the target, this action initializes debugger and loads symbols to winDEA.

EIAWaitUntilStopped 

Waits until core stops execution.

Should be used after core is started from another core.

Constructor & Destructor Documentation

◆ CInitSequenceAction()

isys::CInitSequenceAction::CInitSequenceAction ( const CTestBaseSPtr & parent)
Since
9.12.288

Member Function Documentation

◆ assign()

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

Assigns members of base to this.

Since
9.12.288

Reimplemented in isys::CTestFunction.

◆ cast()

CInitSequenceActionSPtr isys::CInitSequenceAction::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.

◆ containsSection()

bool isys::CTestBase::containsSection ( int section) const
inherited

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

Since
9.12.288

◆ copy()

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

Creates a deep copy of this object.

Parent is set.

Since
9.12.288

◆ createInstance()

CTestBaseSPtr isys::CInitSequenceAction::createInstance ( const CTestBaseSPtr & parent) const
virtual

Creates a new empty instance of this class.

Since
9.12.288

Implements isys::CTestBase.

◆ getAction()

CInitSequenceAction::EInitAction isys::CInitSequenceAction::getAction ( )

Returns action to be performed.

Use CSequenceAdapter to get parameters.

Since
9.12.288

◆ getActionName()

std::string isys::CInitSequenceAction::getActionName ( )

Returns action name as human readable string - may be used for logging and debugging.

Since
9.12.288

◆ getClassName()

std::string isys::CTestBase::getClassName ( ) const
inherited
Since
9.12.288

◆ getContainerTestNode()

virtual CTestTreeNodeSPtr isys::CTestBase::getContainerTestNode ( )
virtualinherited

virtual CTestSpecificationSPtr getContainerTestSpec();

Since
9.12.288

◆ getCoreId()

std::string isys::CInitSequenceAction::getCoreId ( )

Returns ID of the core where action should be performed.

Since
9.12.288

◆ getEnumTagValue()

int isys::CTestBase::getEnumTagValue ( int section)
inherited

Returns value of enum type.

Since
9.12.288

◆ getParent()

CTestBaseSPtr isys::CTestBase::getParent ( ) const
inherited

Returns parent.

Since
9.12.288

◆ getSectionId()

int isys::CTestBase::getSectionId ( const std::string & sectionName)
inherited

Returns section ID for the given section name.

Since
9.12.288

◆ getTestBase()

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

◆ getTestBaseList()

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

◆ getTestObjType()

CTestObject::ETestObjType isys::CTestBase::getTestObjType ( ) const
inherited

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

Since
9.12.288

◆ isEmpty()

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

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

Since
9.12.288

◆ isSectionEmpty()

bool isys::CTestBase::isSectionEmpty ( int sectionId)
inherited

Returns true, if the given section is empty.

Since
9.12.288

◆ isSerializedAsList()

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

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)
virtualinherited

Sends contents of this class to emitter.

Since
9.12.288

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

◆ setAction()

void isys::CInitSequenceAction::setAction ( CInitSequenceAction::EInitAction action)
See also
getAction.
Since
9.12.288

◆ setComment()

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

◆ setCoreId()

void isys::CInitSequenceAction::setCoreId ( const std::string & coreId)
See also
getCoreId.
Since
9.12.288

◆ setEnumTagValue()

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

Sets value of enum type.

Since
9.12.288

◆ setMainMapStyle()

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

Sets style of the mapping for complete object.

Since
9.12.288

◆ setParent()

void isys::CTestBase::setParent ( CTestBaseSPtr parent)
inherited

Sets parent.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288