Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

NewSimulatorDimiTest Class Reference

Class for simulating dimi Test. More...

#include <new_sim_dimi_data.h>

List of all members.

Public Member Functions

 NewSimulatorDimiTest (SaHpiDimiTestNumT id)
 Constructor.
virtual ~NewSimulatorDimiTest ()
 Destructor.
virtual SaHpiDimiTestNumT Num () const
 Return test case id.
bool SetData (SaHpiDimiTestT info)
 Set testcase data - info.
bool SetReadiness (SaHpiDimiReadyT ready)
 Set testcase data - readiness.
bool SetResults (SaHpiDimiTestResultsT results)
 Set testcase data - results.
bool IsRunning ()
 Test if a test case is running.
SaErrorT GetInfo (SaHpiDimiTestT &tinfo)
 HPI function saHpiDimiTestInfoGet().
SaErrorT GetReady (SaHpiDimiReadyT &ready)
 HPI function saHpiDimiTestReadinessGet().
SaErrorT StartTest (SaHpiUint8T number, SaHpiDimiTestVariableParamsT *param)
 HPI function saHpiDimiTestStart().
SaErrorT Cancel ()
 HPI function saHpiDimiTestCancel().
SaErrorT GetStatus (SaHpiDimiTestPercentCompletedT &perc, SaHpiDimiTestRunStatusT &status)
 HPI function saHpiDimiTestStatusGet().
SaErrorT GetResults (SaHpiDimiTestResultsT &results)
 HPI function saHpiDimiTestResultsGet().
virtual void Dump (NewSimulatorLog &dump) const
 Dump Dimi Test information.


Detailed Description

Class for simulating dimi Test.


Member Function Documentation

SaErrorT NewSimulatorDimiTest::Cancel  ) 
 

HPI function saHpiDimiTestCancel().

See also the description of the function inside the specification or header file.

Returns:
HPI return code

void NewSimulatorDimiTest::Dump NewSimulatorLog dump  )  const [virtual]
 

Dump Dimi Test information.

Parameters:
dump Address of the log

SaErrorT NewSimulatorDimiTest::GetInfo SaHpiDimiTestT &  tinfo  ) 
 

HPI function saHpiDimiTestInfoGet().

See also the description of the function inside the specification or header file.

Parameters:
tinfo address of the Dimi test record to be filled
Returns:
HPI return code

SaErrorT NewSimulatorDimiTest::GetReady SaHpiDimiReadyT &  ready  ) 
 

HPI function saHpiDimiTestReadinessGet().

See also the description of the function inside the specification or header file.

Parameters:
ready address to store the Ready information
Returns:
HPI return code

SaErrorT NewSimulatorDimiTest::GetResults SaHpiDimiTestResultsT &  results  ) 
 

HPI function saHpiDimiTestResultsGet().

See also the description of the function inside the specification or header file.

Parameters:
results address to store test results
Returns:
HPI return code

SaErrorT NewSimulatorDimiTest::GetStatus SaHpiDimiTestPercentCompletedT &  perc,
SaHpiDimiTestRunStatusT &  status
 

HPI function saHpiDimiTestStatusGet().

See also the description of the function inside the specification or header file.

Parameters:
perc address to store percentage of test completed
status address to store the status of the last run
Returns:
HPI return code

bool NewSimulatorDimiTest::IsRunning  ) 
 

Test if a test case is running.

Returns:
true if the test case is marked as running

bool NewSimulatorDimiTest::SetData SaHpiDimiTestT  tinfo  ) 
 

Set testcase data - info.

Parameters:
tinfo test information
Returns:
true

bool NewSimulatorDimiTest::SetReadiness SaHpiDimiReadyT  ready  ) 
 

Set testcase data - readiness.

Parameters:
ready readiness value
Returns:
true

bool NewSimulatorDimiTest::SetResults SaHpiDimiTestResultsT  results  ) 
 

Set testcase data - results.

The status is set on SAHPI_DIMITEST_STATUS_FINISHED_NO_ERRORS

Parameters:
results information about results
Returns:
true

SaErrorT NewSimulatorDimiTest::StartTest SaHpiUint8T  number,
SaHpiDimiTestVariableParamsT *  param
 

HPI function saHpiDimiTestStart().

See also the description of the function inside the specification or header file.

Todo:
: add some functionality
Parameters:
number number of parameters
param pointer on array including the parameters
Returns:
HPI return code
Todo:
some functionality behind start dimi test


The documentation for this class was generated from the following files:
Generated on Mon Apr 26 14:39:14 2010 for New Simulator by  doxygen 1.4.4