|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
Data Structures | |
| struct | HRN_cavity_occ_data_s |
| struct | HRN_connector_occ_data_s |
| struct | HRN_fixing_assignment_data_s |
| struct | HRN_general_wire_occ_data_s |
| struct | HRN_part_occ_data_s |
| struct | HRN_protection_area_data_s |
| struct | HRN_wire_color_data_s |
| struct | HRN_wire_length_data_s |
| struct | HRN_wire_protect_occ_data_s |
Macros | |
| #define | HRN_DOUBLE_NULL ((double)-9999.99) |
| #define | HRN_INT_NULL (-9999) |
| #define | HRN_STRING_NULL "NULL" |
Functions | |
| MECHATRONICS_API int | HRN_ask_associated_parts (tag_t cavity_line_tag, int *associated_parts_count, tag_t **associated_part_tags) |
| MECHATRONICS_API int | HRN_ask_fixing_segment (tag_t bom_line_tag, tag_t *segment_tag) |
| MECHATRONICS_API int | HRN_ask_referenced_component (tag_t node_tag, tag_t window_tag, int *reference_comp_count, tag_t **reference_comp_tags) |
| MECHATRONICS_API int | HRN_ask_wire_protection_segment (tag_t wirep_line_tag, tag_t *segment_tag) |
| MECHATRONICS_API int | HRN_ask_wire_protection_segments (tag_t wire_protection_line_tag, int *n_segments, tag_t **segment_tags) |
| MECHATRONICS_API int | HRN_get_all_wire_color (tag_t object_tag, int *count, HRN_wire_color_data_t **wire_color_data) |
| MECHATRONICS_API int | HRN_get_all_wire_length_information (tag_t bom_line, int *count, HRN_wire_length_data_t **length_data) |
| MECHATRONICS_API int | HRN_get_cavity_data (tag_t cavity_line_tag, HRN_cavity_occ_data_t *cavity_occ_data) |
| MECHATRONICS_API int | HRN_get_connector_occ_data (tag_t bom_line_tag, HRN_connector_occ_data_t *connector_occ_data) |
| MECHATRONICS_API int | HRN_get_fixing_assignment_data (tag_t fixing_line_tag, HRN_fixing_assignment_data_t *assignment_data) |
| MECHATRONICS_API int | HRN_get_general_wire_occ_data (tag_t line_tag, HRN_general_wire_occ_data_t *wire_occ_data) |
| MECHATRONICS_API int | HRN_get_part_occ_data (tag_t bom_line_tag, HRN_part_occ_data_t *part_occ_data) |
| MECHATRONICS_API int | HRN_get_protection_area_data (tag_t wire_protect_line_tag, HRN_protection_area_data_t *protect_area_data) |
| MECHATRONICS_API int | HRN_get_wire_color (tag_t object_tag, const char *color_type, char **color_value) |
| MECHATRONICS_API int | HRN_get_wire_length_information (tag_t bom_line, const char *length_type, double *length_value) |
| MECHATRONICS_API int | HRN_get_wire_protect_occ_data (tag_t bom_line_tag, HRN_wire_protect_occ_data_t *wire_protect_occ_data) |
| MECHATRONICS_API int | HRN_remove_cavity_data (tag_t cavity_line_tag) |
| MECHATRONICS_API int | HRN_remove_connector_occ_data (tag_t bom_line_tag) |
| MECHATRONICS_API int | HRN_remove_fixing_assignment_data (tag_t fixing_line_tag) |
| MECHATRONICS_API int | HRN_remove_general_wire_occ_data (tag_t line_tag) |
| MECHATRONICS_API int | HRN_remove_part_occ_data (tag_t bom_line_tag) |
| MECHATRONICS_API int | HRN_remove_protection_area_data (tag_t wire_protect_line_tag) |
| MECHATRONICS_API int | HRN_remove_wire_color (tag_t object_tag, const char *color_type) |
| MECHATRONICS_API int | HRN_remove_wire_length_information (tag_t bom_line, const char *length_type) |
| MECHATRONICS_API int | HRN_remove_wire_protect_occ_data (tag_t bom_line_tag) |
| MECHATRONICS_API int | HRN_set_associated_part (tag_t cavity_line_tag, tag_t part_line_tag, tag_t *relation_tagptr) |
| MECHATRONICS_API int | HRN_set_cavity_data (tag_t cavity_line_tag, const HRN_cavity_occ_data_t *cavity_occ_data) |
| MECHATRONICS_API int | HRN_set_connector_occ_data (tag_t bom_line_tag, const HRN_connector_occ_data_t *connector_occ_data) |
| MECHATRONICS_API int | HRN_set_fixing_assignment_data (tag_t fixing_line_tag, const HRN_fixing_assignment_data_t *assignment_data) |
| MECHATRONICS_API int | HRN_set_fixing_segment (tag_t bom_line_tag, tag_t segment_tag, tag_t *relation_tagptr) |
| MECHATRONICS_API int | HRN_set_general_wire_occ_data (tag_t line_tag, const HRN_general_wire_occ_data_t *wire_occ_data) |
| MECHATRONICS_API int | HRN_set_part_occ_data (tag_t bom_line_tag, const HRN_part_occ_data_t *part_occ_data) |
| MECHATRONICS_API int | HRN_set_protection_area_data (tag_t wire_protect_line_tag, const HRN_protection_area_data_t *protect_area_data) |
| MECHATRONICS_API int | HRN_set_referenced_component (tag_t node_tag, tag_t reference_comp_tag, tag_t *relation_tagptr) |
| MECHATRONICS_API int | HRN_set_wire_color (tag_t object_tag, const char *color_type, const char *color_value) |
| MECHATRONICS_API int | HRN_set_wire_length_information (tag_t bom_line, const char *length_type, double length_value) |
| MECHATRONICS_API int | HRN_set_wire_protect_occ_data (tag_t bom_line_tag, const HRN_wire_protect_occ_data_t *wire_protect_occ_data) |
| MECHATRONICS_API int | HRN_set_wire_protection_segment (tag_t wirep_line_tag, tag_t segment_tag, tag_t *relation_tagptr) |
| MECHATRONICS_API int | HRN_set_wire_protection_segments (tag_t wire_protection_line_tag, int n_segments, tag_t *segment_tags) |
| MECHATRONICS_API int | HRN_unset_associated_part (tag_t cavity_line_tag, tag_t part_line_tag) |
| MECHATRONICS_API int | HRN_unset_fixing_segment (tag_t bom_line_tag, tag_t segment_tag) |
| MECHATRONICS_API int | HRN_unset_referenced_component (tag_t node_tag, tag_t reference_comp_tag) |
| MECHATRONICS_API int | HRN_unset_wire_protection_segment (tag_t wirep_line_tag, tag_t segment_tag) |
| MECHATRONICS_API int | HRN_unset_wire_protection_segments (tag_t wire_protection_line_tag, int n_segments, tag_t *segment_tags) |
This module defines the required ITK interface for HRN (Harness) related operations.
| typedef struct HRN_cavity_occ_data_s * HRN_cavity_occ_data_p_t |
| typedef struct HRN_cavity_occ_data_s HRN_cavity_occ_data_t |
| typedef struct HRN_connector_occ_data_s * HRN_connector_occ_data_p_t |
| typedef struct HRN_connector_occ_data_s HRN_connector_occ_data_t |
| typedef struct HRN_fixing_assignment_data_s * HRN_fixing_assignment_data_p_t |
| typedef struct HRN_fixing_assignment_data_s HRN_fixing_assignment_data_t |
| typedef struct HRN_general_wire_occ_data_s * HRN_general_wire_occ_data_p_t |
| typedef struct HRN_general_wire_occ_data_s HRN_general_wire_occ_data_t |
| typedef struct HRN_part_occ_data_s * HRN_part_occ_data_p_t |
| typedef struct HRN_part_occ_data_s HRN_part_occ_data_t |
| typedef struct HRN_protection_area_data_s * HRN_protection_area_data_p_t |
| typedef struct HRN_protection_area_data_s HRN_protection_area_data_t |
| typedef struct HRN_wire_color_data_s * HRN_wire_color_data_p_t |
| typedef struct HRN_wire_color_data_s HRN_wire_color_data_t |
| typedef struct HRN_wire_length_data_s * HRN_wire_length_data_p_t |
| typedef struct HRN_wire_length_data_s HRN_wire_length_data_t |
Structures in HRN
The occurrence specific attribute values for bomlines are set and returned using structures. The diferent structure and specific element access for these structures as given below.
Note:
All char* and char** type attributes in the structure are allocated memory for "get" methods of ITK. This memory allocated for all returning values of char* and char** need to be explicitly freed using SM_free.
All structures to be passed as input should be initialized. For initializing any int, double or charecter to a null value, the following can be used:
HRN_INT_NULL - This definition has a value as "-9999". This can be used to initialize an int value in the structure to null.
HRN_DOUBLE_NULL - This definition has a value as "-9999.99". This can be used to initialize a double value in the structure to null.
HRN_STRING_NULL - This definition has a value as "NULL". This can be used to initialize a charecter value in the structure to null.
Certain harness part objects can have occurrence spscific attributes specified on them. These are deifned in the preference HRN_part_data_relation_primary. To access occurrence specific values for any of the bomlines of type or subtype specified in the preference, use structure HRN_part_occ_data_t:
| structure_name.id | Occurrence specific ID. | char *. |
| structure_name.alias_count | Number of alias Ids specified. | int |
| structure_name.alias_ids | Alias Ids specified for the bomline. | char ** |
In addition to the part occurrence data (id, alias_count, alias_ids), the HRN_ConHousing and its subtype have the following ocurrence specific attributes specified using structure HRN_connector_occ_data_t:
| structure_name.usage | Usage defined for the bomline | char * |
In addition to the part occurrence data (id, alias_count, alias_ids), the HRN_WireProtect and its subtype have the following ocurrence specific attributes specified in structure HRN_wire_protect_occ_data_t:
| structure_name.protect_length | protection length value on the bomline | double |
BOMLines of type HRN_Cavity (or subtype) can have the following occurrence specific attributes specified using structure HRN_cavity_occ_data_t:
| structure_name.id | Occurrence specific ID. | char *. |
| structure_name.position_on_wire | Position on wire specified on the line tag | double |
BOMLines of type HRN_GeneralWire, HRN_Core (or subtype) can have the following occurrence specific attributes specified using structure HRN_general_wire_occ_data_t:
| structure_name.wire_number | Wire number for the wire | char * |
| structure_name.multiplier | Multiplier value for the line tag | char * |
| structure_name.offset | Offset specified for the line tag | char * |
| structure_name.seperation_code | Seperation code specified for the line tag | char * |
The Protection area defined on the wire protection type line have the following occurrence specific attributes specified in structure HRN_protection_area_data_t:
| structure_name.end_location | Occurrence specific ID. | double |
| structure_name.start_location | Number of alias Ids specified. | double |
| structure_name.gradient | Alias Ids specified for the bomline. | double |
| structure_name.taping_direction | Alias Ids specified for the bomline. | char * |
The Fixing Assignment defined on the line type of Fixing/Accessory (or their subtypes) have the following fixing assignment attributes specified in structure HRN_fixing_assignment_data_t:
| structure_name.location_value | The location value for the line tag where the segment is specified | double |
| structure_name.orientation_value | The orientation value to be specified on the line tag | double[3] |
Certain harness types and subtypes , as specified in the preference HRN_wire_length_data_relation_primary, can have wire length information (length_type and length_value) specified on them. To retrieve all the wire length information associated to a bomline, use the structure HRN_wire_length_data_t:
| structure_name.length_type | The length type to be specified | char * |
| structure_name.length_value | The length value for the perticular length type on the bomline | double |
The item objects of type HRN_GeneralWire, HRN_Core and their subtypes can have wire color information associated on the item type. To retrieve all wire color information on a perticular item object tag use the structure HRN_wire_color_data_t:
| structure_name.color_type | The color type to be specified | char * |
| structure_name.color_value | The color value for the perticular color type on the object tag | char * |
| typedef struct HRN_wire_protect_occ_data_s * HRN_wire_protect_occ_data_p_t |
| typedef struct HRN_wire_protect_occ_data_s HRN_wire_protect_occ_data_t |
| MECHATRONICS_API int HRN_ask_associated_parts | ( | tag_t | cavity_line_tag, |
| int * | associated_parts_count, | ||
| tag_t ** | associated_part_tags | ||
| ) |
This function will Ask all the associated parts to the cavity line tag
Restrictions:
If the cavity_line_tag specified is not a cavity line, this will throw an error - MECH_invalid_input
| cavity_line_tag | (I) The cavity line tag |
| associated_parts_count | (O) The number of associated parts to the cavity |
| associated_part_tags | (OF) associated_parts_count The tags fot the associated parts |
This function will ask the segment tag that is associated to the fixing or accessory line
Restrictions:
If the bom_line_tag specified is not a fixing/acessory line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
| bom_line_tag | (I) The fixing/accessory line tag |
| segment_tag | (O) The segment tag associated to the bom line tag |
| MECHATRONICS_API int HRN_ask_referenced_component | ( | tag_t | node_tag, |
| tag_t | window_tag, | ||
| int * | reference_comp_count, | ||
| tag_t ** | reference_comp_tags | ||
| ) |
This function will Ask all referenced components associated to the Node object
Restrictions:
If the note_tag is not of node object this will throw an error - MECH_invalid_input Also, the window_tag must be specified
| node_tag | (I) The node tag |
| window_tag | (I) Tag of the window in which the referenced components would be listed |
| reference_comp_count | (O) The referenced components count |
| reference_comp_tags | (OF) reference_comp_count Tag of referenced components |
DEPRECATED FUNCTION
This function will Ask segment that is associated to the wire protection line
Restrictions:
If the wirep_line_tag specified is not a wire protection line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
| wirep_line_tag | (I) The wire protection line tag |
| segment_tag | (O) The segment tag that is asssociated to the wire protection line |
| MECHATRONICS_API int HRN_ask_wire_protection_segments | ( | tag_t | wire_protection_line_tag, |
| int * | n_segments, | ||
| tag_t ** | segment_tags | ||
| ) |
This function will ask segments that are associated to the wire protection line
Restrictions:
If the wire_protection_line_tag specified is not a wire protection line, or if any of the segment_tags are not of segment objects this will throw an error - MECH_invalid_input
| MECHATRONICS_API int HRN_get_all_wire_color | ( | tag_t | object_tag, |
| int * | count, | ||
| HRN_wire_color_data_t ** | wire_color_data | ||
| ) |
This function will get wire color information associated to the object_tag.
Restrictions:
The object_tag has to be an item tag of type HRN_GeneralWire/ HRN_Code or subtype of these item types. If the object_tag specified cannot have a color information attached, this will throw an error - MECH_invalid_input
| object_tag | (I) |
| count | (O) |
| wire_color_data | (OF) Count number of color_type and color_value information |
| MECHATRONICS_API int HRN_get_all_wire_length_information | ( | tag_t | bom_line, |
| int * | count, | ||
| HRN_wire_length_data_t ** | length_data | ||
| ) |
This function will get all wire length information attached to the given bomline
Restrictions:
If the bom_line specified cannot have a wire length information attached, this will throw an error - MECH_invalid_input
| bom_line | (I) The bom line from which wire length information has to be obtained |
| count | (O) Number of wire length objects found |
| length_data | (OF) Count list of lenth type and length value |
| MECHATRONICS_API int HRN_get_cavity_data | ( | tag_t | cavity_line_tag, |
| HRN_cavity_occ_data_t * | cavity_occ_data | ||
| ) |
This function will get cavity instance data to the cavity line tag
Restrictions:
If the cavity_line_tag specified cannot have a cavity instance data attached, this will throw an error - MECH_invalid_input
| cavity_line_tag | (I) |
| cavity_occ_data | (O) List having values for cavity occurrence data |
| MECHATRONICS_API int HRN_get_connector_occ_data | ( | tag_t | bom_line_tag, |
| HRN_connector_occ_data_t * | connector_occ_data | ||
| ) |
This function will get connector housing occurrence to the bom line tag
Restrictions:
If the bom_line_tag specified cannot have a connector housing occurrence data attached, this will throw an error - MECH_invalid_input
| bom_line_tag | (I) |
| connector_occ_data | (O) List having values for connector occurrence data |
| MECHATRONICS_API int HRN_get_fixing_assignment_data | ( | tag_t | fixing_line_tag, |
| HRN_fixing_assignment_data_t * | assignment_data | ||
| ) |
This function will get fixing assignment information to the fixing/accessory line tag
Restrictions:
If the fixing_line_tag specified cannot have a fixing assignment information attached, this will throw an error - MECH_invalid_input
| fixing_line_tag | (I) |
| assignment_data | (O) List having values for location_value and orientation_value |
| MECHATRONICS_API int HRN_get_general_wire_occ_data | ( | tag_t | line_tag, |
| HRN_general_wire_occ_data_t * | wire_occ_data | ||
| ) |
This function will get general wire/core occurrence data to the line_tag Restrictions:
If the line_tag specified cannot have a wire number data attached, this will throw an error - MECH_invalid_input
| line_tag | (I) |
| wire_occ_data | (O) List having values for general wire/core occurrence data |
| MECHATRONICS_API int HRN_get_part_occ_data | ( | tag_t | bom_line_tag, |
| HRN_part_occ_data_t * | part_occ_data | ||
| ) |
This function will get part occurrence information to the bom line tag
Restrictions:
If the bom_line_tag specified does not have a part occurrence data attached, this will throw an error - HRN_no_association
| bom_line_tag | (I) |
| part_occ_data | (O) List having values for part occurrence data |
| MECHATRONICS_API int HRN_get_protection_area_data | ( | tag_t | wire_protect_line_tag, |
| HRN_protection_area_data_t * | protect_area_data | ||
| ) |
This function will ask protection area information to the wire protection line tag
Restrictions:
if the wire_protect_ling_tag is not a wire protection bom line tag this will throw error - MECH_invalid_input
| wire_protect_line_tag | (I) |
| protect_area_data | (O) List having values for protection area |
| MECHATRONICS_API int HRN_get_wire_color | ( | tag_t | object_tag, |
| const char * | color_type, | ||
| char ** | color_value | ||
| ) |
This function will get wire color information to the object_tag
Restrictions:
The object_tag has to be an item tag of type HRN_GeneralWire/ HRN_Code or subtype of these item types. If the object_tag specified cannot have a color information attached, this will throw an error - MECH_invalid_input
| object_tag | (I) |
| color_type | (I) |
| color_value | (OF) Pointer to char * to return the color value |
| MECHATRONICS_API int HRN_get_wire_length_information | ( | tag_t | bom_line, |
| const char * | length_type, | ||
| double * | length_value | ||
| ) |
This function will get the length value of given length type attached to the bomline
Restrictions:
If the bom_line specified cannot have a wire length information attached, this will throw an error - MECH_invalid_input
| bom_line | (I) The bom line from which wire length information has to be obtained |
| length_type | (I) The length type required |
| length_value | (O) The length value |
| MECHATRONICS_API int HRN_get_wire_protect_occ_data | ( | tag_t | bom_line_tag, |
| HRN_wire_protect_occ_data_t * | wire_protect_occ_data | ||
| ) |
This function will get wire protection instance data to the bom_line_tag Restrictions:
If the bom_line_tag specified cannot have a wire protection instance data attached, this will throw an error - MECH_invalid_input
| bom_line_tag | (I) |
| wire_protect_occ_data | (O) List having values for wire protection occurrence data |
| MECHATRONICS_API int HRN_remove_cavity_data | ( | tag_t | cavity_line_tag | ) |
This function will remove cavity instance data to the cavity line tag
Restrictions:
If the cavity_line_tag specified cannot have a cavity instance data attached, this will throw an error - MECH_invalid_input
If cavity instance data does not exists for this bom_line_tag, this will throw an error - HRN_no_association
| cavity_line_tag | (I) |
| MECHATRONICS_API int HRN_remove_connector_occ_data | ( | tag_t | bom_line_tag | ) |
This function will remove connector housing occurrence to the bom line tag
Restrictions:
If the bom_line_tag specified cannot have a connector housing occurrence data attached, this will throw an error - MECH_invalid_input
If connector housing occurrence data does not exists for this bom_line_tag, this will throw an error - HRN_no_association
| bom_line_tag | (I) |
| MECHATRONICS_API int HRN_remove_fixing_assignment_data | ( | tag_t | fixing_line_tag | ) |
This function will remove fixing assignment information to the fixing/accessory line tag
Restrictions:
If the fixing_line_tag specified cannot have a fixing assignment information attached, this will throw an error - MECH_invalid_input
If no fixing assignment information exists for this fixing_line_tag, this will throw an error - HRN_no_association
| fixing_line_tag | (I) |
| MECHATRONICS_API int HRN_remove_general_wire_occ_data | ( | tag_t | line_tag | ) |
This function will remove general wire/core occurrence data to the line_tag Restrictions:
If the line_tag specified cannot have a general wire/core occurrence data attached, this will throw an error - MECH_invalid_input
| line_tag | (I) |
| MECHATRONICS_API int HRN_remove_part_occ_data | ( | tag_t | bom_line_tag | ) |
This function will remove part occurrence information to the bom line tag
Restrictions:
If the bom_line_tag specified does not have a part occurrence data attached, this will throw an error - HRN_no_association
If part occurrence data does not exists for this part occurrence data, this will throw an error - HRN_no_association
| bom_line_tag | (I) |
| MECHATRONICS_API int HRN_remove_protection_area_data | ( | tag_t | wire_protect_line_tag | ) |
This function will remove protection area information to the wire protection line tag
Restrictions:
If the wire_protect_ling_tag is not a wire protection bom line tag this will throw error - MECH_invalid_input
If the wire_protect_line_tag specified does not have wire protection information attached, this will throw an error - MECH_invalid_input
| wire_protect_line_tag | (I) |
| MECHATRONICS_API int HRN_remove_wire_color | ( | tag_t | object_tag, |
| const char * | color_type | ||
| ) |
This function will remove wire color information to the object_tag
Restrictions:
The object_tag has to be an item tag of type HRN_GeneralWire/ HRN_Code or subtype of these item types.
If the object_tag specified cannot have a color information attached(not a HRN_GeneralWire/HRN_Core or subtype of these two types), this will throw an error - MECH_invalid_input
If color information with color_type does not exists for this object_tag, this will throw an error - HRN_no_association
| object_tag | (I) |
| color_type | (I) |
| MECHATRONICS_API int HRN_remove_wire_length_information | ( | tag_t | bom_line, |
| const char * | length_type | ||
| ) |
This function will delete wire length information to the given bomline
Restrictions:
If the bom_line specified cannot have a wire length information attached, this will throw an error - MECH_invalid_input
If no wire length information with the specified length_type exists for this bom_line, this will throw an error - HRN_no_association
| bom_line | (I) The bom line from which wire length information has to be removed |
| length_type | (I) The length type to be removed |
| MECHATRONICS_API int HRN_remove_wire_protect_occ_data | ( | tag_t | bom_line_tag | ) |
This function will remove wire protection instance data to the bom_line_tag Restrictions:
If the bom_line_tag specified cannot have a wire protection instance data attached, this will throw an error - MECH_invalid_input
If wire protection instance data does not exists for this bom_line_tag, this will throw an error - HRN_no_association
| bom_line_tag | (I) |
| MECHATRONICS_API int HRN_set_associated_part | ( | tag_t | cavity_line_tag, |
| tag_t | part_line_tag, | ||
| tag_t * | relation_tagptr | ||
| ) |
This function will Set the part line tag as associated part to the cavity line tag
Restrictions:
If the cavity_line_tag specified is not a cavity line, this will throw an error - MECH_invalid_input Also, if the part_line_tag is not of the object type (or subtype of the object type) as specified in the preference, this will throw error MECH_invalid_input
| cavity_line_tag | (I) The cavity line tag |
| part_line_tag | (I) The part line tag to be associated to the cavity |
| relation_tagptr | (O) The relation tag returned by the association |
| MECHATRONICS_API int HRN_set_cavity_data | ( | tag_t | cavity_line_tag, |
| const HRN_cavity_occ_data_t * | cavity_occ_data | ||
| ) |
This function will add cavity instance data to the cavity line tag
Restrictions:
If the cavity_line_tag specified cannot have a cavity instance data attached, this will throw an error - MECH_invalid_input
| cavity_line_tag | (I) |
| cavity_occ_data | (I) List having values for cavity occurrence data |
| MECHATRONICS_API int HRN_set_connector_occ_data | ( | tag_t | bom_line_tag, |
| const HRN_connector_occ_data_t * | connector_occ_data | ||
| ) |
This function will add connector housing occurrence to the bom line tag
Restrictions:
If the bom_line_tag specified cannot have a connector housing occurrence data attached, this will throw an error - MECH_invalid_input
| bom_line_tag | (I) |
| connector_occ_data | (I) List having values for connector occurrence data |
| MECHATRONICS_API int HRN_set_fixing_assignment_data | ( | tag_t | fixing_line_tag, |
| const HRN_fixing_assignment_data_t * | assignment_data | ||
| ) |
This function will add fixing assignment information to the fixing/accessory line tag
Restrictions:
If the fixing_line_tag specified cannot have a fixing assignment information attached, this will throw an error - MECH_invalid_input
| fixing_line_tag | (I) |
| assignment_data | (I) List having values for location_value and orientation_value |
| MECHATRONICS_API int HRN_set_fixing_segment | ( | tag_t | bom_line_tag, |
| tag_t | segment_tag, | ||
| tag_t * | relation_tagptr | ||
| ) |
This function will Set segment object to the fixing or accessory line
Restrictions:
If the bom_line_tag specified is not a fixing/acessory line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
If a segment is already associated to the bom_line_tag, this will throw error - HRN_duplicate_association
| bom_line_tag | (I) The fixing/accessory line tag |
| segment_tag | (I) The segment tag to be associated to the bom line tag |
| relation_tagptr | (O) The relation tag associating the bom line with the segment |
| MECHATRONICS_API int HRN_set_general_wire_occ_data | ( | tag_t | line_tag, |
| const HRN_general_wire_occ_data_t * | wire_occ_data | ||
| ) |
This function will add general wire/core occurrence data to the line_tag Restrictions:
If the line_tag specified cannot have a general wire/core occurrence data attached, this will throw an error - MECH_invalid_input
| line_tag | (I) |
| wire_occ_data | (I) |
| MECHATRONICS_API int HRN_set_part_occ_data | ( | tag_t | bom_line_tag, |
| const HRN_part_occ_data_t * | part_occ_data | ||
| ) |
This function will add part occurrence information to the bom line tag
Restrictions:
If the bom_line_tag specified cannot have a part occurrence data attached, this will throw an error - MECH_invalid_input
| bom_line_tag | (I) |
| part_occ_data | (I) List having values for part occurrence data |
| MECHATRONICS_API int HRN_set_protection_area_data | ( | tag_t | wire_protect_line_tag, |
| const HRN_protection_area_data_t * | protect_area_data | ||
| ) |
This function will add protection area information to the wire protection line tag
Restrictions:
If the wire_protect_line_tag specified cannot have a wire protection information attached, this will throw an error - MECH_invalid_input
| wire_protect_line_tag | (I) |
| protect_area_data | (I) List having values for protection area |
| MECHATRONICS_API int HRN_set_referenced_component | ( | tag_t | node_tag, |
| tag_t | reference_comp_tag, | ||
| tag_t * | relation_tagptr | ||
| ) |
This function will Set bomline as referenced component to the Node object
Restrictions:
If the note_tag is not of node object, or if the referenced component tag is not of the object type (or subtype of the object type) as apecified in preference, this will throw an error - MECH_invalid_input
| node_tag | (I) The node tag |
| reference_comp_tag | (I) The bom line tag to be added as referenced component |
| relation_tagptr | (O) The relation tag that associates the node to reference component |
| MECHATRONICS_API int HRN_set_wire_color | ( | tag_t | object_tag, |
| const char * | color_type, | ||
| const char * | color_value | ||
| ) |
This function will add wire color information to the object_tag
Restrictions:
The object_tag has to be an item tag of type HRN_GeneralWire/ HRN_Code or subtype of these item types. If the object_tag specified cannot have a color information attached, this will throw an error - MECH_invalid_input
If the color_type specified already exists for this bom_line, it will be updated with the new color_value sent
| object_tag | (I) |
| color_type | (I) |
| color_value | (I) |
| MECHATRONICS_API int HRN_set_wire_length_information | ( | tag_t | bom_line, |
| const char * | length_type, | ||
| double | length_value | ||
| ) |
This function will add wire length information to the given bomline
Restrictions:
If the bom_line specified cannot have a wire length information attached, this will throw an error - MECH_invalid_input
If the length_type specified already exists for this bom_line, it will be updated with the new length_value sent
| bom_line | (I) The bom line for which the wire length information has to be added |
| length_type | (I) The length type |
| length_value | (I) The length value |
| MECHATRONICS_API int HRN_set_wire_protect_occ_data | ( | tag_t | bom_line_tag, |
| const HRN_wire_protect_occ_data_t * | wire_protect_occ_data | ||
| ) |
This function will add wire protection instance data to the bom_line_tag Restrictions:
If the bom_line_tag specified cannot have a wire protection instance data attached, this will throw an error - MECH_invalid_input
| bom_line_tag | (I) |
| wire_protect_occ_data | (I) List having values for wire protection occurrence data |
| MECHATRONICS_API int HRN_set_wire_protection_segment | ( | tag_t | wirep_line_tag, |
| tag_t | segment_tag, | ||
| tag_t * | relation_tagptr | ||
| ) |
DEPRECATED FUNCTION
This function will Set segment object to the wire protection line
Restrictions:
If the wirep_line_tag specified is not a wire protection line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
If a segment is already associated to the bom_line_tag, this will throw error - HRN_duplicate_association
| wirep_line_tag | (I) The wire protection line tag |
| segment_tag | (I) The segment tag to be associated to the wire protection line |
| relation_tagptr | (O) The relation tag that relates the segment and wire protection line |
| MECHATRONICS_API int HRN_set_wire_protection_segments | ( | tag_t | wire_protection_line_tag, |
| int | n_segments, | ||
| tag_t * | segment_tags | ||
| ) |
This function will set multiple segment objects to the wire protection line
Restrictions:
If the wire_protection_line_tag specified is not a wire protection line, or if any of the segment_tags are not of segment objects, this will throw an error - MECH_invalid_input
This function will Unset the part line tag from the cavity line tag
Restrictions:
If the cavity_line_tag specified is not a cavity line, this will throw an error - MECH_invalid_input Also, if the part_line_tag is not of the object type(or subtype of the object type) as specified in the preference, this will throw error MECH_invalid_input
If there is no association between the cavity_line_tag and part_line_tag, this will throw error
| cavity_line_tag | (I) The cavity line tag |
| part_line_tag | (I) The part line tag to be un-associated to the cavity |
This function will Unset segment object that is associated to the fixing or accessory line
Restrictions:
If the bom_line_tag specified is not a fixing/acessory line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
If the segment_tag is not associated to bom_line_tag, this will throw error
| bom_line_tag | (I) The fixing/accessory line tag |
| segment_tag | (I) The segment tag to be un-associated to the bom line tag |
This function will Unset bomline as referenced component to the Node object
Restrictions:
If the note_tag is not of node object, or if the referenced component tag is not of the object type as apecified in preference, this will throw an error - MECH_invalid_input if no association is made between node_tag and reference_copm_tag, an error will be thrown
| node_tag | (I) The node tag |
| reference_comp_tag | (I) The bom line tag to be removed from referenced component association |
DEPRECATED FUNCTION
This function will Unset segment object that is associated to the wire protection line
Restrictions:
If the wirep_line_tag specified is not a wire protection line, or if the segment_tag is not of segment object this will throw an error - MECH_invalid_input
If the segment_tag is not associated to bom_line_tag, this will throw error
| wirep_line_tag | (I) The wire protection line tag |
| segment_tag | (I) The segment tag to be un-associated to the wire protection line |
| MECHATRONICS_API int HRN_unset_wire_protection_segments | ( | tag_t | wire_protection_line_tag, |
| int | n_segments, | ||
| tag_t * | segment_tags | ||
| ) |
This function will Unset multiple segment objects that are associated to the wire protection line
Restrictions: If the wire_protection_line_tag specified is not a wire protection line, or if any of the segment_tags are not segment objects this will throw an error - MECH_invalid_input
If the segment_tags are not associated to bom_line_tag, this will throw error