psconnection.h

Go to the documentation of this file.

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

/*  */

#ifndef PSCONNECTION_H
#define PSCONNECTION_H

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

#define PSCONNECTION_CLASS_NAME     "PSConnection"
#define PSCONNECTION_TYPE_NAME      PSCONNECTION_CLASS_NAME
#define PSConnectionClassName       PSCONNECTION_CLASS_NAME

#define PSCONNECTION_REV_CLASS_NAME "PSConnectionRevision"
#define PSCONNECTION_REV_TYPE_NAME  PSCONNECTION_REV_CLASS_NAME
#define PSConnectionRevClassName    PSCONNECTION_REV_CLASS_NAME

#define CONNECTION_TYPE_NAME        "Connection"
#define CONNECTION_REV_TYPE_NAME    "ConnectionRevision"
#define NETWORK_TYPE_NAME           "Network"
#define NETWORK_REV_TYPE_NAME       "NetworkRevision"

#define CONNECTED_TO                "TC_Connected_To"
#define IMPLEMENTED_BY              "TC_Implemented_By"
#define REALIZED_BY                 "TC_Realized_By"
#define PSCONNECTION_DEFAULT_TYPE   "PSConnection_default_type"

#ifdef __cplusplus
extern "C"{
#endif

extern MECHATRONICS_API int PSCONN_create_connection (
    const char*             conn_id,        
    const char*             conn_name,      
    const char*             conn_type,      
    const char*             conn_rev_id,    
    tag_t*                  new_conn,       
    tag_t*                  new_conn_rev    
    );

extern MECHATRONICS_API int PSCONN_add_to_connection (
    tag_t                   conn_line_tag,      
    int                     gde_line_count,     
    tag_t*                  gde_line_tags       
    );

extern MECHATRONICS_API int PSCONN_add_itemlines_to_connection (
    tag_t                   conn_line_tag,      
    tag_t                   context_line_tag,   
    int                     line_count,         
    tag_t*                  line_tags           
    );

extern MECHATRONICS_API int PSCONN_connect2 (
    const                   char *connType, 
    int                     numAttrs,       
    char                    **attrNames,    
    char                    **attrValues,   
    char                    *connRev,       
    int                     gde_line_count, 
    tag_t                   *gde_line_tags, 
    tag_t                   *conn_line_tag  
    );

extern MECHATRONICS_API int PSCONN_connect (
    char*                   connId,         
    char*                   connName,       
    char*                   connType,       
    char*                   connRev,        
    int                     gde_line_count, 
    tag_t*                  gde_line_tags,  
    tag_t*                  conn_line_tag   
    );
extern MECHATRONICS_API int PSCONN_remove_from_connection (
    tag_t                   conn_line_tag,      
    int                     gde_line_count,     
    tag_t*                  gde_line_tags       
    );

extern MECHATRONICS_API int PSCONN_disconnect (
    tag_t                   con_rev_tag     
    );

extern MECHATRONICS_API int PSCONN_list_connected_gdes (
    tag_t                   conn_line_tag,      
    int*                    gde_line_count,     
    tag_t**                 gde_line_tags       
    );

extern MECHATRONICS_API int PSCONN_list_realizedBy (
    tag_t                   bom_line_tag,       
    int*                    gde_line_count,     
    tag_t**                 gde_line_tags       
    );

extern MECHATRONICS_API int PSCONN_list_realizingLines (
    tag_t                   bom_line_tag,       
    int*                    line_count,        
    tag_t**                 line_tags         
    );


extern MECHATRONICS_API int PSCONN_list_implementedBy (
    tag_t                   bom_line_tag,       
    int*                    gde_line_count,     
    tag_t**                 gde_line_tags       
    );


extern MECHATRONICS_API int PSCONN_list_implementingLines (
    tag_t                   bom_line_tag,       
    int*                    line_count,         
    tag_t**                 line_tags          
    );


extern MECHATRONICS_API int PSCONN_set_implementedBy (
    tag_t                   primary_line_tag,   
    tag_t                   secondary_line_tag  
    );

extern MECHATRONICS_API int PSCONN_set_realizedBy (
    tag_t                   primary_line_tag,   
    tag_t                   secondary_line_tag  
    );

extern MECHATRONICS_API int PSCONN_set_device_connector_relation (
    tag_t                   primary_line_tag,   
    tag_t                   secondary_line_tag, 
    tag_t*                  relation_tag        
    );

extern MECHATRONICS_API int PSCONN_unset_device_connector_relation (
    tag_t                   primary_line_tag,   
    tag_t                   secondary_line_tag  
    );

extern MECHATRONICS_API int PSCONN_ask_device_connectors (
    tag_t                   device_line_tag, 
    int*                    count,           
    tag_t**                 connectorTags    
    );

extern MECHATRONICS_API int PSCONN_ask_connector_devices (
    tag_t                   con_line_tag,    
    int*                    count,           
    tag_t**                 connectorTags    
    );

extern MECHATRONICS_API int PSCONN_remove_implementedBy (
    tag_t                   primary_line_tag,       
    int                     secondary_line_count,   
    tag_t*                  secondary_line_tags     
    );

extern MECHATRONICS_API int PSCONN_remove_realizedBy (
    tag_t                   primary_line_tag,       
    int                     secondary_line_count,   
    tag_t*                  secondary_line_tags     
    );


extern MECHATRONICS_API int PSCONN_create_connection_with_forms (
    const char*             conn_id,        
    const char*             conn_name,      
    const char*             conn_type,      
    const char*             conn_rev_id,    
    tag_t                  connMasterForm,       
    tag_t                  connRevMasterForm,    
    tag_t*                  new_conn,       
    tag_t*                  new_conn_rev    
    );

extern MECHATRONICS_API int PSCONN_get_connections_from_line (
    tag_t                   line_tag,                
    int*                    connection_line_count,   
    tag_t**                 connection_line_tags     
    );

#ifdef __cplusplus
}
#endif

#include <mechatronics/libmechatronics_undef.h>

#endif