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

NewSimulatorDimi Class Reference

Class for simulating Dimi. More...

#include <new_sim_dimi.h>

Inheritance diagram for NewSimulatorDimi:

Inheritance graph
[legend]
Collaboration diagram for NewSimulatorDimi:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 NewSimulatorDimi (NewSimulatorResource *res)
 Constructor.
 NewSimulatorDimi (NewSimulatorResource *res, SaHpiRdrT rdr)
 Full qualified constructor to fill an object with the parsed data.
virtual ~NewSimulatorDimi ()
 Destructor.
virtual unsigned int Num () const
 Return DimiId.
SaHpiDimiTestNumT GetTestId ()
 Get a valid test id.
bool SetData (SaHpiDimiRecT dimiRec)
 Set dimi record data.
bool SetInfo (SaHpiDimiInfoT spec)
 Set dimi information data.
bool AddTest (NewSimulatorDimiTest *test)
 Add a test.
virtual bool CreateRdr (SaHpiRptEntryT &resource, SaHpiRdrT &rdr)
 A rdr structure is filled with the data.
SaErrorT GetResults (SaHpiDimiTestNumT id, SaHpiDimiTestResultsT &results)
 HPI function saHpiDimiTestResultsGet().
SaErrorT GetStatus (SaHpiDimiTestNumT id, SaHpiDimiTestPercentCompletedT &perc, SaHpiDimiTestRunStatusT &status)
 HPI function saHpiDimiTestStatusGet().
SaErrorT CancelTest (SaHpiDimiTestNumT id)
 HPI function saHpiDimiTestCancel().
SaErrorT StartTest (SaHpiDimiTestNumT id, SaHpiUint8T number, SaHpiDimiTestVariableParamsT *param)
 HPI function saHpiDimiTestStart().
SaErrorT GetReadiness (SaHpiDimiTestNumT id, SaHpiDimiReadyT &ready)
 HPI function saHpiDimiTestReadinessGet().
SaErrorT GetTestInfo (SaHpiDimiTestNumT id, SaHpiDimiTestT &tinfo)
 HPI function saHpiDimiTestInfoGet().
SaErrorT GetInfo (SaHpiDimiInfoT &info)
 HPI function saHpiDimiInfoGet().
virtual void Dump (NewSimulatorLog &dump) const
 Dump the dimi information.

Detailed Description

Class for simulating Dimi.


Member Function Documentation

bool NewSimulatorDimi::AddTest NewSimulatorDimiTest t  ) 
 

Add a test.

Parameters:
t pointer on NewSimulatorDimiTest to be added
Returns:
true

SaErrorT NewSimulatorDimi::CancelTest SaHpiDimiTestNumT  id  ) 
 

HPI function saHpiDimiTestCancel().

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

Parameters:
id id of test
Returns:
HPI return code

bool NewSimulatorDimi::CreateRdr SaHpiRptEntryT &  resource,
SaHpiRdrT &  rdr
[virtual]
 

A rdr structure is filled with the data.

This method is called by method NewSimulatorRdr::Populate().

Parameters:
resource Address of resource structure
rdr Address of rdr structure
Returns:
true

Reimplemented from NewSimulatorRdr.

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

Dump the dimi information.

Parameters:
dump Address of the log

Implements NewSimulatorRdr.

SaErrorT NewSimulatorDimi::GetInfo SaHpiDimiInfoT &  info  ) 
 

HPI function saHpiDimiInfoGet().

See also the description of the function inside the specification or header file. Copying the internal values (if a read is allowed).

Parameters:
info address of the DimiInfo record to be filled
Returns:
HPI return code

SaErrorT NewSimulatorDimi::GetReadiness SaHpiDimiTestNumT  id,
SaHpiDimiReadyT &  ready
 

HPI function saHpiDimiTestReadinessGet().

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

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

SaErrorT NewSimulatorDimi::GetResults SaHpiDimiTestNumT  id,
SaHpiDimiTestResultsT &  results
 

HPI function saHpiDimiTestResultsGet().

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

Parameters:
id id of test
results address to store the results of the last run
Returns:
HPI return code

SaErrorT NewSimulatorDimi::GetStatus SaHpiDimiTestNumT  id,
SaHpiDimiTestPercentCompletedT &  perc,
SaHpiDimiTestRunStatusT &  status
 

HPI function saHpiDimiTestStatusGet().

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

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

SaErrorT NewSimulatorDimi::GetTestInfo SaHpiDimiTestNumT  id,
SaHpiDimiTestT &  tinfo
 

HPI function saHpiDimiTestInfoGet().

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

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

bool NewSimulatorDimi::SetData SaHpiDimiRecT  dimiRec  ) 
 

Set dimi record data.

Parameters:
dimiRec DimiRecord data
Returns:
true (simple copy)

bool NewSimulatorDimi::SetInfo SaHpiDimiInfoT  info  ) 
 

Set dimi information data.

Parameters:
info record with information
Returns:
true

SaErrorT NewSimulatorDimi::StartTest SaHpiDimiTestNumT  id,
SaHpiUint8T  number,
SaHpiDimiTestVariableParamsT *  param
 

HPI function saHpiDimiTestStart().

See also the description of the function inside the specification or header file. Copying the internal values (if a read is allowed).

Parameters:
id id of test
number number of parameters
param pointer on array including the parameters
Returns:
HPI return code


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