winIDEA SDK
isys::CInitSequenceAction Class Reference

Description

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

It supports initialization of multiple cores.

#include <CTestEnvironmentConfig.h>

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

Public Types

enum  EInitSequenceSectionIds
 Ids of test specification sections.
 
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...
 

Public Member Functions

CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const
 Creates a new empty instance of this class.
 
std::string getCoreId ()
 Returns ID of the core where action should be performed.
 
CInitSequenceAction::EInitAction getAction ()
 Returns action to be performed. More...
 
std::string getActionName ()
 Returns action name as human readable string - may be used for logging and debugging.
 
void setCoreId (const std::string &coreId)
 
void setAction (CInitSequenceAction::EInitAction action)
 
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.
 
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. More...
 

Protected Member Functions

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

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.

Member Function Documentation

◆ cast()

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

◆ getAction()

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

Returns action to be performed.

Use CSequenceAdapter to get parameters.

◆ setAction()

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

◆ setCoreId()

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