Member values
| Member name | Data type | Description |
|---|---|---|
| kin | string | Kinova Identification Number of the device |
| model | uint32 | Model of the device |
| country_code | CountryCode | Country code for the device |
| assembly_plant | string | Assembly plant of the device |
| model_year | string | Year of the model |
| degree_of_freedom | uint32 | Number of DOF for the device |
| base_type | uint32 | Type of base for the device |
| end_effector_type | uint32 | End-effector type of the device |
| vision_module_type | uint32 | Vision module type of the device |
| interface_module_type | uint32 | Interface module type of the device |
| arm_laterality | uint32 | Arm laterality of the device |
| wrist_type | uint32 | Wrist type of the device |
| brake_type | uint32 | Brake type of the device |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| kin() | const string& | void | Returns the current value of kin. If kin is not set, returns the empty string/empty bytes. |
| set_kin() | void | const string& | Sets the value of kin. After calling this, kin() will return a copy of value. |
| set_kin() | void | string&& | (C++11 and beyond): Sets the value of kin, moving from the passed string. After calling this, kin() will return a copy of value. |
| set_kin() | void | const char* | Sets the value of kin using a C-style null-terminated string. After calling this, kin() will return a copy of value. |
| mutable_kin() | string * | void | Returns a pointer to the mutable string object that stores kin's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, kin() will return whatever value is written into the given string. |
| clear_kin() | void | void | Clears the value of kin. After calling this, kin() will return the empty string/empty bytes. |
| set_allocated_kin() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_kin(). |
| release_kin() | string * | void | Releases the ownership of kin and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and kin() will return the empty string/empty bytes. |
| model() const | uint32 | void | Returns the current value of model. If the model is not set, returns 0. |
| set_model() | void | uint32 | Sets the value of model. After calling this, model() will return value. |
| clear_model() | void | void | Clears the value of model. After calling this, model() will return the empty string/empty bytes. |
| has_country_code() const | bool | void | Returns true if country_code is set. |
| country_code() | const CountryCode& | void | Returns the current value of country_code. If country_code is not set, returns a CountryCode with none of its fields set (possibly country_code::default_instance()). |
| mutable_country_code() | CountryCode * | void | Returns a pointer to the mutable CountryCode object that stores the field's value. If the field was not set prior to the call, then the returned CountryCode will have none of its fields set (i.e. it will be identical to a newly-allocated CountryCode). After calling this, has_country_code() will return true and country_code() will return a reference to the same instance of CountryCode. |
| clear_country_code() | void | void | Clears the value of the field. After calling this, has_country_code() will return false and country_code() will return the default value. |
| set_allocated_country_code() | void | CountryCode * | Sets the CountryCode object to the field and frees the previous field value if it exists. If the CountryCode pointer is not NULL, the message takes ownership of the allocated CountryCode object and has_ CountryCode() will return true. Otherwise, if the country_code is NULL, the behavior is the same as calling clear_country_code(). |
| release_country_code() | CountryCode * | void | Releases the ownership of the field and returns the pointer of the CountryCode object. After calling this, caller takes the ownership of the allocated CountryCode object, has_country_code() will return false, and country_code() will return the default value. |
| assembly_plant() | const string& | void | Returns the current value of assembly_plant. If assembly_plant is not set, returns the empty string/empty bytes. |
| set_assembly_plant() | void | const string& | Sets the value of assembly_plant. After calling this, assembly_plant() will return a copy of value. |
| set_assembly_plant() | void | string&& | (C++11 and beyond): Sets the value of assembly_plant, moving from the passed string. After calling this, assembly_plant() will return a copy of value. |
| set_assembly_plant() | void | const char* | Sets the value of assembly_plant using a C-style null-terminated string. After calling this, assembly_plant() will return a copy of value. |
| mutable_assembly_plant() | string * | void | Returns a pointer to the mutable string object that stores assembly_plant's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, assembly_plant() will return whatever value is written into the given string. |
| clear_assembly_plant() | void | void | Clears the value of assembly_plant. After calling this, assembly_plant() will return the empty string/empty bytes. |
| set_allocated_assembly_plant() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_assembly_plant(). |
| release_assembly_plant() | string * | void | Releases the ownership of assembly_plant and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and assembly_plant() will return the empty string/empty bytes. |
| model_year() | const string& | void | Returns the current value of model_year. If model_year is not set, returns the empty string/empty bytes. |
| set_model_year() | void | const string& | Sets the value of model_year. After calling this, model_year() will return a copy of value. |
| set_model_year() | void | string&& | (C++11 and beyond): Sets the value of model_year, moving from the passed string. After calling this, model_year() will return a copy of value. |
| set_model_year() | void | const char* | Sets the value of model_year using a C-style null-terminated string. After calling this, model_year() will return a copy of value. |
| mutable_model_year() | string * | void | Returns a pointer to the mutable string object that stores model_year's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, model_year() will return whatever value is written into the given string. |
| clear_model_year() | void | void | Clears the value of model_year. After calling this, model_year() will return the empty string/empty bytes. |
| set_allocated_model_year() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_model_year(). |
| release_model_year() | string * | void | Releases the ownership of model_year and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and model_year() will return the empty string/empty bytes. |
| degree_of_freedom() | uint32 | void | Returns the current value of degree_of_freedom. If the degree_of_freedom is not set, returns 0. |
| set_degree_of_freedom() | void | uint32 | Sets the value of degree_of_freedom. After calling this, degree_of_freedom() will return value. |
| clear_degree_of_freedom() | void | void | Clears the value of degree_of_freedom. After calling this, degree_of_freedom() will return 0. |
| base_type() const | uint32 | void | Returns the current value of base_type. If the base_type is not set, returns 0. |
| set_base_type() | void | uint32 | Sets the value of base_type. After calling this, base_type() will return value. |
| clear_base_type() | void | void | Clears the value of base_type. After calling this, base_type() will return the empty string/empty bytes. |
| end_effector_type() const | uint32 | void | Returns the current value of end_effector_type. If the end_effector_type is not set, returns 0. |
| set_end_effector_type() | void | uint32 | Sets the value of end_effector_type. After calling this, end_effector_type() will return value. |
| clear_end_effector_type() | void | void | Clears the value of end_effector_type. After calling this, end_effector_type() will return the empty string/empty bytes. |
| vision_module_type() const | uint32 | void | Returns the current value of vision_module_type. If the vision_module_type is not set, returns 0. |
| set_vision_module_type() | void | uint32 | Sets the value of vision_module_type. After calling this, vision_module_type() will return value. |
| clear_vision_module_type() | void | void | Clears the value of vision_module_type. After calling this, vision_module_type() will return the empty string/empty bytes. |
| interface_module_type() const | uint32 | void | Returns the current value of interface_module_type. If the interface_module_type is not set, returns 0. |
| set_interface_module_type() | void | uint32 | Sets the value of interface_module_type. After calling this, interface_module_type() will return value. |
| clear_interface_module_type() | void | void | Clears the value of interface_module_type. After calling this, interface_module_type() will return the empty string/empty bytes. |
| arm_laterality() const | uint32 | void | Returns the current value of arm_laterality. If the arm_laterality is not set, returns 0. |
| set_arm_laterality() | void | uint32 | Sets the value of arm_laterality. After calling this, arm_laterality() will return value. |
| clear_arm_laterality() | void | void | Clears the value of arm_laterality. After calling this, arm_laterality() will return the empty string/empty bytes. |
| wrist_type() const | uint32 | void | Returns the current value of wrist_type. If the wrist_type is not set, returns 0. |
| set_wrist_type() | void | uint32 | Sets the value of wrist_type. After calling this, wrist_type() will return value. |
| clear_wrist_type() | void | void | Clears the value of wrist_type. After calling this, wrist_type() will return the empty string/empty bytes. |
| brake_type() const | uint32 | void | Returns the current value of brake_type. If the brake_type is not set, returns 0. |
| set_brake_type() | void | uint32 | Sets the value of brake_type. After calling this, brake_type() will return value. |
| clear_brake_type() | void | void | Clears the value of brake_type. After calling this, brake_type() will return the empty string/empty bytes. |
Parent topic: ProductConfiguration (C++)