hrn.h

Go to the documentation of this file.

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

/*  */

#ifndef HRN_H
#define HRN_H

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

#define HRN_INT_NULL (-9999)
#define HRN_STRING_NULL "NULL"
#define HRN_DOUBLE_NULL ((double)-9999.99)

typedef struct HRN_wire_length_data_s
{
    char *length_type;
    double length_value;
} HRN_wire_length_data_t, *HRN_wire_length_data_p_t;

typedef struct HRN_wire_color_data_s
{
    char *color_type;
    char *color_value;
} HRN_wire_color_data_t, *HRN_wire_color_data_p_t;

typedef struct HRN_fixing_assignment_data_s
{
    double location_value;
    double orientation_value[3];
} HRN_fixing_assignment_data_t, *HRN_fixing_assignment_data_p_t;

typedef struct HRN_connector_occ_data_s
{
    char* id;
    int alias_count;
    char** alias_ids;
    char* usage;
} HRN_connector_occ_data_t, *HRN_connector_occ_data_p_t;

typedef struct HRN_protection_area_data_s
{
    double end_location;
    double start_location;
    double gradient;
    char* taping_direction;
} HRN_protection_area_data_t, *HRN_protection_area_data_p_t;

typedef struct HRN_part_occ_data_s
{
    char* id;
    int alias_count;
    char** alias_ids;
} HRN_part_occ_data_t, *HRN_part_occ_data_p_t;

typedef struct HRN_cavity_occ_data_s
{
    char* id;
    double position_on_wire;
} HRN_cavity_occ_data_t, *HRN_cavity_occ_data_p_t;

typedef struct HRN_wire_protect_occ_data_s
{
    char* id;
    double protect_length;
    int alias_count;
    char** alias_ids;
} HRN_wire_protect_occ_data_t, *HRN_wire_protect_occ_data_p_t;

typedef struct HRN_general_wire_occ_data_s
{
    char* wire_number;
    char* multiplier;
    char* offset;
    char* seperation_code;
} HRN_general_wire_occ_data_t, *HRN_general_wire_occ_data_p_t;

#ifdef __cplusplus
    extern "C"{
#endif


extern MECHATRONICS_API int HRN_set_associated_part(
    tag_t  cavity_line_tag,  
    tag_t  part_line_tag,    
    tag_t  *relation_tagptr  
    );

extern MECHATRONICS_API int HRN_ask_associated_parts (
    tag_t  cavity_line_tag,          
    int *associated_parts_count,     
    tag_t **associated_part_tags     
    );

extern MECHATRONICS_API int HRN_unset_associated_part(
    tag_t  cavity_line_tag, 
    tag_t  part_line_tag    
    );

extern MECHATRONICS_API int HRN_set_wire_protection_segment(
    tag_t  wirep_line_tag,   
    tag_t  segment_tag,      
    tag_t  *relation_tagptr  
    );

extern MECHATRONICS_API int HRN_ask_wire_protection_segment (
    tag_t  wirep_line_tag,          
    tag_t  *segment_tag             
    );

extern MECHATRONICS_API int HRN_unset_wire_protection_segment(
    tag_t  wirep_line_tag, 
    tag_t  segment_tag         );


extern MECHATRONICS_API int HRN_ask_wire_protection_segments (
    tag_t   wire_protection_line_tag,   /* <I> */
    int     *n_segments,                /* <O> */
    tag_t   **segment_tags              /* <OF> */
);

extern MECHATRONICS_API int HRN_set_wire_protection_segments (
    tag_t  wire_protection_line_tag,    /* <I> */
    int n_segments,                     /* <I> */
    tag_t* segment_tags                 /* <I> */
);

extern MECHATRONICS_API int HRN_unset_wire_protection_segments (
    tag_t   wire_protection_line_tag,   /* <I> */
    int     n_segments,                 /* <I> */
    tag_t*  segment_tags                /* <I> */
);


extern MECHATRONICS_API int HRN_set_protection_area_data (
    tag_t wire_protect_line_tag,                        
    const HRN_protection_area_data_t* protect_area_data 
    );


extern MECHATRONICS_API int HRN_get_protection_area_data (
    tag_t wire_protect_line_tag,                    
    HRN_protection_area_data_t* protect_area_data   
    );


extern MECHATRONICS_API int HRN_remove_protection_area_data (
    tag_t wire_protect_line_tag         
    );


extern MECHATRONICS_API int HRN_set_fixing_segment(
    tag_t  bom_line_tag,     
    tag_t  segment_tag,      
    tag_t  *relation_tagptr  
    );

extern MECHATRONICS_API int HRN_ask_fixing_segment (
    tag_t  bom_line_tag,            
    tag_t  *segment_tag             
    );


extern MECHATRONICS_API int HRN_set_fixing_assignment_data (
    tag_t fixing_line_tag,                              
    const HRN_fixing_assignment_data_t* assignment_data 
    );


extern MECHATRONICS_API int HRN_get_fixing_assignment_data (
    tag_t fixing_line_tag,                          
    HRN_fixing_assignment_data_t* assignment_data   
    );


extern MECHATRONICS_API int HRN_remove_fixing_assignment_data (
    tag_t fixing_line_tag            
    );


extern MECHATRONICS_API int HRN_unset_fixing_segment(
    tag_t  bom_line_tag,   
    tag_t  segment_tag     
    );

extern MECHATRONICS_API int HRN_ask_referenced_component (
    tag_t  node_tag,                
    tag_t  window_tag,              
    int *reference_comp_count,      
    tag_t **reference_comp_tags     
    );

extern MECHATRONICS_API int HRN_set_referenced_component(
    tag_t  node_tag,              
    tag_t  reference_comp_tag,    
    tag_t  *relation_tagptr       
    );

extern MECHATRONICS_API int HRN_unset_referenced_component(
    tag_t  node_tag,             
    tag_t  reference_comp_tag    
    );


extern MECHATRONICS_API int HRN_set_part_occ_data (
    tag_t  bom_line_tag,                     
    const HRN_part_occ_data_t* part_occ_data 
    );


extern MECHATRONICS_API int HRN_get_part_occ_data (
    tag_t  bom_line_tag,                
    HRN_part_occ_data_t* part_occ_data  
    );


extern MECHATRONICS_API int HRN_remove_part_occ_data (
    tag_t  bom_line_tag                
    );

extern MECHATRONICS_API int HRN_set_connector_occ_data (
    tag_t bom_line_tag,                                 
    const HRN_connector_occ_data_t* connector_occ_data  
    );


extern MECHATRONICS_API int HRN_get_connector_occ_data (
    tag_t bom_line_tag,                             
    HRN_connector_occ_data_t* connector_occ_data    
    );


extern MECHATRONICS_API int HRN_remove_connector_occ_data (
    tag_t  bom_line_tag              
    );

extern MECHATRONICS_API int HRN_set_cavity_data (
    tag_t cavity_line_tag,                          
    const HRN_cavity_occ_data_t* cavity_occ_data    
    );


extern MECHATRONICS_API int HRN_get_cavity_data (
    tag_t cavity_line_tag,                  
    HRN_cavity_occ_data_t* cavity_occ_data  
    );


extern MECHATRONICS_API int HRN_remove_cavity_data (
    tag_t cavity_line_tag          
    );

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


extern MECHATRONICS_API int HRN_get_wire_protect_occ_data (
    tag_t bom_line_tag,                                 
    HRN_wire_protect_occ_data_t* wire_protect_occ_data  
    );


extern MECHATRONICS_API int HRN_remove_wire_protect_occ_data (
    tag_t  bom_line_tag             
    );

extern MECHATRONICS_API int HRN_set_general_wire_occ_data (
    tag_t line_tag,                                     
    const HRN_general_wire_occ_data_t *wire_occ_data    
    );

extern MECHATRONICS_API int HRN_get_general_wire_occ_data (
    tag_t line_tag,                                 
    HRN_general_wire_occ_data_t *wire_occ_data      
    );

extern MECHATRONICS_API int HRN_remove_general_wire_occ_data (
    tag_t line_tag              
    );

extern MECHATRONICS_API int HRN_set_wire_length_information (
    tag_t bom_line,              
    const char *length_type,     
    double length_value          
    );

extern MECHATRONICS_API int HRN_get_wire_length_information (
    tag_t bom_line,               
    const char *length_type,      
    double *length_value          
    );

extern MECHATRONICS_API int HRN_get_all_wire_length_information (
    tag_t bom_line,                         
    int* count,                             
    HRN_wire_length_data_t** length_data    
    );

extern MECHATRONICS_API int HRN_remove_wire_length_information (
    tag_t bom_line,             
    const char *length_type     
    );

extern MECHATRONICS_API int HRN_set_wire_color (
    tag_t object_tag,              
    const char *color_type,        
    const char *color_value        
    );

extern MECHATRONICS_API int HRN_get_wire_color (
    tag_t object_tag,              
    const char *color_type,        
    char **color_value             
    );

extern MECHATRONICS_API int HRN_get_all_wire_color (
    tag_t object_tag,                          
    int* count,                                
    HRN_wire_color_data_t** wire_color_data    
    );

extern MECHATRONICS_API int HRN_remove_wire_color (
    tag_t object_tag,             
    const char *color_type        
    );


#ifdef __cplusplus
}
#endif

#include <mechatronics/libmechatronics_undef.h>
#endif