route.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef ROUTE_H
#define ROUTE_H

#include <unidefs.h>
#include <mechatronics/libmechatronics_exports.h>

#define ROUTED_BY "TC_Routed_By"
#define DEVICE_TO_CONNECTOR "TC_Device_To_Connector"

typedef enum ROUTE_display_font_e {
    ROUTE_display_font_solid = 0,
    ROUTE_display_font_dashed,
    ROUTE_display_font_dotted
} ROUTE_display_font_t;

#ifdef __cplusplus
        extern "C"{
#endif

extern MECHATRONICS_API int ROUTE_create (
    const char*  name,               
    const char*  description,        
    tag_t        bvr,                
    tag_t*       route               
    );


extern MECHATRONICS_API int ROUTE_add_segment(
    tag_t route,                     
    tag_t segment,                   
    int   position                   
    );

extern MECHATRONICS_API int ROUTE_remove_segment (
    tag_t route,                 
    tag_t segment                
    );

extern MECHATRONICS_API int ROUTE_list_segments(
    tag_t route,                     
    int* num,                        
    tag_t** segments                 
    );

extern MECHATRONICS_API int ROUTE_ask_length(
    tag_t route,                     
    double *real_length,             
    double *represented_length       
    );

extern MECHATRONICS_API int ROUTE_set_real_length(
    tag_t route,                     
    double length                    
    );

extern MECHATRONICS_API int ROUTE_set_represented_length(
    tag_t route,                     
    double length                    
    );

extern MECHATRONICS_API int ROUTE_add_node (
    tag_t route,                 
    tag_t node,                  
    int   position               
    );

extern MECHATRONICS_API int ROUTE_remove_node (
    tag_t route,                 
    tag_t node                   
    );

extern MECHATRONICS_API int ROUTE_list_nodes(
    tag_t route,                     
    int* num,                        
    tag_t **nodes                    
    );

extern MECHATRONICS_API int ROUTE_set_center_curve(
    tag_t route,                   
    tag_t center_curve             
    );

extern MECHATRONICS_API int ROUTE_ask_center_curve(
    tag_t route,                  
    tag_t *center_curve           
    );


extern MECHATRONICS_API int ROUTE_create_segment (
    const char *name,           
    tag_t bvr,                  
    tag_t  *segment             
    );

extern MECHATRONICS_API int ROUTE_ask_segment_name (
    tag_t  segment,       
    char**  name          
    );


extern MECHATRONICS_API int ROUTE_ask_segment_start (
    tag_t  segment,                 
    tag_t  *start_node              
    );

extern MECHATRONICS_API int ROUTE_set_segment_start (
    tag_t  segment,                 
    tag_t  start_node               
    );

extern MECHATRONICS_API int ROUTE_ask_segment_end (
    tag_t  segment,                
    tag_t  *end_node               
    );

extern MECHATRONICS_API int ROUTE_set_segment_end (
    tag_t  segment,                
    tag_t  end_node                
    );

extern MECHATRONICS_API int ROUTE_ask_segment_center_curve (
    tag_t  segment,              
    tag_t  *center_curve          
    );

extern MECHATRONICS_API int ROUTE_set_segment_center_curve (
    tag_t  segment,            
    tag_t  center_curve        
    );



extern MECHATRONICS_API int ROUTE_ask_segment_routes(
    tag_t segment,              
    int *count,                  
    tag_t **routes              
);


extern MECHATRONICS_API int ROUTE_ask_segment_length(
    tag_t segment,                    
    double *real_length,              
    double *represented_length        
    );

extern MECHATRONICS_API int ROUTE_set_segment_real_length(
    tag_t segment,                    
    double length                     
    );

extern MECHATRONICS_API int ROUTE_set_segment_represented_length(
    tag_t segment,                    
    double length                     
    );

extern MECHATRONICS_API int ROUTE_set_segment_cross_section(
    tag_t segment,                    
    double area                       
    );

extern MECHATRONICS_API int ROUTE_ask_segment_cross_section(
    tag_t segment,                    
    double *area                      
    );

extern MECHATRONICS_API int ROUTE_create_node (
    const char *name,                
    tag_t bvr,                       
    tag_t  *node                     
    );

extern MECHATRONICS_API int ROUTE_ask_node_name (
    tag_t  node,                    
    char**  name                    
    );

extern MECHATRONICS_API int ROUTE_set_node_position (
    tag_t  node,                    
    double x,                       
    double y,                       
    double z                        
    );

extern MECHATRONICS_API int ROUTE_ask_node_position (
    tag_t  node,                    
    double *x,                      
    double *y,                      
    double *z                       
    );

extern MECHATRONICS_API int ROUTE_ask_node_segments(
    tag_t node,                     
    int   *count,                   
    tag_t **segments                
    );

extern MECHATRONICS_API int ROUTE_ask_node_routes(
    tag_t node,                     
    int   *count,                   
    tag_t **routes                  
    );

extern MECHATRONICS_API int ROUTE_create_center_curve (
    const char *name,               
    tag_t  bvr,                     
    tag_t  *center_curve            
    );

extern 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            
    );


extern 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            
    );


extern MECHATRONICS_API int ROUTE_ask_center_curve_name (
    tag_t center_curve,             
    char **name                     
    );

extern MECHATRONICS_API int ROUTE_ask_center_curve_segments(
    tag_t center_curve,             
    int *count,                     
    tag_t **segments                
    );

extern MECHATRONICS_API int ROUTE_ask_center_curve_routes(
    tag_t center_curve,         
    int *count,                 
    tag_t **routes              
    );


extern MECHATRONICS_API int ROUTE_associate(
    tag_t bom_line,              
    tag_t route                 
    );

extern MECHATRONICS_API int ROUTE_unassociate(
    tag_t bom_line,             
    tag_t route                 
    );

extern MECHATRONICS_API int ROUTE_ask_associated_route(
    tag_t bom_line,              
    tag_t *route                 
    );

extern MECHATRONICS_API int ROUTE_ask_associated_bom_lines(
    tag_t route,                 
    tag_t window,                
    int   *count,                
    tag_t **bom_lines            
    );

extern MECHATRONICS_API int ROUTE_display_set_props(
       tag_t route_tag,            
       ROUTE_display_font_t font,  
       double width,               
       const double color[3]       
      );

extern MECHATRONICS_API int ROUTE_display_ask_props(
       tag_t route_display,         
       ROUTE_display_font_t *font,  
       double *width,               
       double color[3]              
      );

extern 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    
      );

extern 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    
      );


extern MECHATRONICS_API int ROUTE_set_assigned_location (
        tag_t primary_object,       
        tag_t location_line,        
        tag_t *relation_tag         
      );

extern MECHATRONICS_API int ROUTE_unset_assigned_location (
        tag_t primary_object,       
        tag_t location_line         
      );

extern MECHATRONICS_API int ROUTE_ask_assigned_locations (
        tag_t associating_object,           
        tag_t window_tag,                   
        int *location_count,                
        tag_t **assigned_location_lines     
      );

extern MECHATRONICS_API int ROUTE_location_set_defining_item (
        tag_t location_line,            
        tag_t defining_item_line,       
        tag_t *relation_tag             
      );

extern MECHATRONICS_API int ROUTE_location_unset_defining_item (
        tag_t location_line         
      );

extern MECHATRONICS_API int ROUTE_location_ask_defining_item (
        tag_t location_line,        
        tag_t *defining_item_line   
      );

extern MECHATRONICS_API int ROUTE_location_find_assigned_objects (
        tag_t location_line,        
        int *objects_count,         
        tag_t **assigned_objects    
      );

extern MECHATRONICS_API int ROUTE_delete_route_data (
        tag_t bvr        
      );


#ifdef __cplusplus
}
#endif

#include <mechatronics/libmechatronics_undef.h>
#endif