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

This class represents an instruction that call an API method. More...

Inheritance diagram for Kinova.DLL.TestData.Instruction.CAPIInstruction:
Kinova.DLL.TestData.Instruction.CReadInstruction Kinova.DLL.TestData.Instruction.CBasicInstruction Kinova.DLL.TestData.Instruction.CAPITrajInstruction

Public Member Functions

 CAPIInstruction ()
 Initializes a new instance of the CAPIInstruction class. More...
 
override void Init ()
 Initialize all member of the instance. More...
 
override Test.Common.CTest GetTestStructure ()
 This method extracts a CTest structure from the current instruction. More...
 
- Public Member Functions inherited from Kinova.DLL.TestData.Instruction.CReadInstruction
 CReadInstruction ()
 Initializes a new instance of the CReadInstruction class. More...
 
override void Init ()
 Initialize all members 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 CTest GetTestStructure ()
 This method extracts a CTest structure from the current instruction. More...
 
- Public Member Functions inherited from Kinova.DLL.TestData.Instruction.CBasicInstruction
 CBasicInstruction ()
 Initializes a new instance of the CBasicInstruction class. More...
 

Properties

CInstructionDataTypes.APICommandID IDCommand [get, set]
 Identification of the command. More...
 
- Properties inherited from Kinova.DLL.TestData.Instruction.CReadInstruction
CInstructionDataTypes.ComparisonType ComparisonType [get, set]
 The type of the comparison. More...
 
List< string > ResultValueList [get, set]
 The result value. More...
 
List< string > TargetMinList [get, set]
 The lower bound of the comparison range when the comparison type is RANGE. More...
 
List< string > TargetMaxList [get, set]
 The upper bound of the comparison range when the comparison type is RANGE. 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 an API method.

Constructor & Destructor Documentation

Kinova.DLL.TestData.Instruction.CAPIInstruction.CAPIInstruction ( )

Initializes a new instance of the CAPIInstruction class.

Member Function Documentation

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

This method extracts a CTest structure from the current instruction.

Returns

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

Reimplemented in Kinova.DLL.TestData.Instruction.CAPITrajInstruction.

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

Initialize all member of the instance.

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

Reimplemented in Kinova.DLL.TestData.Instruction.CAPITrajInstruction.

Property Documentation

CInstructionDataTypes.APICommandID Kinova.DLL.TestData.Instruction.CAPIInstruction.IDCommand
getset

Identification of the command.


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