ITK Function Reference
(V10000.1.0.60_20160308.00)
Modules | Macros | Functions
CPD0CD

Modules

 CPD0CD Errors
 

Macros

#define CPD0CD_MATRIX_SIZE   16
 

Functions

CPD0CD_API int CPD0CD_ask_design_element_all_subordinates (tag_t design_element, int *sub_count, tag_t **subordinates)
 
CPD0CD_API int CPD0CD_construct_promissory_element_create_input (tag_t cd, tag_t de_type, const char *de_id, const char *de_name, const char *logical_designator, tag_t *de_create_input)
 
CPD0CD_API int CPD0CD_construct_reuse_element_create_input (tag_t cd, tag_t item_rev, tag_t bv_type, tag_t revision_rule, const char *de_id, tag_t de_type, const char *de_name, const double transform[CPD0CD_MATRIX_SIZE], const char *logical_designator, tag_t *de_create_input)
 
CPD0CD_API int CPD0CD_construct_shape_element_create_input (tag_t cd, tag_t de_type, const char *de_id, const char *de_name, const double transform[16], const char *logical_designator, tag_t *de_create_input)
 
CPD0CD_API int CPD_update_item_realization (tag_t reuse_de_tag, tag_t item_rev_tag, logical update_subordinates, int *num_added_subordinates, tag_t **added_subordinates, int *num_updated_subordinates, tag_t **updated_subordinates, int *num_removed_subordinates, tag_t **removed_subordinates)
 
CPD0CD_API int CPD_update_item_realization2 (tag_t reuse_de_tag, tag_t item_rev_tag, logical sync_effectivity_expressions, logical sync_variant_expressions, logical update_subordinates, int *num_added_subordinates, tag_t **added_subordinates, int *num_updated_subordinates, tag_t **updated_subordinates, int *num_removed_subordinates, tag_t **removed_subordinates)
 

Detailed Description

Macro Definition Documentation

#define CPD0CD_MATRIX_SIZE   16

This is the size of 4th Generation Designer (4gd) matrices. Double arrays should be this big for 4th generation designer functions.

Definition at line 33 of file cpd0cd.h.

Function Documentation

CPD0CD_API int CPD0CD_ask_design_element_all_subordinates ( tag_t  design_element,
int *  sub_count,
tag_t **  subordinates 
)

Returns the list of all subordinates for a Design Element. This routine will find the immediate children and all sub level children for the Design Element. The returned codes are:

  • ITK_ok on success.
  • CPD0CD_internal_error if the expected subordinates could not be found (invalid data condition).
  • CXPOM_invalid_tag if the DE tag is invalid.
Parameters
sub_count(I) Tag of a design element,
subordinates(O) count of subordinate tags (OF) sub_count Tags of subordinate objects
CPD0CD_API int CPD0CD_construct_promissory_element_create_input ( tag_t  cd,
tag_t  de_type,
const char *  de_id,
const char *  de_name,
const char *  logical_designator,
tag_t *  de_create_input 
)

Constructs a promissory element input. The process to make a promissory element is:

  1. constructs create input
  2. Add any other attributes to element
  3. TCTYPE_create_object (input, promissory object)

The returned codes are:

  • ITK_ok on success.
  • PROP_invalid_object if the promissory element input is a NULLTAG.
Parameters
cd(I) owning collaborative design
de_type(I) Type of design element to create
de_id(I) ID of new design element; if null or empty, a new ID will be automatically generated during creation
de_name(I) name for new design element
logical_designator(I) logical designator for the design element (can be empty)
de_create_input(O) tag of new design element create input
CPD0CD_API int CPD0CD_construct_reuse_element_create_input ( tag_t  cd,
tag_t  item_rev,
tag_t  bv_type,
tag_t  revision_rule,
const char *  de_id,
tag_t  de_type,
const char *  de_name,
const double  transform[CPD0CD_MATRIX_SIZE],
const char *  logical_designator,
tag_t *  de_create_input 
)

Constructs a reuse design element create input. The process to make a reuse element is:

  1. constructs create input
  2. Add any other attributes to element
  3. TCTYPE_create_object (input, reuse object)

The returned codes are:

  • ITK_ok on success.
  • PROP_invalid_object if the reuse element input is a NULLTAG.
Parameters
cd(I) owning collaborative design
item_rev(I) existing item revision
bv_type(I) The type of BOM view to use when configuring structure below item revision (if NULL_TAG, then the default view type will be used)
revision_rule(I) revision rule to use when configuring structure below item revision (if NULL_TAG, then default revision rule will be used)
de_id(I) unique design element id to assign
de_type(I) Type of design element to create (if NULL_TAG, then Cpd0DesignElement will be used).
de_name(I) The name for new design element
transform(I)transformation into collaborative design
logical_designator(I)attribute to label design element
de_create_input(O) tag of new design element create input
CPD0CD_API int CPD0CD_construct_shape_element_create_input ( tag_t  cd,
tag_t  de_type,
const char *  de_id,
const char *  de_name,
const double  transform[16],
const char *  logical_designator,
tag_t *  de_create_input 
)

Constructs a shape design element input. The process to make a shape element is:

  1. constructs create input
  2. Add any other attributes to element
  3. TCTYPE_create_object (input, shape object)

The returned codes are:

  • ITK_ok on success.
  • PROP_invalid_object if the shape element input is a NULLTAG.
Parameters
cd(I) owning collaborative design
de_type(I) Type of design element to create
de_id(I) ID of new design element; if null or empty, a new ID will be automatically generated during creation
de_name(I) name for new design element
transform(I) transformation into collaborative design
logical_designator(I) logical designator for the design element (can be empty)
de_create_input(O) tag of new design element create input
CPD0CD_API int CPD_update_item_realization ( tag_t  reuse_de_tag,
tag_t  item_rev_tag,
logical  update_subordinates,
int *  num_added_subordinates,
tag_t **  added_subordinates,
int *  num_updated_subordinates,
tag_t **  updated_subordinates,
int *  num_removed_subordinates,
tag_t **  removed_subordinates 
)

Updates the Reuse Design Element and optionally its Subordinates in a Collaborative Design using the provided source Item Assembly. The returned codes are:

  • ITK_ok on success.
  • MDLOMODEL_object_has_no_status in case where the source Item Revision is not having a release status.
Deprecated:
This function is deprecated, it will be removed from Teamcenter 12.1 From Tc10.1 onwards, please use CPD_update_item_realization2.
Parameters
reuse_de_tag(I) Reuse Design Element Tag
item_rev_tag(I) Optional Tag of the Item Revision for the source Item Assembly needed if new Source Assembly is selected for update
update_subordinates(I) Flag set to true to update Subordinate Design Elements else set to false
num_added_subordinates(O) Number of added Subordinate Design Elements after update Realization
added_subordinates(OF) num_added_subordinates Added Subordinate Design Element tags after update Realization
num_updated_subordinates(O) Number of updated Subordinate Design Elements after update Realization
updated_subordinates(OF) num_updated_subordinates Updated Subordinate Design Element tags after update Realization
num_removed_subordinates(O) Number of removed Subordinate Design Elements after update Realization
removed_subordinates(OF) num_removed_subordinates Removed Subordinate Design Element tags after update Realization
CPD0CD_API int CPD_update_item_realization2 ( tag_t  reuse_de_tag,
tag_t  item_rev_tag,
logical  sync_effectivity_expressions,
logical  sync_variant_expressions,
logical  update_subordinates,
int *  num_added_subordinates,
tag_t **  added_subordinates,
int *  num_updated_subordinates,
tag_t **  updated_subordinates,
int *  num_removed_subordinates,
tag_t **  removed_subordinates 
)

Updates the Reuse Design Element and optionally its Subordinates in a Collaborative Design using the provided source Item Assembly. The returned codes are:

  • ITK_ok on success.
  • MDLOMODEL_object_has_no_status in case where the source Item Revision is not having a release status.
Parameters
reuse_de_tag(I) Reuse Design Element Tag
item_rev_tag(I) Optional Tag of the Item Revision for the source Item Assembly needed if new Source Assembly is selected for update
sync_effectivity_expressions(I) Flag set to true to update Effectivity Expressions on Reuse Design Element structure
sync_variant_expressions(I) Flag set to true to update Variant Expressions on Reuse Design Element structure
update_subordinates(I) Flag set to true to update Subordinate Design Elements else set to false
num_added_subordinates(O) Number of added Subordinate Design Elements after update Realization
added_subordinates(OF) num_added_subordinates Added Subordinate Design Element tags after update Realization
num_updated_subordinates(O) Number of updated Subordinate Design Elements after update Realization
updated_subordinates(OF) num_updated_subordinates Updated Subordinate Design Element tags after update Realization
num_removed_subordinates(O) Number of removed Subordinate Design Elements after update Realization
removed_subordinates(OF) num_removed_subordinates Removed Subordinate Design Element tags after update Realization