|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
Functions | |
| MECHATRONICS_API int | ROUTE_add_node (tag_t route, tag_t node, int position) |
| MECHATRONICS_API int | ROUTE_add_segment (tag_t route, tag_t segment, int position) |
| MECHATRONICS_API int | ROUTE_ask_assigned_locations (tag_t associating_object, tag_t window_tag, int *location_count, tag_t **assigned_location_lines) |
| MECHATRONICS_API int | ROUTE_ask_associated_bom_lines (tag_t route, tag_t window, int *count, tag_t **bom_lines) |
| MECHATRONICS_API int | ROUTE_ask_associated_route (tag_t bom_line, tag_t *route) |
| MECHATRONICS_API int | ROUTE_ask_center_curve (tag_t route, tag_t *center_curve) |
| MECHATRONICS_API int | ROUTE_ask_center_curve_data (tag_t center_curve, int *degree, int *dimension, logical *is_rational, logical *is_uniform, double *start_parameter, double *end_parameter, int *num_control_points, double ***control_points, int *num_knots, double **knots, int **multiplicities) |
| MECHATRONICS_API int | ROUTE_ask_center_curve_name (tag_t center_curve, char **name) |
| MECHATRONICS_API int | ROUTE_ask_center_curve_routes (tag_t center_curve, int *count, tag_t **routes) |
| MECHATRONICS_API int | ROUTE_ask_center_curve_segments (tag_t center_curve, int *count, tag_t **segments) |
| MECHATRONICS_API int | ROUTE_ask_length (tag_t route, double *real_length, double *represented_length) |
| MECHATRONICS_API int | ROUTE_ask_node_name (tag_t node, char **name) |
| MECHATRONICS_API int | ROUTE_ask_node_position (tag_t node, double *x, double *y, double *z) |
| MECHATRONICS_API int | ROUTE_ask_node_routes (tag_t node, int *count, tag_t **routes) |
| MECHATRONICS_API int | ROUTE_ask_node_segments (tag_t node, int *count, tag_t **segments) |
| MECHATRONICS_API int | ROUTE_ask_segment_center_curve (tag_t segment, tag_t *center_curve) |
| MECHATRONICS_API int | ROUTE_ask_segment_cross_section (tag_t segment, double *area) |
| MECHATRONICS_API int | ROUTE_ask_segment_end (tag_t segment, tag_t *end_node) |
| MECHATRONICS_API int | ROUTE_ask_segment_length (tag_t segment, double *real_length, double *represented_length) |
| MECHATRONICS_API int | ROUTE_ask_segment_name (tag_t segment, char **name) |
| MECHATRONICS_API int | ROUTE_ask_segment_routes (tag_t segment, int *count, tag_t **routes) |
| MECHATRONICS_API int | ROUTE_ask_segment_start (tag_t segment, tag_t *start_node) |
| MECHATRONICS_API int | ROUTE_associate (tag_t bom_line, tag_t route) |
| MECHATRONICS_API int | ROUTE_create (const char *name, const char *description, tag_t bvr, tag_t *route) |
| MECHATRONICS_API int | ROUTE_create_center_curve (const char *name, tag_t bvr, tag_t *center_curve) |
| MECHATRONICS_API int | ROUTE_create_location (const char *location_id, const char *location_name, const char *location_type, const char *location_rev_id, tag_t *new_location, tag_t *new_location_rev) |
| MECHATRONICS_API int | ROUTE_create_location_with_forms (const char *location_id, const char *location_name, const char *location_type, const char *location_rev_id, tag_t routeLocMaster, tag_t routeLocRevMaster, tag_t *new_location, tag_t *new_location_rev) |
| MECHATRONICS_API int | ROUTE_create_node (const char *name, tag_t bvr, tag_t *node) |
| MECHATRONICS_API int | ROUTE_create_segment (const char *name, tag_t bvr, tag_t *segment) |
| MECHATRONICS_API int | ROUTE_delete_route_data (tag_t bvr) |
| MECHATRONICS_API int | ROUTE_display_ask_props (tag_t route_display, ROUTE_display_font_t *font, double *width, double color[3]) |
| MECHATRONICS_API int | ROUTE_display_set_props (tag_t route_tag, ROUTE_display_font_t font, double width, const double color[3]) |
| MECHATRONICS_API int | ROUTE_list_nodes (tag_t route, int *num, tag_t **nodes) |
| MECHATRONICS_API int | ROUTE_list_segments (tag_t route, int *num, tag_t **segments) |
| MECHATRONICS_API int | ROUTE_location_ask_defining_item (tag_t location_line, tag_t *defining_item_line) |
| MECHATRONICS_API int | ROUTE_location_find_assigned_objects (tag_t location_line, int *objects_count, tag_t **assigned_objects) |
| MECHATRONICS_API int | ROUTE_location_set_defining_item (tag_t location_line, tag_t defining_item_line, tag_t *relation_tag) |
| MECHATRONICS_API int | ROUTE_location_unset_defining_item (tag_t location_line) |
| MECHATRONICS_API int | ROUTE_remove_node (tag_t route, tag_t node) |
| MECHATRONICS_API int | ROUTE_remove_segment (tag_t route, tag_t segment) |
| MECHATRONICS_API int | ROUTE_set_assigned_location (tag_t primary_object, tag_t location_line, tag_t *relation_tag) |
| MECHATRONICS_API int | ROUTE_set_center_curve (tag_t route, tag_t center_curve) |
| MECHATRONICS_API int | ROUTE_set_center_curve_data (tag_t center_curve, int degree, int dimension, logical is_rational, logical is_uniform, double start_parameter, double end_parameter, int num_control_points, double **control_points, int num_knots, double *knots, int *multiplicities) |
| MECHATRONICS_API int | ROUTE_set_node_position (tag_t node, double x, double y, double z) |
| MECHATRONICS_API int | ROUTE_set_real_length (tag_t route, double length) |
| MECHATRONICS_API int | ROUTE_set_represented_length (tag_t route, double length) |
| MECHATRONICS_API int | ROUTE_set_segment_center_curve (tag_t segment, tag_t center_curve) |
| MECHATRONICS_API int | ROUTE_set_segment_cross_section (tag_t segment, double area) |
| MECHATRONICS_API int | ROUTE_set_segment_end (tag_t segment, tag_t end_node) |
| MECHATRONICS_API int | ROUTE_set_segment_real_length (tag_t segment, double length) |
| MECHATRONICS_API int | ROUTE_set_segment_represented_length (tag_t segment, double length) |
| MECHATRONICS_API int | ROUTE_set_segment_start (tag_t segment, tag_t start_node) |
| MECHATRONICS_API int | ROUTE_unassociate (tag_t bom_line, tag_t route) |
| MECHATRONICS_API int | ROUTE_unset_assigned_location (tag_t primary_object, tag_t location_line) |
Defines Route Relations | |
| #define | ROUTED_BY "TC_Routed_By" |
| #define | DEVICE_TO_CONNECTOR "TC_Device_To_Connector" |
Route display font types | |
| enum | ROUTE_display_font_e { ROUTE_display_font_solid = 0, ROUTE_display_font_dashed, ROUTE_display_font_dotted } |
| typedef enum ROUTE_display_font_e | ROUTE_display_font_t |
This module defines the ITK interface for route related operations.
| typedef enum ROUTE_display_font_e ROUTE_display_font_t |
| enum ROUTE_display_font_e |
This function adds a node to a given route at a given position. Valid position values are from 1..n. A value of -1 for position will add the node at the end.
| route | (I) Tag of the route object |
| node | (I) Tag of the node |
| position | (I) Position where the node should be inserted. Valid values are 1..n |
Add a segment to a route at the specified position. Valid position values are from 0..n. A value of -1 for position will add the segment at the end.
| route | (I) Tag of the route object |
| segment | (I) Tag of the segment |
| position | (I) Position where the segment should be inserted. Valid values are 1..n |
| MECHATRONICS_API int ROUTE_ask_assigned_locations | ( | tag_t | associating_object, |
| tag_t | window_tag, | ||
| int * | location_count, | ||
| tag_t ** | assigned_location_lines | ||
| ) |
This function will return the locations which are associated with a bomline or ROUTE object.
| window_tag | (I) Tag of bomline or ROUTE object. |
| location_count | (I) Tag of window, if the associating object is not bomline then window tag is mandatory else it can be NULLTAG |
| assigned_location_lines | (O) Count of location lines. (OF) Tag list of Location lines. |
| MECHATRONICS_API int ROUTE_ask_associated_bom_lines | ( | tag_t | route, |
| tag_t | window, | ||
| int * | count, | ||
| tag_t ** | bom_lines | ||
| ) |
This function returns all bom_lines associated with a route.
| route | (I) Tag of the route |
| window | (I) Tag of the window |
| count | (O) Number of bom lines |
| bom_lines | (OF) Array of bom line tags |
This function returns the route associated with a bom_line.
| bom_line | (I) BOM Line corresponding to a connection/device instance |
| route | (O) Tag of the route |
This function returns the center curve of a route.
| route | (I) Tag of the route object |
| center_curve | (O) Tag of the center curve |
| MECHATRONICS_API int ROUTE_ask_center_curve_data | ( | tag_t | center_curve, |
| int * | degree, | ||
| int * | dimension, | ||
| logical * | is_rational, | ||
| logical * | is_uniform, | ||
| double * | start_parameter, | ||
| double * | end_parameter, | ||
| int * | num_control_points, | ||
| double *** | control_points, | ||
| int * | num_knots, | ||
| double ** | knots, | ||
| int ** | multiplicities | ||
| ) |
Ask the geometric parameters of the curve
| center_curve | (I) Tag of the center curve |
| degree | (O) Degree of the curve |
| dimension | (O) Dimension of the curve |
| is_rational | (O) Flag indicating whether this curve is a rational curve |
| is_uniform | (O) Flag indicating whether this curve is a uniform curve |
| start_parameter | (O) Start interval of the curve between 0.0 and 1.0 |
| end_parameter | (O) End interval of the curve between 0.0 and 1.0 |
| num_control_points | (O) Number of control points |
| control_points | (OF) Array of control points |
| num_knots | (O) Number of knots |
| knots | (OF) Array of knots |
| multiplicities | (OF) Array of knot multiplicities |
| MECHATRONICS_API int ROUTE_ask_center_curve_name | ( | tag_t | center_curve, |
| char ** | name | ||
| ) |
Ask the name of center curve object.
| center_curve | (I) Tag of the center_curve |
| name | (OF) Name of the center curve |
| MECHATRONICS_API int ROUTE_ask_center_curve_routes | ( | tag_t | center_curve, |
| int * | count, | ||
| tag_t ** | routes | ||
| ) |
This function returns the segments referencing a given route.
| center_curve | (I) Tag of the center_curve |
| count | (O) Number of segments |
| routes | (OF) Array of route tags |
| MECHATRONICS_API int ROUTE_ask_center_curve_segments | ( | tag_t | center_curve, |
| int * | count, | ||
| tag_t ** | segments | ||
| ) |
This function returns the segments referencing a given center curve.
| center_curve | (I) Tag of the center_curve |
| count | (O) Number of segments |
| segments | (OF) Array of segment tags |
| MECHATRONICS_API int ROUTE_ask_length | ( | tag_t | route, |
| double * | real_length, | ||
| double * | represented_length | ||
| ) |
This function returns the real length and the represented length of a route.
| route | (I) Tag of the route object |
| real_length | (O) Real length |
| represented_length | (O) Represented length |
| MECHATRONICS_API int ROUTE_ask_node_name | ( | tag_t | node, |
| char ** | name | ||
| ) |
This function returns the name of the given node.
| node | (I) Tag of the node object |
| name | (OF) Name of the node object |
| MECHATRONICS_API int ROUTE_ask_node_position | ( | tag_t | node, |
| double * | x, | ||
| double * | y, | ||
| double * | z | ||
| ) |
This function returns the X, Y, Z, position for a given node.
| node | (I) Tag of the node |
| x | (O) X value |
| y | (O) Y value |
| z | (O) Z value |
This function returns routes referencing a given node.
| node | (I) Tag of the node |
| count | (O) Number of routes |
| routes | (OF) Array of route tags |
This function returns segments referencing a given node.
| node | (I) Tag of the node |
| count | (O) Number of segments |
| segments | (OF) Tag of the segments |
This function returns the center curve for a given segment.
| segment | (I) Tag of the segment |
| center_curve | (O) Tag of the center curve |
| MECHATRONICS_API int ROUTE_ask_segment_cross_section | ( | tag_t | segment, |
| double * | area | ||
| ) |
This function gives the cross sectional area of a given segment.
| segment | (I) Tag of the segment object |
| area | (O) Cross Sectional Area of the segment |
This function can be used to query the end node of a segment.
| segment | (I) Tag of the segment |
| end_node | (O) Tag of the end node |
| MECHATRONICS_API int ROUTE_ask_segment_length | ( | tag_t | segment, |
| double * | real_length, | ||
| double * | represented_length | ||
| ) |
This function gives the real length and the represented length of a segment.
| segment | (I) Tag of the route object |
| real_length | (O) Real length of the segment |
| represented_length | (O) Represented length of the segment |
| MECHATRONICS_API int ROUTE_ask_segment_name | ( | tag_t | segment, |
| char ** | name | ||
| ) |
This function returns the name of the given segment.
| segment | (I) Tag of the segment object |
| name | (OF) Name of the segment object |
This function returns the route objects referencing this segment.
| segment | (I) Tag of the segment |
| count | (O) Number of route objects returned |
| routes | (OF) Array of the route tags |
This function can be used to query the start node of a segment.
| segment | (I) Tag of the segment |
| start_node | (O) Tag of the start node |
This function associates a connection/device instance (BOMLine) with a route.
| bom_line | (I) BOM Line corresponding to a connection/device instance |
| route | (I) Tag of the route to associate |
| MECHATRONICS_API int ROUTE_create | ( | const char * | name, |
| const char * | description, | ||
| tag_t | bvr, | ||
| tag_t * | route | ||
| ) |
Create a Route object.
| name | (I) Name of the route object |
| description | (I) Description of the route object |
| bvr | (I) Tag of the BVR, which specifies the structure context for this object |
| route | (O) Tag of the route object created by this function call |
| MECHATRONICS_API int ROUTE_create_center_curve | ( | const char * | name, |
| tag_t | bvr, | ||
| tag_t * | center_curve | ||
| ) |
This function creates a new center curve.
| name | (I) Name of the curve |
| bvr | (I) Tag of the BVR, which specifies the structure context for this object |
| center_curve | (O) Tag of the center_curve |
| MECHATRONICS_API int ROUTE_create_location | ( | const char * | location_id, |
| const char * | location_name, | ||
| const char * | location_type, | ||
| const char * | location_rev_id, | ||
| tag_t * | new_location, | ||
| tag_t * | new_location_rev | ||
| ) |
This function will create a new, standalone Location object with the given ID and name. The tag of the location and location revision object is returned.
| location_name | (I) Location identification number. No two Locations can have the same identification string. A null is allowed. If null, the system will automatically generate a Location ID. |
| location_type | (I) Location name. A common name or short description of the Location. |
| location_rev_id | (I) It can be used to specify a defined Location type. A null is allowed for this argument. |
| new_location | (I) Identification string (revision ID) of the Location Revision being created. A null is allowed. If null, the system will automatically generate a revision ID. |
| new_location_rev | (O) Tag for identifying the newly created Location object. (O) Tag for identifying the newly created Location Revision object. |
| MECHATRONICS_API int ROUTE_create_location_with_forms | ( | const char * | location_id, |
| const char * | location_name, | ||
| const char * | location_type, | ||
| const char * | location_rev_id, | ||
| tag_t | routeLocMaster, | ||
| tag_t | routeLocRevMaster, | ||
| tag_t * | new_location, | ||
| tag_t * | new_location_rev | ||
| ) |
This function will create a new, standalone Location object with the given ID, name, master form, rev master form. The tag of the location and location revision object is returned.
| location_name | (I) Location identification number. No two Locations can have the same identification string. A null is allowed. If null, the system will automatically generate a Location ID. |
| location_type | (I) Location name. A common name or short description of the Location. |
| location_rev_id | (I) It can be used to specify a defined Location type. A null is allowed for this argument. |
| routeLocMaster | (I) Identification string (revision ID) of the Location Revision being created. A null is allowed. If null, the system will automatically generate a revision ID. |
| routeLocRevMaster | (I) Tag for route location master form |
| new_location | (I) Tag for route location revision master form |
| new_location_rev | (O) Tag for identifying the newly created Location object. (O) Tag for identifying the newly created Location Revision object. |
This function creates a new node.
| name | (I) Name of the node to be created |
| bvr | (I) Tag of the bvr, which specifies the structure context for this object |
| node | (O) Tag of the node object created by this function call |
This function creates a new segment.
| name | (I) Name of the segment object |
| bvr | (I) Tag of the BVR, which specifies the structure context for this object |
| segment | (O) Tag of the segment object created by this function call |
| MECHATRONICS_API int ROUTE_delete_route_data | ( | tag_t | bvr | ) |
This function will delete route data created in the context of a given BOMViewRevision.
| bvr | (I) Tag of BVR |
| MECHATRONICS_API int ROUTE_display_ask_props | ( | tag_t | route_display, |
| ROUTE_display_font_t * | font, | ||
| double * | width, | ||
| double | color[3] | ||
| ) |
This function returns the display properties associated with a route.
| route_display | (I) Tag of the route |
| font | (O) font |
| width | (O) width |
| color | (O) RGB colors |
| MECHATRONICS_API int ROUTE_display_set_props | ( | tag_t | route_tag, |
| ROUTE_display_font_t | font, | ||
| double | width, | ||
| const double | color[3] | ||
| ) |
This function sets the display properties associated with a route.
| route_tag | (I) Tag of the route |
| font | (I) font |
| width | (I) width |
| color | (I) RGB colors |
This function lists the nodes associated with the route.
| route | (I) Tag of the route object |
| num | (O) node count |
| nodes | (OF) Array of node tags |
This function lists the segments associated with a route.
| route | (I) Tag of the route object |
| num | (O) Segment count |
| segments | (OF) Array of segment tags |
| MECHATRONICS_API int ROUTE_location_ask_defining_item | ( | tag_t | location_line, |
| tag_t * | defining_item_line | ||
| ) |
This function will return the defining item line for a location line.
| defining_item_line | (I) Tag of location line. (O) Tag of bomline. |
| MECHATRONICS_API int ROUTE_location_find_assigned_objects | ( | tag_t | location_line, |
| int * | objects_count, | ||
| tag_t ** | assigned_objects | ||
| ) |
This function will return assigned objects for a given location.
| objects_count | (I) Tag of location line. |
| assigned_objects | (O) Count of associated object. (OF) Tag list of associated object. |
| MECHATRONICS_API int ROUTE_location_set_defining_item | ( | tag_t | location_line, |
| tag_t | defining_item_line, | ||
| tag_t * | relation_tag | ||
| ) |
This function will associate a defining item line to a specified location. The tag of the newly created relation is returned.
| defining_item_line | (I) Tag of location line |
| relation_tag | (I) A Tag of bomline (O) Tag for identifying the newly created defining_item relation. |
| MECHATRONICS_API int ROUTE_location_unset_defining_item | ( | tag_t | location_line | ) |
This function will remove the association between defining item line and a specified location.
| location_line | (I) Tag of location line. |
This function removes a node from a route but doesn't delete the node object.
| route | (I) Tag of the route object |
| node | (I) Tag of the node |
Remove a segment from a route. This function doesn't delete the segment.
| route | (I) Tag of the route object |
| segment | (I) Tag of the segment |
| MECHATRONICS_API int ROUTE_set_assigned_location | ( | tag_t | primary_object, |
| tag_t | location_line, | ||
| tag_t * | relation_tag | ||
| ) |
This function will associate a given bomline or ROUTE object to a specified location in the role of assigned location. The tag of the newly created relation is returned.
| location_line | (I) Tag of bomline or ROUTE object. |
| relation_tag | (I) Tag of Location line (O) Tag of newly created relation. |
This function sets a center curve for a route. Use NULLTAG to unset the route curve.
| route | (I) Tag of the route object |
| center_curve | (I) Tag of the center curve |
| MECHATRONICS_API int ROUTE_set_center_curve_data | ( | tag_t | center_curve, |
| int | degree, | ||
| int | dimension, | ||
| logical | is_rational, | ||
| logical | is_uniform, | ||
| double | start_parameter, | ||
| double | end_parameter, | ||
| int | num_control_points, | ||
| double ** | control_points, | ||
| int | num_knots, | ||
| double * | knots, | ||
| int * | multiplicities | ||
| ) |
Set the geometric parameters of the curve. You must define at least two control points. The length of each vector in control points is dimension+1 if is_rational is true and is same as dimension if is_rational=false. If a curve is uniform then the knots are considered as evenly spaced. Therefore, knots should not be specified for uniform curves. A polyline can be defined as uniform curve with a degree of 1.
| center_curve | (I) Tag of the center curve |
| degree | (I) Degree of the curve |
| dimension | (I) Dimension of the curve |
| is_rational | (I) Flag indicating whether this curve is a rational curve |
| is_uniform | (I) Flag indicating whether this curve is a uniform curve |
| start_parameter | (I) Start interval of the curve between 0.0 and 1.0 |
| end_parameter | (I) End interval of the curve between 0.0 and 1.0 |
| num_control_points | (I) Number of control points |
| control_points | (I) Array of control points |
| num_knots | (I) Number of knots |
| knots | (I) Array of knots |
| multiplicities | (I) Array of knot multiplicities |
| MECHATRONICS_API int ROUTE_set_node_position | ( | tag_t | node, |
| double | x, | ||
| double | y, | ||
| double | z | ||
| ) |
This function sets the X, Y, Z, position for a node.
| node | (I) Tag of the node object |
| x | (I) X value |
| y | (I) Y value |
| z | (I) Z value |
| MECHATRONICS_API int ROUTE_set_real_length | ( | tag_t | route, |
| double | length | ||
| ) |
This function can be used to set the real length on a given route.
| route | (I) Tag of the route object |
| length | (I) Real length |
| MECHATRONICS_API int ROUTE_set_represented_length | ( | tag_t | route, |
| double | length | ||
| ) |
This function can be used to set the represented length on a given route.
| route | (I) Tag of the route object |
| length | (I) Represented length |
This function sets the center curve for a given segment. Use NULLTAG to unset the center curve for the segment.
| segment | (I) Tag of the segment |
| center_curve | (I) Tag of the center_curve |
| MECHATRONICS_API int ROUTE_set_segment_cross_section | ( | tag_t | segment, |
| double | area | ||
| ) |
This function can be used to set the cross sectional area on a given segment.
| segment | (I) Tag of the segment object |
| area | (I) Cross Sectional Area value of the segment |
This function can be used to set the end node of a segment.
| segment | (I) Tag of the segment |
| end_node | (I) Tag of the end node |
| MECHATRONICS_API int ROUTE_set_segment_real_length | ( | tag_t | segment, |
| double | length | ||
| ) |
This function can be used to set the real length on a given segment.
| segment | (I) Tag of the route object |
| length | (I) Real length of the segment |
| MECHATRONICS_API int ROUTE_set_segment_represented_length | ( | tag_t | segment, |
| double | length | ||
| ) |
This function can be used to set the represented length on a given segment.
| segment | (I) Tag of the route object |
| length | (I) Represented length of the segment |
This function can be used to set the start node of a segment.
| segment | (I) Tag of the segment |
| start_node | (I) Tag of the start node |
This fucntion breaks the association between the given route and BOM Line corresponding to a connection/device instance.
| bom_line | (I) BOM Line corresponding to a connection/device instance |
| route | (I) Tag of the route |