 Kinova | |
  API | |
   Jaco | |
    Configurations | |
     CJacoConfigurationManager | This class represents all configurations inside JACO. It is devides in three section : General configuration, Client configuration and Protection zones configuration. |
    Control | |
     Trajectory | |
     CJacoControlManager | This class represent all method needed to move and control JACO from a computer via USB protocol. |
    Diagnostic | |
     CJacoDiagnosticDataManager | This class represents all the method you need to access diagnostic data from JACO. From this class you can access and manage errors stored in JACO and all information from the class CPosition. |
     CJacoDiagnosticManager | This class represents an access to the diagnostic interface of JACO. The diagnostic interface's methods are separated in 3 group: test, data and tools. |
    Maintenance | |
     CJacoToolManager | This class represents all the diagnostic tools method of JACO. Now, there is only method and it is the one to reprogram the main board. |
    ValidationTools | |
     Errors | |
     Exceptions | |
      CAccessDeniedException | Normally, you got this exception when you did not provided a valid password at the declaration of an object. |
      CAPIException | Base class exception of this API |
      CInvalidFunctionalityArgumentException | A custom exception that indicates that the arguments sent are invalid. |
      CJACOOfflineException | This exception occur when JACO is not connected to USB port or the USB connection is broken. |
      CTCPCommandErrorException | |
      CXMLSerializationException | Exception that indicates a problem with the XML serialization/deserialization. If you are deserializing, check if the file exist and if it is not corrupted. If you are serializing an object that implement some interface, make sure that they can be serialized. |
    CJacoArm | This class is the root class of this API, it represents a Jaco robot arm. This is the entry point if you want to communicate with a Jaco robot. Note that to declare and initialize a CJacoArm object, you need to specify a valid password provided by kinova. Once the object is declared and initialized, you can access the API freely. |
  DLL | |
   Data | |
    Jaco | |
     Config | |
      CButtonsEvents | This class encapsulate and represent informations about a Button event. From that class, you can configure a button's set of functionnality. The actual version cover all those action: a click, a double click, holding for 1 second, holding for 2 seconds, holding for 3 seconds, holding for 4 seconds and holding the button down. |
      CClientConfigurations | This class encapsulates and represent all informations about a client's configuration. If you want to configure the client's No, the client's name, The client organization's name or anything related to the client, this is the class you need to use. |
      CControlMapping | This class represents a controlmapping. A controlmapping basically have 2 lists of control modemap and a mode. |
      CControlMappingCharts | This class encapsulate and represent informations about a Control mapping charts. This class is the root class of the control mapping system. Basically, the CControlMappingCharts is a list of 6 distinctive mapping. |
      CControlsModeMap | This serializable class encapsulate and represent informations about the control modemap. Basically, the CControlsModeMap have a list of functionnality for the button events and another list of functionnality for the stick events. |
      CStickEvents | This class encapsulate and represent informations about a stick event. |
      CSystemStatus | This class encapsulate and represent informations about the system's status. |
      CUserPosition | This serializable class encapsulate and represent informations about a Jaco's hand position. |
      CZone | This class represents a 3D zone with some limitation. |
      CZoneLimitation | This serializable class encapsulate and represent informations about the limitation of a zone. Note that in angular mode, some member of the class change. LinearSpeed = Speed of the first 3 joints, AngularSpeed = Speed of the 3 last joints, linear force = force of the 3 first joints and Anglar force = force of the 3 last joints. Acceleration is not yet supported |
      CZoneList | This serializable class encapsulate and represent informations about a list of zone. |
      CZoneShape | This serializable class encapsulate and represent informations about the shape of a zone. |
     Control | |
      CInfoFIFOTrajectory | A class that represents all data about the trajectory FIFO of the robotic arm Jaco. |
      CJacoFinger | This class represents a finger of the Jaco's hand. |
      CJacoGripper | This class represents the hand of the robotic arm Jaco. |
      CMathTrajectory | |
       UnitVector | |
      CPointsTrajectory | |
      CQuickStatus | |
      CSingularityVector | A vector that lead to a singularity. |
      CSpasmFilter | This class represents a generic cartesian information bloc of the robot. |
      CTrajectoryInfo | This serializable class encapsulate and represent informations about the info of a trajetory. |
      ITrajectory | |
     Diagnostic | |
      CCaptorsInfo | This class contains data related to the captors of Jaco |
      CError | This class represents an error occur in Jaco. |
      CPosition | This class represent a snapshot of JACO information at a specific moment. It encapsulate time information |
     Exceptions | |
      CJACOInvalidArgumentException | This class represents an exception that occur when there a invalid argument is passed to Jaco |
     CJacoStructures | This class contains all data and enum used in the library. Also, every structure in this class possess a sister class that should be use instead of those struct. Normally, developper should not use those struct. |
     CJoystickValue | This class represents the value contained in a 6-axis joystick. It contains value of all buttons and the value of every position of the "controlstick". |
     CPeripheralInformation | This class represents all informations about every peripheric that interacts with Jaco. |
     CPoint3d | This class encapsulate and represent informations about a point in space. |
     CThreshold | Class that contains constant field representing client configurations's threshold. |
    Util | |
     CAngularInfo | This class represents a generic cartesian information bloc of the robot. |
     CCartesianInfo | This class represents a generic cartesian information bloc of the robot. |
     CStringCheck | |
     CVectorAngle | This class represents a vector of 6 angles. Mainly, this class is used to represent the 6 joints of Jaco. This kind of vector should be used in an angular control context. |
     CVectorEuler | A vector represented by 3 coordinates and 3 angles. The coordinates gives a space position of the hand of JACO. The angles gives the orientation of the hand. This kind of vector should be used in a cartesian control context. |