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

PS Connection
[Mechatronics]

Detailed Description

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

Defines for PSConnection Types

For OOTB Types of PSConnection

Defines for Mechatronics Relations

Functions

Define Documentation

#define CONNECTED_TO   "TC_Connected_To"

Definition at line 49 of file psconnection.h.

#define CONNECTION_REV_TYPE_NAME   "ConnectionRevision"

Definition at line 40 of file psconnection.h.

#define CONNECTION_TYPE_NAME   "Connection"

Definition at line 39 of file psconnection.h.

#define IMPLEMENTED_BY   "TC_Implemented_By"

Definition at line 50 of file psconnection.h.

#define NETWORK_REV_TYPE_NAME   "NetworkRevision"

Definition at line 42 of file psconnection.h.

#define NETWORK_TYPE_NAME   "Network"

Definition at line 41 of file psconnection.h.

#define PSCONNECTION_CLASS_NAME   "PSConnection"

Definition at line 26 of file psconnection.h.

#define PSCONNECTION_DEFAULT_TYPE   "PSConnection_default_type"

Definition at line 52 of file psconnection.h.

#define PSCONNECTION_REV_CLASS_NAME   "PSConnectionRevision"

Definition at line 30 of file psconnection.h.

#define PSCONNECTION_REV_TYPE_NAME   PSCONNECTION_REV_CLASS_NAME

Definition at line 31 of file psconnection.h.

#define PSCONNECTION_TYPE_NAME   PSCONNECTION_CLASS_NAME

Definition at line 27 of file psconnection.h.

#define PSConnectionClassName   PSCONNECTION_CLASS_NAME

Definition at line 28 of file psconnection.h.

#define PSConnectionRevClassName   PSCONNECTION_REV_CLASS_NAME

Definition at line 32 of file psconnection.h.

#define REALIZED_BY   "TC_Realized_By"

Definition at line 51 of file psconnection.h.

Function Documentation

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 
)

Parameters:
conn_line_tag  (I)
context_line_tag  (I)
line_count  (I)
line_tags  (I)

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

This function connects a set of GDELines to a PSConnection Line.

Parameters:
conn_line_tag  (I) Tag of the connection bomline to which the GDELines will be connected
gde_line_count  (I) Number of GDELines to be connected
gde_line_tags  (I) Tags of the GDELine’s to be connected

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

This function can be used to get the number of devices assocaited to a given connector line

Parameters:
con_line_tag  (I) Tag of primary BOM line
count  (O) No. of Devices
connectorTags  (OF) count Tags of the Devices

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

This function can be used to get the number of connectors associated to a given device line

Parameters:
device_line_tag  (I) Tag of primary BOM line
count  (O) Number of BOM lines related by the above bomline by the TC_Device_To_Connector relation
connectorTags  (OF) count Tags of the connectors

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 
)

This function creates a PSConnection and its default Connection Revision and connects the given set of GDELines to this newly created PSConnection Line.

The new PSConnectionLine is created as a child line to the common parent of the GDELines.

Restrictions:

Type (input value specified for conn_type argument), must be pre-defined by the site using the install_types utility. The conn_name will be used as the revision's name.

Parameters:
connId  (I)
connName  (I)
connType  (I)
connRev  (I)
gde_line_count  (I) Number of GDELines to be connected
gde_line_tags  (I) Tags of the GDELine’s to be connected
conn_line_tag  (O) Tag of the connection bomline to which the GDELines will be connected

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 
)

This function creates a PSConnection and its default Connection Revision and connects the given set of GDELines to this newly created PSConnection Line.The new PSConnectionLine is created as a child line to the common parent of the GDELines.

Restrictions: Type (input value specified for connType argument), must be pre-defined by the site using the install_types utility or using BMIDE.

The conn_name which is the part attribute list will be used as the revision's name.This is represented by attribute object_name.

Parameters:
connType  I> Connection type
numAttrs  I> Number of input attributes
attrNames  I> Names of input attributes
attrValues  I> Values for the input attributes
connRev  I> Id for the revision
gde_line_count  I> Number of GDELines to be connected
gde_line_tags  I> Tags of the GDELine’s to be connected
conn_line_tag  O> Tag of the connection bomline to which the GDELines will be connected

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 
)

This function creates new PSConnection and its default Connection Revision, with the given inputs.

Restrictions:

Type (input value specified for conn_type argument), must be pre-defined by the site using the install_types utility. The conn_name will be used as the revision's name.

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
conn_id  (I) Connection identification number. No two Connections can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID.
conn_name  (I) A common name or short description of the Connection Item
conn_type  (I) Connection Type for the Connection Object to be created
conn_rev_id  (I) Identification string (revision ID) of the Connection Revision being created. A null is allowed. If null, the system will automatically generate a revision ID
new_conn  (O) Tag for identifying the Connection Object in the current program
new_conn_rev  (O) Tag for identifying the Connection Revision in the current program

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 
)

This function creates new PSConnection and its default Connection Revision, with the given inputs.

Restrictions:

Type (input value specified for conn_type argument), must be pre-defined by the site using the install_types utility. The conn_name will be used as the revision's name.

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
conn_id  (I) Connection identification number. No two Connections can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID.
conn_name  (I) A common name or short description of the Connection Item
conn_type  (I) Connection Type for the Connection Object to be created
conn_rev_id  (I) Identification string (revision ID) of the Connection Revision being created. A null is allowed. If null, the system will automatically generate a revision ID
connMasterForm  (I) Tag for connection master from
connRevMasterForm  (I) Tag for connection revision master form
new_conn  (O) Tag for identifying the Connection Object in the current program
new_conn_rev  (O) Tag for identifying the Connection Revision in the current program

MECHATRONICS_API int PSCONN_disconnect ( tag_t  con_rev_tag  ) 

This function removes all the connections for this PSConnection Line

Parameters:
con_rev_tag  (I) Tag of the connection bomline for which the connections have to be removed

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

This function lists all the gde lines connected to the input PSConnection Line.

Restrictions:

Only configured GDE Lines will be returned

Only BOMLines connected in the context of the said BOM Window will be returned.

Parameters:
conn_line_tag  (I) Tag of the connection bomline to which the GDELines will be connected
gde_line_count  (O) Number of GDELines connected
gde_line_tags  (OF) gde_line_count Tags of the connected GDELine’s

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

This function lists all the bomlines implemented by the input BOMLine.

Restrictions:

Only configured GDE Lines will be returned

Only Implemented BOMLines from the BOM Window in context will be returned.

Parameters:
bom_line_tag  (I) Tag of the bomline for which the implementations are to be listed
gde_line_count  (O) Number of BOMLines implemented by the above bomline
gde_line_tags  (OF) gde_line_count Tags of the realized BOM Lines

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

This function lists all the bomlines implementing the input BOMLine.

Restrictions:

Only configured Lines will be returned

Only Implementing BOMLines from the BOM Window in context will be returned.

Parameters:
bom_line_tag  (I) Tag of the bomline for which the implementing lines are to be listed
line_count  (O) Number of BOMLines implementing the above bomline
line_tags  (OF) line_count Tags of the implementing BOM Lines

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

This function lists all the bomlines realized by the input BOMLine.

Restrictions:

Only configured GDE Lines will be returned

Only Realized BOMLines from the BOM Window in context will be returned.

Parameters:
bom_line_tag  (I) Tag of the bomline for which the realized by are to be listed
gde_line_count  (O) Number of BOMLines realized by the above bomline
gde_line_tags  (OF) gde_line_count Tags of the realized BOM Lines

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

This function lists all the bomlines realizing the input BOMLine.

Restrictions:

Only configured Lines will be returned

Only Realizing BOMLines from the BOM Window in context will be returned.

Parameters:
bom_line_tag  (I) Tag of the bomline for which the realizing lines are to be listed
line_count  (O) Number of BOMLines realized by the above bomline
line_tags  (OF) line_count Tags of the realizing BOM Lines

MECHATRONICS_API int PSCONN_remove_from_connection ( tag_t  conn_line_tag,
int  gde_line_count,
tag_t *  gde_line_tags 
)

This function removes the connection(s) between the given list of GDE Lines and the PSConnection Line

Parameters:
conn_line_tag  (I) Tag of the connection bomline to which the GDELines will be connected
gde_line_count  (I) Number of GDELines to be connected
gde_line_tags  (I) Tags of the GDELine’s to be connected

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

This function will remove the implementedBy relation between the given input primary_line and secondary lines. If no secondary lines are given then all the secondary lines with implementedBy relation will be removed.

Restrictions:

Only implementedBy BOMLines from the BOM Window in context will be removed.

Parameters:
primary_line_tag  (I) Tag of primary BOMLine
secondary_line_count  (I) Count of the secondary BOMLines. This can be 0
secondary_line_tags  (I) Array of secondary bomline tags

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

This function will remove the realizedBy relation between the given input primary_line and secondary lines. If no secondary lines are given then all the secondary lines with realizedBy relation will be removed.

Restrictions:

Only realizedBy BOMLines from the BOM Window in context will be removed.

Parameters:
primary_line_tag  (I) Tag of primary BOMLine
secondary_line_count  (I) Count of the secondary BOMLines. This can be 0
secondary_line_tags  (I) Array of secondary bomline tags

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

This function can be used to set the TC_Device_To_Connector relation between the given input BOM lines.

Parameters:
primary_line_tag  (I) Tag of BOM line to be used as primary object in TC_Device_To_Connector relation
secondary_line_tag  (I) Tag of BOM line to be used as secondary object in the TC_Device_To_Connector relation
relation_tag  (O) Tag of the relation

MECHATRONICS_API int PSCONN_set_implementedBy ( tag_t  primary_line_tag,
tag_t  secondary_line_tag 
)

This function set the implementedBy relation between the given input BOMLines.

Parameters:
primary_line_tag  (I) Tag of BomLine to be used as primary object in implementedBy relation
secondary_line_tag  (I) Tag of BomLine to be used as secondary object in implementedBy relation

MECHATRONICS_API int PSCONN_set_realizedBy ( tag_t  primary_line_tag,
tag_t  secondary_line_tag 
)

This function set the realizedBy relation between the given input BOMLines.

Parameters:
primary_line_tag  (I) Tag of BomLine to be used as primary object in realizedBy relation
secondary_line_tag  (I) Tag of BomLine to be used as secondary object in realizedBy relation

MECHATRONICS_API int PSCONN_unset_device_connector_relation ( tag_t  primary_line_tag,
tag_t  secondary_line_tag 
)

This function can be used to unset the TC_Device_To_Connector relation between the given input BOM lines.

Parameters:
primary_line_tag  (I) Tag of primary BOM line
secondary_line_tag  (I) Tag of secondary BOM line