API C#
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Kinova.DLL.TestData.Instruction.CDSPInstruction Class Reference

This class represents an instruction that call a DSP method. You can use the ParamList to store parameters and result values are returned in the integer and float data list. More...

Inheritance diagram for Kinova.DLL.TestData.Instruction.CDSPInstruction:
Kinova.DLL.TestData.Instruction.CBasicInstruction

Public Member Functions

 CDSPInstruction ()
 Initializes a new instance of the CDSPInstruction class. More...
 
override void Init ()
 Initialize all member of the instance. More...
 
override bool EvaluateInstruction ()
 Evaluates the instruction and return the result. More...
 
override void ResetInstruction ()
 This method reset the current instruction. More...
 
override Test.Common.CTest GetTestStructure ()
 This method extracts a CTest structure from the current instruction. More...
 
int GetIDTest ()
 
- Public Member Functions inherited from Kinova.DLL.TestData.Instruction.CBasicInstruction
 CBasicInstruction ()
 Initializes a new instance of the CBasicInstruction class. More...
 

Public Attributes

const int INTEGER_LIST_MAX_SIZE = 3
 Max quantity that the DSP's integer list can return. More...
 
const int FLOAT_LIST_MAX_SIZE = 3
 Max quantity that the DSP's float list can return. More...
 
const int PARAM_LIST_MAX_SIZE = 2
 Max quantity that the DSP's parameter list can take. More...
 

Properties

List< bool > FloatUseList [get, set]
 A list of flags that indicates which float value are used. More...
 
List< bool > IntegerUseList [get, set]
 A list of flags that indicates which integer value are used. More...
 
CInstructionDataTypes.DSPCommandID IDCommand [get, set]
 Identification of the command. More...
 
List< int > IntegerDataList [get, set]
 Max quantity that the DSP's integer list can return. More...
 
List< int > IntegerDataMinList [get, set]
 Max quantity that the DSP's float list can return. More...
 
List< int > IntegerDataMaxList [get, set]
 Max quantity that the DSP's parameter list can take. More...
 
List
< CInstructionDataTypes.ComparisonType > 
IntegerDataComparisonTypeList [get, set]
 A list of comparison type linked with the integer data list. More...
 
List< float > FloatDataList [get, set]
 The list of float value returned by the DSP. More...
 
List< float > FloatDataMinList [get, set]
 A list of Min threshold linked with the float data list. More...
 
List< float > FloatDataMaxList [get, set]
 A list of Max threshold linked with the float data list. More...
 
List
< CInstructionDataTypes.ComparisonType > 
FloatDataComparisonTypeList [get, set]
 A list of comparison type linked with the float data list. More...
 
List< string > ParamList [get, set]
 A list of parameters that will be send to the DSP. More...
 
UInt32 ErrorCode [get, set]
 Error code returned by the DSP. More...
 
UInt32 ErrorAdress [get, set]
 Address where the error occured in the DSP. More...
 
- Properties inherited from Kinova.DLL.TestData.Instruction.CBasicInstruction
CInstructionDataTypes.InstructionType Type [get, set]
 The type of test instruction. More...
 
List< int > Index [get, set]
 Index of the instruction listed by the level of indexation. More...
 
string Title [get, set]
 The title of the test instruction. Basically, this is what you will be displayed More...
 
bool HasBeenExecuted [get, set]
 Indicates if the instruction has been executed. More...
 
bool IsSub [get, set]
 Indicates if this instruction is a sub instruction More...
 
string Comment [get, set]
 A general comment about the instruction. More...
 
DateTime StartTime [get, set]
 A timestamp to store the starttime of the instruction. More...
 
DateTime StopTime [get, set]
 A timestamp to store the starttime of the instruction. More...
 
bool Result [get, set]
 Indicates if the instruction PASSED or FAILED. More...
 

Detailed Description

This class represents an instruction that call a DSP method. You can use the ParamList to store parameters and result values are returned in the integer and float data list.

Constructor & Destructor Documentation

Kinova.DLL.TestData.Instruction.CDSPInstruction.CDSPInstruction ( )

Initializes a new instance of the CDSPInstruction class.

Member Function Documentation

override bool Kinova.DLL.TestData.Instruction.CDSPInstruction.EvaluateInstruction ( )
virtual

Evaluates the instruction and return the result.

Returns

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

override Test.Common.CTest Kinova.DLL.TestData.Instruction.CDSPInstruction.GetTestStructure ( )
virtual

This method extracts a CTest structure from the current instruction.

Returns

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

override void Kinova.DLL.TestData.Instruction.CDSPInstruction.Init ( )
virtual

Initialize all member of the instance.

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

override void Kinova.DLL.TestData.Instruction.CDSPInstruction.ResetInstruction ( )
virtual

This method reset the current instruction.

Returns

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

Member Data Documentation

const int Kinova.DLL.TestData.Instruction.CDSPInstruction.FLOAT_LIST_MAX_SIZE = 3

Max quantity that the DSP's float list can return.

const int Kinova.DLL.TestData.Instruction.CDSPInstruction.INTEGER_LIST_MAX_SIZE = 3

Max quantity that the DSP's integer list can return.

const int Kinova.DLL.TestData.Instruction.CDSPInstruction.PARAM_LIST_MAX_SIZE = 2

Max quantity that the DSP's parameter list can take.

Property Documentation

UInt32 Kinova.DLL.TestData.Instruction.CDSPInstruction.ErrorAdress
getset

Address where the error occured in the DSP.

UInt32 Kinova.DLL.TestData.Instruction.CDSPInstruction.ErrorCode
getset

Error code returned by the DSP.

List<CInstructionDataTypes.ComparisonType> Kinova.DLL.TestData.Instruction.CDSPInstruction.FloatDataComparisonTypeList
getset

A list of comparison type linked with the float data list.

List<float> Kinova.DLL.TestData.Instruction.CDSPInstruction.FloatDataList
getset

The list of float value returned by the DSP.

List<float> Kinova.DLL.TestData.Instruction.CDSPInstruction.FloatDataMaxList
getset

A list of Max threshold linked with the float data list.

List<float> Kinova.DLL.TestData.Instruction.CDSPInstruction.FloatDataMinList
getset

A list of Min threshold linked with the float data list.

List<bool> Kinova.DLL.TestData.Instruction.CDSPInstruction.FloatUseList
getset

A list of flags that indicates which float value are used.

CInstructionDataTypes.DSPCommandID Kinova.DLL.TestData.Instruction.CDSPInstruction.IDCommand
getset

Identification of the command.

List<CInstructionDataTypes.ComparisonType> Kinova.DLL.TestData.Instruction.CDSPInstruction.IntegerDataComparisonTypeList
getset

A list of comparison type linked with the integer data list.

List<int> Kinova.DLL.TestData.Instruction.CDSPInstruction.IntegerDataList
getset

Max quantity that the DSP's integer list can return.

List<int> Kinova.DLL.TestData.Instruction.CDSPInstruction.IntegerDataMaxList
getset

Max quantity that the DSP's parameter list can take.

List<int> Kinova.DLL.TestData.Instruction.CDSPInstruction.IntegerDataMinList
getset

Max quantity that the DSP's float list can return.

List<bool> Kinova.DLL.TestData.Instruction.CDSPInstruction.IntegerUseList
getset

A list of flags that indicates which integer value are used.

List<string> Kinova.DLL.TestData.Instruction.CDSPInstruction.ParamList
getset

A list of parameters that will be send to the DSP.


The documentation for this class was generated from the following file: