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

Public Member Functions

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.CAPIInstruction
 CAPIInstruction ()
 Initializes a new instance of the CAPIInstruction class. 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

CPointsTrajectory Trajectory [get, set]
 Trajectory to be executed if the command is SendTrajectory More...
 
string TrajectoryPath [get, set]
 THe path where the trajectory was taken. More...
 
CInstructionDataTypes.APITrajectoryType TrajectoryType [get, set]
 The type of the trajectory. More...
 
int Iteration [get, set]
 THe number of time that the trajectory will be executed if the type is ITERATION. More...
 
int Time [get, set]
 How long the trajectory will be executed if the type is TIME. More...
 
- Properties inherited from Kinova.DLL.TestData.Instruction.CAPIInstruction
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...
 

Member Function Documentation

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

This method extracts a CTest structure from the current instruction.

Returns

Reimplemented from Kinova.DLL.TestData.Instruction.CAPIInstruction.

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

Initialize all member of the instance.

Reimplemented from Kinova.DLL.TestData.Instruction.CAPIInstruction.

Property Documentation

int Kinova.DLL.TestData.Instruction.CAPITrajInstruction.Iteration
getset

THe number of time that the trajectory will be executed if the type is ITERATION.

int Kinova.DLL.TestData.Instruction.CAPITrajInstruction.Time
getset

How long the trajectory will be executed if the type is TIME.

CPointsTrajectory Kinova.DLL.TestData.Instruction.CAPITrajInstruction.Trajectory
getset

Trajectory to be executed if the command is SendTrajectory

The trajectory.

string Kinova.DLL.TestData.Instruction.CAPITrajInstruction.TrajectoryPath
getset

THe path where the trajectory was taken.

The trajectory path.

CInstructionDataTypes.APITrajectoryType Kinova.DLL.TestData.Instruction.CAPITrajInstruction.TrajectoryType
getset

The type of the trajectory.

The type of the trajectory.


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