Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

GDE Link
[Mechatronics]

Detailed Description

This module defines the required ITK interface for GeneralDesignElementLink related operations.

Defines

Functions

Define Documentation

#define GDELINK_CLASS_NAME   "GeneralDesignElementLink"

Definition at line 21 of file gdelink.h.

#define GDELINK_DEFAULT_TYPE   "GDELink_default_type"

Preference for GDELink type used when creating a new connection without an explicit given type

Definition at line 29 of file gdelink.h.

#define GDELINK_STORAGE_CLASS_NAME   "GDELinkStorage"

Definition at line 23 of file gdelink.h.

#define GDELINK_STORAGE_TYPE_NAME   GDELINK_STORAGE_CLASS_NAME

Definition at line 24 of file gdelink.h.

#define GDELINK_TYPE_NAME   GDELINK_CLASS_NAME

Definition at line 22 of file gdelink.h.

#define TC_LINK   "TC_Link"

The default Out of The Box GDELink type for creating a new connection

Definition at line 34 of file gdelink.h.

Function Documentation

MECHATRONICS_API int GDELINK_add_to_connection ( tag_t  gdelink_line_tag,
int  gde_line_count,
tag_t *  gde_line_tags 
)

This function takes list of gde occurrences (gde bomline) and makes connection to existing gdelink line

Parameters:
gdelink_line_tag  (I) Tag of the GDELink line
gde_line_count  (I) Number of GDELines
gde_line_tags  (I) Tags of the GDELines

MECHATRONICS_API int GDELINK_connect ( const char *  gdelink_name,
const char *  gdelink_desc,
const char *  gdelink_type,
int  gde_line_count,
tag_t *  gde_line_tags,
tag_t *  gdelink_line_tag 
)

This function takes a list of gde occurrences (gde bomline) and makes a connection to an existing gdelink line

Parameters:
gdelink_name  (I) Name of the GDELink
gdelink_desc  (I) Description of the GDELink
gdelink_type  (I) Type of the GDELink to be created
gde_line_count  (I) Number of GDE Lines to be connected
gde_line_tags  (I) Tags of the GDE Lines
gdelink_line_tag  (O) Tag of the newly created GDELink

MECHATRONICS_API int GDELINK_create ( const char *  gdelink_name,
const char *  gdelink_desc,
const char *  gdelink_type,
tag_t *  new_gdelink 
)

This Function is used to create a new GDELink

Parameters:
gdelink_name  (I) Name of the GDELink
gdelink_desc  (I) Description of the GDELink
gdelink_type  (I) Type of the GDELink to be created
new_gdelink  (O) Tag of the newly created GDELink

MECHATRONICS_API int GDELINK_disconnect ( tag_t  gdelink_line_tag  ) 

Disconnect all occurrences that are connected to a gdelink line

Parameters:
gdelink_line_tag  (I) Tag of the GDELink Line

MECHATRONICS_API int GDELINK_list_connected_gdes ( tag_t  gdelink_line_tag,
int *  gde_line_count,
tag_t **  gde_line_tags 
)

This function list all the gde objects connected to the given GDELink

Parameters:
gdelink_line_tag  (I) Tag of the GDELink Line
gde_line_count  (O) Number of GDE Lines to be removed from connection
gde_line_tags  (OF) gde_line_count Tags of the GDE Lines

MECHATRONICS_API int GDELINK_list_implementedBy ( tag_t  gdelink_line_tag,
int *  gde_line_count,
tag_t **  gde_line_tags 
)

This function list all the implementedBy bomLines objects to the given BOMLine.

Parameters:
gdelink_line_tag  (I) Tag of the GDELink Line
gde_line_count  (O) Number of GDE Lines to be removed from connection
gde_line_tags  (OF) gde_line_count Tags of the GDE Lines

MECHATRONICS_API int GDELINK_list_realizedBy ( tag_t  bom_line_tag,
int *  gde_line_count,
tag_t **  gde_line_tags 
)

This function list all the realizedBy bomLines objects to the given BOMLine.

Parameters:
bom_line_tag  (I) Tag of the GDELink Line
gde_line_count  (O) Number of GDE Lines to be removed from connection
gde_line_tags  (O) Tags of the GDE Lines

MECHATRONICS_API int GDELINK_remove_from_connection ( tag_t  gdelink_line_tag,
int  gde_line_count,
tag_t *  gde_line_tags 
)

Disconnect the input occurrences from the gdelink line

Parameters:
gdelink_line_tag  (I) Tag of the GDELink Line
gde_line_count  (I) Number of GDE Lines to be removed from connection
gde_line_tags  (I) Tags of the GDE Lines