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

Architecture
[Repeatable Digital Validation]

Data Structures

Defines

Typedefs

Functions

Define Documentation

#define ARCH_CLASS_NAME   "Architecture"

Definition at line 27 of file arch.h.

#define ARCH_gcid_size_c   132

Definition at line 52 of file arch.h.

#define ARCH_MASTER_CLASS_NAME   "ArchitectureMaster"

Definition at line 35 of file arch.h.

#define ARCH_REV_CLASS_NAME   "ArchitectureRevision"

Definition at line 31 of file arch.h.

#define ARCH_REV_MASTER_CLASS_NAME   "ArchitectureVersionMaster"

Definition at line 36 of file arch.h.

#define ARCH_REV_TYPE_NAME   ARCH_REV_CLASS_NAME

Definition at line 32 of file arch.h.

#define ARCH_TYPE_NAME   ARCH_CLASS_NAME

Definition at line 28 of file arch.h.

#define ArchClassName   ARCH_CLASS_NAME

Definition at line 29 of file arch.h.

#define ArchRevisionClassName   ARCH_REV_CLASS_NAME

Definition at line 33 of file arch.h.

#define GENERIC_COMPONENT_ID   "generic_component_id"

Definition at line 49 of file arch.h.

#define HAS_BASEDON_PREEXIST_ELEMNT   "has_basedon_preexist_elemnt"

Definition at line 45 of file arch.h.

#define HAS_CONSISTENT_NVES   "has_consistent_nves"

Definition at line 41 of file arch.h.

#define HAS_HIERARCHICAL_VARIABILTY   "has_hierarchical_variabilty"

Definition at line 42 of file arch.h.

#define HAS_SHARED_NVES   "has_shared_nves"

Definition at line 44 of file arch.h.

#define IS_PARTIAL_BREAKDOWN   "is_partial_breakdown"

Definition at line 43 of file arch.h.

#define ITEM_ID   "item_id"

Definition at line 47 of file arch.h.

#define OBJECT_DESC   "object_desc"

Definition at line 50 of file arch.h.

#define OBJECT_NAME   "object_name"

Definition at line 48 of file arch.h.

#define TC_GENERIC_ARCHITECTURE   "TC_Generic_Architecture"

Definition at line 38 of file arch.h.

#define TC_INSTANTIATION   "TC_Instantiation"

Definition at line 39 of file arch.h.

Typedef Documentation

typedef struct RDV_goi_optiondata_s RDV_goi_optiondata_t

typedef struct RDV_option_value_pair_s RDV_option_value_pair_t

typedef struct RDV_Optiondata_s RDV_Optiondata_t

Function Documentation

RDV_API int ARCH_add_arch_element ( tag_t  window,
tag_t  parent_bom_line,
tag_t  item,
tag_t *  new_apprpathnode 
)

Parameters:
window  (I)
parent_bom_line  (I)
item  (I)
new_apprpathnode  (O)

RDV_API int ARCH_add_named_variant_expr ( tag_t  arch_rev,
char *  code,
char *  description,
tag_t  variant_expression,
logical  ignore_duplicate,
logical  implicit_save,
int *  n_tags_to_save,
tag_t **  tags_to_save,
tag_t *  newNVETag 
)

RDV_API int ARCH_add_nve_from_formula ( tag_t  archrev_or_bomline,
char *  code,
char *  description,
const char *  productName,
const char *  productNamespace,
const char *  formula,
logical  ignore_duplicate,
logical  implicit_save,
int *  n_tags_to_save,
tag_t **  tags_to_save,
tag_t *  newNVETag 
)

RDV_API int ARCH_ask_all_struct_state_parameters ( tag_t  arch_tag,
logical *  has_consistent_nves,
logical *  has_heirarchical_variability,
logical *  has_partial_breakdown,
logical *  has_shared_nves,
logical *  has_based_on_preexist_elements 
)

Parameters:
arch_tag  (I)
has_consistent_nves  (O)
has_heirarchical_variability  (O)
has_partial_breakdown  (O)
has_shared_nves  (O)
has_based_on_preexist_elements  (O)

RDV_API int ARCH_ask_gcid ( tag_t  arch_item,
char  gcid[ARCH_gcid_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ARCH_ask_gcid2
Parameters:
arch_item  (I)
gcid  (O)

RDV_API int ARCH_ask_gcid2 ( tag_t  arch_item,
char **  gcid 
)

Parameters:
arch_item  (I)
gcid  (OF)

RDV_API int ARCH_ask_named_variant_exprs ( tag_t  arch,
int *  no_of_nves,
tag_t **  named_variant_expressions 
)

Parameters:
arch  (I)
no_of_nves  (O)
named_variant_expressions  (O)

RDV_API int ARCH_ask_usages_of_arch_apn ( tag_t  arch_apn,
tag_t  top_arch_rev,
int *  n_usages,
tag_t **  usage_apns 
)

Parameters:
arch_apn  (I)
top_arch_rev  (I)
n_usages  (O)
usage_apns  (OF) n_usages

RDV_API int ARCH_ask_veb ( tag_t  arch_item,
tag_t *  veb 
)

Parameters:
arch_item  (I)
veb  (O)

RDV_API int ARCH_carry_over_defs_and_rulechecks ( tag_t  source_topline,
tag_t  tgt_topline 
)

RDV_API int ARCH_carry_over_nves ( tag_t  src_bomline_tag,
tag_t  tgt_bomline_tag 
)

RDV_API int ARCH_carry_over_partsols ( tag_t  src_bomline_tag,
tag_t  tgt_bomline_tag 
)

RDV_API int ARCH_carry_over_variability ( tag_t  src_bomline_tag,
tag_t  tgt_bomline_tag 
)

RDV_API int ARCH_clear_auditreport ( tag_t  report_tag  ) 

RDV_API int ARCH_closeTargetWindow ( tag_t  report_tag  ) 

RDV_API int ARCH_create_arch ( const char *  id,
const char *  revId,
const char *  type,
const char *  name,
const char *  gcid,
const char *  desc,
tag_t *  newArch,
tag_t *  newArchRev 
)

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
id  (I)
revId  (I)
type  (I)
name  (I)
gcid  (I)
desc  (I)
newArch  (O)
newArchRev  (O)

RDV_API int ARCH_create_arch_with_struct_info ( const char *  id,
const char *  rev_id,
const char *  type,
const char *  name,
const char *  gc_id,
const char *  desc,
logical  has_consistent_nves,
logical  has_heirarchical_variability,
logical  has_partial_breakdown,
logical  has_shared_nves,
tag_t *  new_arch,
tag_t *  rev 
)

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
id  (I)
rev_id  (I)
type  (I)
name  (I)
gc_id  (I)
desc  (I)
has_consistent_nves  (I)
has_heirarchical_variability  (I)
has_partial_breakdown  (I)
has_shared_nves  (I)
new_arch  (O)
rev  (O)

RDV_API int ARCH_create_generic_object ( const char *  id,
const char *  rev_id,
const char *  type,
const char *  name,
const char *  gc_id,
const char *  desc,
logical  has_consistent_nves,
logical  has_heirarchical_variability,
logical  has_partial_breakdown,
logical  has_shared_nves,
logical  has_based_on_preexist_elements,
tag_t  instantiating_arch,
tag_t *  new_go,
tag_t *  rev 
)

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
id  (I)
rev_id  (I)
type  (I)
name  (I)
gc_id  (I)
desc  (I)
has_consistent_nves  (I)
has_heirarchical_variability  (I)
has_partial_breakdown  (I)
has_shared_nves  (I)
has_based_on_preexist_elements  (I)
instantiating_arch  (I)
new_go  (O)
rev  (O)

RDV_API int ARCH_create_generic_object2 ( const char *  item_type,
int  numAttrs,
char **  attrNames,
char **  attrValues,
const char *  rev_id,
tag_t  instantiating_arch,
tag_t *  item,
tag_t *  rev 
)

This function allows creating an Arch type item with the given input arguments which includes attribute names and their values. Below are the attribute names which are passed to ARCH_create_generic_object2 "item_id" "object_name" "generic_component_id" "object_desc" "has_consistent_nves" "has_hierarchical_variabilty" "is_partial_breakdown" "has_shared_nves" "has_basedon_preexist_elemnt"

Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
item_type  (I) Type of Item to be created
numAttrs  (I) Number of input attributes
attrNames  (I) Names of input attributes
attrValues  (I) Values for the input attributes
rev_id  (I) Id for the revision
instantiating_arch  (I) tag of instantiating_arch ,NULL is allowed
item  (O) The created item tag
rev  (O) The created item revision tag

RDV_API int ARCH_create_rev ( const char *  item_id,
const char *  revid,
tag_t *  rev 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter 9. In its place, use ITEM_create_rev.
Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters:
item_id  (I)
revid  (I)
rev  (O)

RDV_API int ARCH_deep_copy_arch ( tag_t  tgt_bomline_tag,
tag_t  src_bomline_tag,
int  flag_value 
)

RDV_API int ARCH_determine_installation_assy ( tag_t  apn,
int *  count,
tag_t **  itemrev_tags 
)

Parameters:
apn  (I)
count  (O)
itemrev_tags  (OF) count

RDV_API int ARCH_find_arch ( const char *  gc_id,
const char *  type,
int *  count,
tag_t **  tags 
)

Parameters:
gc_id  (I)
type  (I)
count  (O)
tags  (OF) count

RDV_API int ARCH_find_arch_apn ( tag_t  arch_tag,
tag_t  topItem,
int *  count,
tag_t **  apn 
)

Parameters:
arch_tag  (I)
topItem  (I)
count  (O)
apn  (OF) count

RDV_API int ARCH_find_create_qualified_appgrp ( tag_t  appgrp,
tag_t  top_arch_rev,
tag_t *  new_appgrp 
)

Parameters:
appgrp  (I)
top_arch_rev  (I)

RDV_API int ARCH_find_named_variant_expr ( tag_t  arch_rev,
const char *  code,
const char *  desc,
int  n_options,
const tag_t *  options,
int  n_values,
const int *  opcodes,
const char **  values,
int *  n_found_nves,
tag_t **  found_nves 
)

Finds named variant expressions by code and/or description and/or variants and/or expression literals

        n_options = 4;
        options[0] = opt1;
        options[1] = opt2;
        options[2] = opt3;
        options[3] = opt4;
        n_values = 3;
        opcodes[0] = 1005;
        opcodes[1] = -1;
        opcodes[2] = 1006;
        values[0]  = "0";
        values[1]  = NULL;
        values[2]  = "1";

is the same as calling it with

        n_options = 4;
        options[0] = opt1;
        options[1] = opt3;
        options[2] = opt2;
        options[3] = opt4;
        n_values = 2;
        opcodes[0] = 1005;
        opcodes[1] = 1006;
        values[0]  = "0";
        values[1]  = "1";

In both cases the function will return all named variant conditions on arch_item that

  • contain the variant expression literal "opt1 == value_at_index_0" AND
  • contain the variant expression literal "opt3 != value_at_index_1" AND
  • vary by option opt2 AND
  • vary by option opt4
Parameters:
arch_rev  (I)
code  (I)
desc  (I)
n_options  (I)
options  (I)
n_values  (I)
opcodes  (I)
values  (I)
n_found_nves  (O)
found_nves  (OF) n_found_nves

RDV_API int ARCH_find_qualified_appgrp ( tag_t  apn_tag,
tag_t  top_arch_rev,
logical *  is_shared,
tag_t *  appgrp 
)

Parameters:
apn_tag  (I)
top_arch_rev  (I)
is_shared  (O)

RDV_API int ARCH_get_associated_data ( tag_t  arch_item,
tag_t  top_item,
int *  node_count,
tag_t **  nodes,
int *  ia_count,
tag_t **  iaRevs,
int *  no_of_nves,
tag_t **  nve_tags 
)

Parameters:
arch_item  (I)
top_item  (I)
node_count  (O)
nodes  (OF) node_count
ia_count  (O)
iaRevs  (OF) ia_count
no_of_nves  (O)
nve_tags  (OF) no_of_nves

RDV_API int ARCH_get_nve_count ( tag_t  arch_rev,
const char *  code,
const char *  desc,
int  n_options,
const tag_t *  options,
int  n_values,
const int *  opcodes,
const char **  values,
int *  n_found_nves 
)

RDV_API int ARCH_get_nves ( tag_t  apn,
tag_t  top_line_bvr,
int *  nve_count,
tag_t **  nves 
)

Parameters:
apn  (I)
top_line_bvr  (I)
nve_count  (O)
nves  (OF) nve_count

RDV_API int ARCH_get_options_optionvalues_for_goi ( int *  n_items,
RDV_Optiondata_t **  goi_optiondata 
)

RDV_API int ARCH_getAuditData ( tag_t  pReport,
tag_t  auditedLineTag,
tag_t *  bom_line,
int *  n_occurrences,
tag_t **  occurrences,
int **  occmatch_types,
int **  occmatch_info,
char **  occ_nve_desc,
char **  occ_pnum_desc,
char **  occ_qty_desc,
int *  overall_match_info,
char **  nve_match_desc,
char **  pnum_match_desc,
char **  qty_match_desc,
char **  audit_line_summary,
char **  audit_score 
)

RDV_API int ARCH_getAuditedLines ( int  n_nodes,
tag_t *  nodes,
tag_t  rev_rule_tag,
tag_t  var_rule_tag,
int *  noOfAuditedLines,
tag_t **  targetAuditedLineTags 
)

RDV_API int ARCH_getDesignAuditData ( tag_t  pReport,
tag_t  auditedLineTag,
tag_t *  bom_line,
int *  n_occurrences,
tag_t **  occurrences,
int **  occmatch_types,
int **  occmatch_info,
char **  occ_nve_desc,
char **  occ_pnum_desc,
char **  occ_qty_desc,
int *  overall_match_info,
char **  nve_match_desc,
char **  pnum_match_desc,
char **  qty_match_desc,
char **  audit_line_summary,
char **  audit_score 
)

RDV_API int ARCH_has_consistent_nves ( tag_t  arch_tag,
logical *  has_consistent_nves 
)

Parameters:
arch_tag  (I)
has_consistent_nves  (O)

RDV_API int ARCH_has_heirarchical_variability ( tag_t  arch_tag,
logical *  has_heirarchical_variability 
)

Parameters:
arch_tag  (I)
has_heirarchical_variability  (O)

RDV_API int ARCH_has_partial_breakdown ( tag_t  arch_tag,
logical *  has_partial_breakdown 
)

Parameters:
arch_tag  (I)
has_partial_breakdown  (O)

RDV_API int ARCH_has_preexist_break_elemnts ( tag_t  arch_tag,
logical *  has_preexist_break_elemnts 
)

Parameters:
arch_tag  (I)
has_preexist_break_elemnts  (O)

RDV_API int ARCH_has_shared_nves ( tag_t  arch_tag,
logical *  has_shared_nve 
)

Parameters:
arch_tag  (I)
has_shared_nve  (O)

RDV_API int ARCH_is_architecture ( tag_t  arch_tag,
logical *  isArch 
)

Parameters:
arch_tag  (I)
isArch  (O)

RDV_API int ARCH_is_generic_object ( tag_t  arch_tag,
logical *  is_generic_object 
)

Parameters:
arch_tag  (I)
is_generic_object  (O)

RDV_API int ARCH_is_toplevel ( tag_t  arch_tag,
logical *  isTop 
)

Parameters:
arch_tag  (I)
isTop  (I)

RDV_API int ARCH_paste ( tag_t  selectedSourceItem,
tag_t  targetItem,
logical  processChildren 
)

Parameters:
targetItem  < (I) Tag of an existing Generic Object>
processChildren  < (I) Tag of target for paste action> < (I) Determine whether to include children in paste>

RDV_API int ARCH_paste_bomline ( tag_t  selectedSourceBOMline,
tag_t  targetBOMLineToBeUsed,
tag_t  sourceBOMLineToBeUsed,
int  noOfSourceParentBOMLines,
tag_t *  sourceParentBomlines,
logical  processParents,
logical  processChildren 
)

Parameters:
selectedSourceBOMline  (I) Tag of bomline of an existing Generic Object
targetBOMLineToBeUsed  (I) Tag of bomline of target for paste action
sourceBOMLineToBeUsed  (I) Tag of bomline to use in copy/paste
noOfSourceParentBOMLines  (I) number of parent bomlines
sourceParentBomlines  (I) Array of parent bomlines of selectedSourceBOMline
processParents  (I) Determine whether to include parents in paste
processChildren  (I) Determine whether to include children in paste

RDV_API int ARCH_rev_ask_product_items ( tag_t  arch_rev,
int *  n_product_items,
tag_t **  product_items 
)

Parameters:
arch_rev  (I)
n_product_items  (O)
product_items  (OF) n_product_items

RDV_API int ARCH_revise_arch ( tag_t  revTag,
const char *  revisionId,
const char *  name,
const char *  description,
logical  deepCopyRequired,
int  count,
const ITEM_deepcopy_info_t *  CopyInfo,
int *  deepCopiedCount,
tag_t **  deepCopiedTags,
tag_t **  deepCopiedTypeTags,
tag_t *  newRevTag,
tag_t *  itemRevType 
)

RDV_API int ARCH_save_as ( tag_t  sourceItem,
tag_t  sourceItemRevision,
const char *  new_item_id,
const char *  new_item_rev,
const char *  gcid,
const char *  name,
const char *  description,
tag_t *  newItem 
)

Parameters:
sourceItem  (I) Tag of an existing Generic Object Item
sourceItemRevision  (I) Tag of revision to use, if null use the latest rev
new_item_id  (I) A null is allowed
new_item_rev  (I) A null is allowed
gcid  (I) A null is allowed
name  (I) A null is allowed
description  (I) A null is allowed
newItem  (O) Tag for identifying the new Generic Object

RDV_API int ARCH_save_as_arch ( tag_t  rev_tag,
const char *  id,
const char *  revId,
const char *  type,
const char *  name,
const char *  gcid,
const char *  desc,
tag_t *  newArch,
tag_t *  newArchRev 
)

RDV_API int ARCH_save_as_rev ( const char *  item_id,
const char *  revid,
const char *  gcId,
const char *  itemType,
tag_t *  rev 
)

Deprecated:
This function is deprecated, it will be removed from Teamcenter 9 In its place, use ITEM_create_rev.
Note:
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

RDV_API int ARCH_set_all_struct_state_parameters ( tag_t  arch_tag,
logical  has_consistent_nves,
logical  has_heirarchical_variability,
logical  has_partial_breakdown,
logical  has_shared_nves,
logical  has_based_on_preexist_elements 
)

Parameters:
arch_tag  (I)
has_consistent_nves  (I)
has_heirarchical_variability  (I)
has_partial_breakdown  (I)
has_shared_nves  (I)
has_based_on_preexist_elements  (I)

RDV_API int ARCH_set_consistent_nves ( tag_t  arch_tag,
logical  set_consistent_nves 
)

Parameters:
arch_tag  (I)
set_consistent_nves  (I)

RDV_API int ARCH_set_gcid ( tag_t  arch_item,
const char *  gcid 
)

Parameters:
arch_item  (I)
gcid  (I)

RDV_API int ARCH_set_heirarchical_variability ( tag_t  arch_tag,
logical  set_heirarchical_variability 
)

Parameters:
arch_tag  (I)
set_heirarchical_variability  (I)

RDV_API int ARCH_set_partial_breakdown ( tag_t  arch_tag,
logical  set_partial_breakdown 
)

Parameters:
arch_tag  (I)
set_partial_breakdown  (I)

RDV_API int ARCH_set_shared_nves ( tag_t  arch_tag,
logical  set_shared_nves 
)

Parameters:
arch_tag  (I)
set_shared_nves  (I)

RDV_API int ARCH_set_veb ( tag_t  arch_item,
tag_t  veb 
)

Parameters:
arch_item  (I)
veb  (O)

RDV_API int RDV_add_part_solution_to_ABEorGBE ( tag_t  component,
tag_t  abe,
int  prodRevCount,
tag_t *  prodRevTags,
tag_t  abeApnTag,
int  n_authNVEs,
tag_t *  authNVEs,
int  quantity,
int  n_noteTexts,
char **  noteTypes,
char **  noteTexts,
tag_t *  partSolutionAPN 
)

RDV_API int RDV_create_svr ( tag_t  drule,
const char *  name,
const char *  description,
int  nOptions,
tag_t *  variants,
const char **  values,
tag_t  itemRev,
const char *  relationType,
tag_t *  vrule 
)

RDV_API int RDV_find_abe_in_ab_assem ( tag_t  bom_win_tag,
char *  gc_id,
logical *  valid_abe 
)

RDV_API int RDV_get_go_part_solutions ( tag_t  go_bomline,
int *  lou_num,
tag_t **  lou_bomline_tags,
tag_t *  bom_window_tag 
)

RDV_API int RDV_get_lou_bomline ( tag_t  bomwindow,
tag_t  top_rev_tag,
char *  gc_id,
logical  is_arch,
int *  num_part,
tag_t **  part_bomline_list 
)