API C#
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Kinova.DLL.TestData.Instruction.CReadInstruction Class Reference
Inheritance diagram for Kinova.DLL.TestData.Instruction.CReadInstruction:
Kinova.DLL.TestData.Instruction.CBasicInstruction Kinova.DLL.TestData.Instruction.CAPIInstruction Kinova.DLL.TestData.Instruction.CManualReadInstruction Kinova.DLL.TestData.Instruction.CReadCPositionInstruction Kinova.DLL.TestData.Instruction.CReadRevisionInstruction Kinova.DLL.TestData.Instruction.CReadVersionInstruction Kinova.DLL.TestData.Instruction.CAPITrajInstruction

Public Member Functions

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

Constructor & Destructor Documentation

Kinova.DLL.TestData.Instruction.CReadInstruction.CReadInstruction ( )

Initializes a new instance of the CReadInstruction class.

Member Function Documentation

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

Evaluates the instruction and return the result.

Returns

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

override CTest Kinova.DLL.TestData.Instruction.CReadInstruction.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.CReadRevisionInstruction, and Kinova.DLL.TestData.Instruction.CReadVersionInstruction.

override void Kinova.DLL.TestData.Instruction.CReadInstruction.Init ( )
virtual
override void Kinova.DLL.TestData.Instruction.CReadInstruction.ResetInstruction ( )
virtual

This method reset the current instruction.

Implements Kinova.DLL.TestData.Instruction.CBasicInstruction.

Property Documentation

CInstructionDataTypes.ComparisonType Kinova.DLL.TestData.Instruction.CReadInstruction.ComparisonType
getset

The type of the comparison.

The type of the comparison.

List<string> Kinova.DLL.TestData.Instruction.CReadInstruction.ResultValueList
getset

The result value.

The result value.

List<string> Kinova.DLL.TestData.Instruction.CReadInstruction.TargetMaxList
getset

The upper bound of the comparison range when the comparison type is RANGE.

List<string> Kinova.DLL.TestData.Instruction.CReadInstruction.TargetMinList
getset

The lower bound of the comparison range when the comparison type is RANGE.


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