Return Value | Description | |
ITEM_cant_change_uom | Item's Unit Of Measure (UOM) is not modifiable by you. This is the basic error returned on failure. Examination of the error stack will show you one of the following errors:
ITEM_used_in_structure - Unit of measure cannot be modified as the Item is used within a structure. | |
ITEM_duplicate_rev | Item already has a revision with the rev ID you gave. |
#define ITEM_revise_and_relate_to_latest "revise_and_relate_to_latest" |
typedef struct ITEM_attached_object_s ITEM_attached_object_t |
typedef struct ITEM_attached_object_tag_s ITEM_attached_object_tag_t |
typedef enum ITEM_attachment_type_e ITEM_attachment_type_t |
typedef struct ITEM_deepcopy_info_s ITEM_deepcopy_info_t |
TCCORE_API int ITEM_ask_attachment_name | ( | tag_t | attachment_type, | |
char ** | name | |||
) |
DEPRECATED FUNCTION
attachment_type | (I) |
name | (OF) |
TCCORE_API int ITEM_ask_description | ( | tag_t | item, | |
char | item_desc[ITEM_desc_size_c+1] | |||
) |
item | (I) Tag of an Item |
item_desc | (O) Description of an Item |
TCCORE_API int ITEM_ask_description2 | ( | tag_t | item, | |
char ** | item_desc | |||
) |
This function will get the description of the Item.
item | (I) Tag of an Item |
item_desc | (OF) Description of an Item |
Used to determine whether or not an item has any item revisions that are modules.
item | (I) The item being queried |
is_module | (O) True if the item has a module, otherwise false |
TCCORE_API int ITEM_ask_id | ( | tag_t | item, | |
char | item_id[ITEM_id_size_c+1] | |||
) |
Id in Context = NO: Returns Item.item_id.
Id in Context = YES: Returns Item.item_id.
item | (I) Tag of an Item |
item_id | (O) ID of an Item |
TCCORE_API int ITEM_ask_id2 | ( | tag_t | item, | |
char ** | item_id | |||
) |
This function will get the Item ID of the Item.
Id in Context = NO: Returns Item.item_id.
Id in Context = YES: Returns Item.item_id.
item | (I) Tag of an Item |
item_id | (OF) ID of an Item |
Used to determine whether or not an item is a variant item.
item | (I) The item being queried |
is_vi | (O) True if the item is a variant item, otherwise false |
This function will return the tag of the Item to which the revision belongs to.
rev | (I) Tag of a revision |
item | (O) Tag of the Item of the specific revision tag |
This function will return the latest revision of an Item.
item | (I) Tag of an existing Item |
rev | (O) Tag of the latest revision of Item |
TCCORE_API int ITEM_ask_name | ( | tag_t | item, | |
char | item_name[ITEM_name_size_c+1] | |||
) |
item | (I) Tag of an Item |
item_name | (O) Name of an Item |
TCCORE_API int ITEM_ask_name2 | ( | tag_t | item, | |
char ** | item_name | |||
) |
This function will get the name of the Item.
item | (I) Tag of an Item |
item_name | (OF) Name of an Item |
TCCORE_API int ITEM_ask_rev_description | ( | tag_t | rev, | |
char | rev_desc[ITEM_desc_size_c+1] | |||
) |
rev | (I) Tag of an Item Revision |
rev_desc | (O) Description of an Item |
TCCORE_API int ITEM_ask_rev_description2 | ( | tag_t | rev, | |
char ** | rev_desc | |||
) |
This function will get the description of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_desc | (OF) Description of an Item |
TCCORE_API int ITEM_ask_rev_id | ( | tag_t | rev, | |
char | rev_id[ITEM_id_size_c+1] | |||
) |
rev | (I) Tag of an Item Revision |
rev_id | (O) ID of the Item Revision |
TCCORE_API int ITEM_ask_rev_id2 | ( | tag_t | rev, | |
char ** | rev_id | |||
) |
This function will get the ID of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_id | (OF) ID of the Item Revision |
TCCORE_API int ITEM_ask_rev_name | ( | tag_t | rev, | |
char | rev_name[ITEM_name_size_c+1] | |||
) |
rev | (I) Tag of an Item Revision |
rev_name | (O) Name of the Item Revision |
TCCORE_API int ITEM_ask_rev_name2 | ( | tag_t | rev, | |
char ** | rev_name | |||
) |
This function will get the name of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_name | (OF) Name of the Item Revision |
TCCORE_API int ITEM_ask_rev_type | ( | tag_t | rev, | |
char | rev_type[ITEM_type_size_c+1] | |||
) |
rev | (I) Tag of an Item Revision |
rev_type | (O) Type of an Item Revision |
TCCORE_API int ITEM_ask_rev_type2 | ( | tag_t | rev, | |
char ** | rev_type | |||
) |
This function will get the type of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_type | (OF) Type of an Item Revision |
Returns the variant expression block associated with the specified Item Revision.
rev | (I) Tag of an Item Revision |
variant_expression_block | (O) Tag of the variant expression block |
TCCORE_API int ITEM_ask_type | ( | tag_t | item, | |
char | item_type[ITEM_type_size_c+1] | |||
) |
item | (I) Tag of an Item |
item_type | (O) Type of an Item |
TCCORE_API int ITEM_ask_type2 | ( | tag_t | item, | |
char ** | item_type | |||
) |
This function will get the type of the Item.
item | (I) Tag of an Item |
item_type | (OF) Type of an Item |
Enquires the unit of measure in which quantities of this Item must be expressed. Units of measure are objects defined for the Teamcenter Engineering site by the system administrator.
By default, Items have no Unit of Measure (UOM). In this case this function will give NULLTAG. This implies that quantities of such Items are expressed in terms of "Each" or "Pieces". In other words they refer to a discrete number of component parts. In PSE if no specific quantity value is associated with the use of such Items, the default quantity is assumed to be "1 component".
item | (I) Tag of an Item |
uom | (O) Returns the tag of the unit of measure assigned to this Item (may be NULLTAG) |
TCCORE_API int ITEM_attach_object | ( | tag_t | item, | |
tag_t | object, | |||
ITEM_attachment_type_t | attachment_type | |||
) |
DEPRECATED FUNCTION This function will attach an object to an Item with a specific attachment type.
item | (I) Tag of an existing Item. The Item and object must already be saved for this function to succeed. |
object | (I) Tag of the object that we want to attach to the Item |
attachment_type | (I) Attachment type |
DEPRECATED FUNCTION
item | (I) |
object | (I) |
attachment_type | (I) |
TCCORE_API int ITEM_attach_rev_object | ( | tag_t | rev, | |
tag_t | object, | |||
ITEM_attachment_type_t | attachment_type | |||
) |
DEPRECATED FUNCTION This function will attach an object to the Item Revision with specified attachment type.
rev | (I) Tag of an existing Item Revision. The Item Revision and object must have already been saved for this function to succeed. |
object | (I) Tag of the object that we want to attach to the Item. |
attachment_type | (I) Attachment type. |
DEPRECATED FUNCTION
rev | (I) |
object | (I) |
attachment_type | (I) |
TCCORE_API int ITEM_baseline_rev | ( | tag_t | rev, | |
const char * | new_rev_id, | |||
const char * | desc, | |||
const char * | rel_proc_name, | |||
const char * | jobName, | |||
const char * | jobDescription, | |||
tag_t * | new_rev_tag, | |||
int * | deepCopiedObjCount, | |||
tag_t ** | deepCopiedObjs | |||
) |
This ITK creates a Baseline Revision for the input Item Revision only. BOMView Revisions attached to the ItemRevision will be copied forward to the new baseline Revision as per deep copy rules. If the baseline_rev_id is empty, then the ITK would generate a Baseline Revision ID using the USER_new_revision_id_from_alt_rule ("PDR", , , , ,) user_exit. The description entered would be set as the description of the Baseline Revision. Once the creation of the Baseline Revision is completed, the Baseline Revision would undergo the release process as given by the rel_proc_name.
rev | (I) Item Revision that needs to be Baselined |
new_rev_id | (I) The Revision Id of the Baseline Item Revision |
desc | (I) Description that needs to be set on the Baseline Item Revision |
rel_proc_name | (I) Name of the Release Procedure through which the Baseline Revision should under go |
jobName | (I) Name of the Job |
jobDescription | (I) Description of the Job |
new_rev_tag | (O) Item Revision Tag of the Baseline Revision created |
deepCopiedObjCount | (O) |
deepCopiedObjs | (OF) deepCopiedObjCount |
TCCORE_API void ITEM_build_exclude_list | ( | int | array_length, | |
tag_t * | exclude_array | |||
) |
array_length | (I) |
exclude_array | (I) |
TCCORE_API int ITEM_copy_item | ( | tag_t | rev, | |
const char * | new_item_id, | |||
const char * | new_rev_id, | |||
tag_t * | new_item, | |||
tag_t * | new_rev | |||
) |
Creates a new Item based on an existing Item. The initial revision of the new Item is based on the specified revision of the existing Item.
rev | (I) Tag of an existing revision on which to base the new Item and its initial revision |
new_item_id | (I) Identification string (ID) of the new Item. A null is allowed. If null, the system will automatically generate an Item ID. |
new_rev_id | (I) Identification string (revision ID) the initial revision of the new Item. A null is allowed. If null, the system will automatically generate a new revision ID. |
new_item | (O) Tag of the new Item |
new_rev | (O) Tag of the initial revision of the new Item |
TCCORE_API int ITEM_copy_item_with_masters | ( | tag_t | rev, | |
const char * | new_item_id, | |||
const char * | new_rev_id, | |||
tag_t | item_master_form_tag, | |||
tag_t | item_rev_master_form_tag, | |||
tag_t * | new_item, | |||
tag_t * | new_rev | |||
) |
Creates a new Item based on an existing Item. Similar to ITEM_copy_item, except that you can pass pre-populated Item Master and Item Revision Master forms. These forms will be used for the Item and Item Revision. They can be NULLTAG.
The initial revision of the new Item is based on the specified revision of the existing Item.
rev | (I) Tag of an existing revision on which to base the new Item and its initial revision |
new_item_id | (I) Identification string (ID) of the new Item. A null is allowed. If null, the system will automatically generate an Item ID. |
new_rev_id | (I) Identification string (revision ID) the initial revision of the new Item. A null is allowed. If null, the system will automatically generate a new revision ID. |
item_master_form_tag | (I) Item Master form tag that will be used for the created item. Can be NULLTAG |
item_rev_master_form_tag | (I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG |
new_item | (O) Tag of the new Item |
new_rev | (O) Tag of the initial revision of the new Item |
Produces a new revision based on a specified revision of the same Item. This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.
rev | (I) Tag of an existing Item |
new_rev_id | (I) A null is allowed. If null, the system will generate a revision ID |
new_rev_tag | (O) Tag for identifying the new Item Revision in the current program |
TCCORE_API int ITEM_copy_rev_using | ( | tag_t | rev, | |
const char * | new_rev_id, | |||
const int | option_count, | |||
ITEM_deepcopy_info_t * | user_options, | |||
tag_t * | new_rev, | |||
int * | count, | |||
tag_t ** | deep_copied_objects | |||
) |
Produces a new revision based on a specified revision of the same Item. This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.
rev | (I) Tag of an existing Item |
new_rev_id | (I) A null is allowed. If null, the system will generate a revision ID |
option_count | (I) The number of objects passed as user_options |
user_options | (I) The deep copy options |
new_rev | (O) Tag for identifying the new Item Revision in the current program |
count | (O) Count of deep copied objects |
deep_copied_objects | (OF) Tags for newly created objects during deep copy |
TCCORE_API int ITEM_copy_rev_with_master | ( | tag_t | rev, | |
const char * | new_rev_id, | |||
tag_t | item_rev_master_form_tag, | |||
tag_t * | new_rev_tag | |||
) |
Produces a new revision based on a specified revision of the same Item. Similar to ITEM_copy_rev, except that you can pass pre-populated Item Revision Master form. This form will be used for Item Revision. It can be NULLTAG.
This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.
rev | (I) Tag of an existing Item Revision |
new_rev_id | (I) A null is allowed. If null, the system will generate a revision ID |
item_rev_master_form_tag | (I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG |
new_rev_tag | (O) Tag for identifying the new Item Revision in the current program |
TCCORE_API int ITEM_create_ic_baseline_rev | ( | tag_t | rev, | |
tag_t | bom_window, | |||
const char * | copy_rules_key, | |||
const char * | name, | |||
const char * | desc, | |||
const char * | id, | |||
const char * | rev_id, | |||
tag_t * | new_rev | |||
) |
rev | (I) |
bom_window | (I) |
copy_rules_key | (I) |
name | (I) |
desc | (I) |
id | (I) |
rev_id | (I) |
new_rev | (O) |
TCCORE_API int ITEM_create_item | ( | const char * | item_id, | |
const char * | item_name, | |||
const char * | item_type, | |||
const char * | rev_id, | |||
tag_t * | item, | |||
tag_t * | rev | |||
) |
Restrictions:
For a type other than null to be specified, that type must be defined by the site using the install_types utility. If item_type is null, the default type is Item. The item_name will be used as the revision's name.
item_id | (I) Item identification number. No two Items can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID. |
item_name | (I) Item name. A common name or short description of the Item. |
item_type | (I) A null is allowed for this argument. It can be used to specify a defined Item type. |
rev_id | (I) Identification string (revision ID) of the Item Revision being created. A null is allowed. If null, the system will automatically generate a revision ID |
item | (O) Tag for identifying the Item in the current program |
rev | (O) Tag for identifying the Item Revision in the current program |
TCCORE_API int ITEM_create_item2 | ( | const char * | type_name, | |
int | numAttrs, | |||
char ** | attrNames, | |||
char ** | attrValues, | |||
const char * | rev_id, | |||
tag_t * | item, | |||
tag_t * | rev | |||
) |
type_name | (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 |
item | (O) The created item tag |
rev | (O) The created item revision tag |
TCCORE_API int ITEM_create_item_with_masters | ( | const char * | item_id, | |
const char * | item_name, | |||
const char * | item_type, | |||
const char * | rev_id, | |||
tag_t | item_master_form_tag, | |||
tag_t | item_rev_master_form_tag, | |||
tag_t * | item, | |||
tag_t * | rev | |||
) |
item_id | (I) Item identification number. No two Items can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID |
item_name | (I) Item name. A common name or short description of the Item |
item_type | (I) A null is allowed for this argument. It can be used to specify a defined Item type |
rev_id | (I) Identification string (revision ID) of the Item Revision being created. A null is allowed. If null, the system will automatically generate a revision ID |
item_master_form_tag | (I) Item Master form tag that will be used for the created item. Can be NULLTAG |
item_rev_master_form_tag | (I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG |
item | (O) Tag for identifying the Item in the current program |
rev | (O) Tag for identifying the Item Revision in the current program |
TCCORE_API int ITEM_create_item_with_masters2 | ( | const char * | type_name, | |
int | numAttrs, | |||
char ** | attrNames, | |||
char ** | attrValues, | |||
const char * | rev_id, | |||
tag_t | item_master_tag, | |||
tag_t | item_rev_master_tag, | |||
tag_t * | item, | |||
tag_t * | rev | |||
) |
type_name Type of Item to be created numAttrs Number of input attributes attrNames Names of input attributes attrValues Values for the input attributes rev_id Id for the revision item_master_tag Item Master form tag that will be used for the created item item_rev_master_tag Item Rev Master form tag that will be used for the created Item Rev
type_name | (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 |
item_master_tag | (I) Item Master form tag that will be used for the created item |
item_rev_master_tag | (I) Item Rev Master form tag that will be used for the created Item Rev |
item | (O) The created item tag |
rev | (O) The created item revision tag |
item | (I) Tag of an existing Item |
rev_id | (I) A null is allowed. If null, the system will generate a revision ID. |
rev | (O) Tag for identifying the new Item Revision in the current program. |
TCCORE_API int ITEM_create_rev_with_master | ( | tag_t | item, | |
const char * | rev_id, | |||
tag_t | item_rev_master_form_tag, | |||
tag_t * | rev | |||
) |
item | (I) Tag of an existing item |
rev_id | (I) A null is allowed. If null, the system will generate a revision ID |
item_rev_master_form_tag | (I) Item Revision Master form tag that will be used for the created item revision |
rev | (O) Tag for identifying the Item Revision in the current program |
TCCORE_API int ITEM_delete_item | ( | tag_t | item | ) |
This function will delete an Item from the database. Additionally, it will delete all Item revisions and remove all attachments. The attached objects will not be deleted, except for the Item and revision master forms.
item | (I) Tag for identifying the Item in the current program |
TCCORE_API int ITEM_delete_rev | ( | tag_t | rev | ) |
This function will delete the given revision of an Item. This removes all attachments to the revision. The attached objects themselves will not be deleted, except for the master form.
rev | (I) Tag for identifying the Item Revision in the current program |
TCCORE_API int ITEM_detach_object | ( | tag_t | item, | |
tag_t | object, | |||
ITEM_attachment_type_t | attachment_type | |||
) |
DEPRECATED FUNCTION This function will disassociate the object from the Item with the specified attachment type.
item | (I) Tag of an existing Item |
object | (I) Tag of the object that we want to detach from the Item |
attachment_type | (I) Attachment type |
DEPRECATED FUNCTION
item | (I) |
object | (I) |
attachment_type | (I) |
TCCORE_API int ITEM_detach_rev_object | ( | tag_t | rev, | |
tag_t | object, | |||
ITEM_attachment_type_t | attachment_type | |||
) |
DEPRECATED FUNCTION This function will disassociate the object from the Item Revision only for the specified attachment type.
rev | (I) Tag of an existing Item Revision |
object | (I) Tag of an object that you want to detach from the Item |
attachment_type | (I) Attachment type |
DEPRECATED FUNCTION
rev | (I) |
object | (I) |
attachment_type | (I) |
TCCORE_API int ITEM_dryrun_baseline | ( | tag_t | rev, | |
const char * | rel_proc_name, | |||
char ** | logFileName, | |||
char ** | fullLogFileName | |||
) |
This ITK creates a does a dryrun of baseline creation for the input Item Revision. It does not create the baseline but runs through all the pre-conditions, user error checks And places the results in the filename pointed by the logFileName, which is placed at the location pointed to, by the fullLogFileName. If there is any error, the ITK returns the error code, which on the top of the error stack.
rev | (I) Item Revision that needs to be Baselined |
rel_proc_name | (I) Name of the Release Procedure through which the Baseline Revision should under go |
logFileName | (OF) Name of the LogFile Generated |
fullLogFileName | (OF) FullPath of the output logfile, including the logfilename |
TCCORE_API int ITEM_exists | ( | int | num_attributes, | |
const char ** | attribute_names, | |||
const char ** | attribute_values, | |||
logical * | exists | |||
) |
num_attributes | (I) number of attributes |
attribute_names | (I) Attribute Names |
attribute_values | (I) Attribute Values |
exists | (O) true if exists, false otherwise |
TCCORE_API int ITEM_exists_in_domain | ( | const char * | type_name, | |
const int | num_attributes, | |||
const char ** | attribute_names, | |||
const char ** | attribute_values, | |||
logical * | exists | |||
) |
Checks if an internal type(e.g. "Item", "Part" etc.) with the input attribute/value pair is unique in a multifield key (MFK) domain corresponding to the specified internal type name.
This function:
This function returns:
type_name | (I) Internal type_name. It is used to find associated MFK domain. |
num_attributes | (I) Specifies the number of attributes (or properties) for the given type, for which the uniqueness will be checked. |
attribute_names | (I) Internal attribute (or property) names (e.g. "item_id", "object_name") |
attribute_values | (I) Internal attribute (or property) Values . These values uniqueness will be checked in MFK domain. |
exists | (O) Status of the attributes values uniqueness. The returned value will be true if the value already exists in the MFK domain, false otherwise. |
TCCORE_API int ITEM_exit_module | ( | ) |
TCCORE_API int ITEM_extent | ( | int * | count, | |
tag_t ** | item_list | |||
) |
This function will get the list of all the Items in the database.
count | (O) Total number of Items in the database |
item_list | (OF) count List of tags for all the Items in the database |
TCCORE_API int ITEM_extent_rev | ( | int * | count, | |
tag_t ** | list | |||
) |
This function will get the list of all the Item revisions in the database.
count | (O) Total number of Item Revision in the database |
list | (OF) count List of tags for all the Item Revision in the database |
TCCORE_API int ITEM_find | ( | const char * | item_id, | |
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
This function searches the database for all Items with IDs that match the given string. Wildcards may be used. The search will always be case insensitive.
item_id | (I) String to match IDs against |
n_items | (O) Number of matching Items found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_in_idcontext | ( | const char * | id, | |
tag_t | idcontext_tag, | |||
int * | num_items, | |||
tag_t ** | item_tags | |||
) |
Returns all the items that have the given alternate id in context. Uses case-insensitive search and allows wildcards in id. If idcontext_tag is null, it assumes a search across all alternate identifiers of Items in any context as well as Items.
id | (I) Id to be searched for. May include wild cards. |
idcontext_tag | (I) Tag of an IdContext or NULLTAG |
num_items | (O) Number of items for the given id and IdContext |
item_tags | (OF) num_items An array of tags to found Items |
TCCORE_API int ITEM_find_item | ( | const char * | item_id, | |
tag_t * | item | |||
) |
This function will get the tag of the Item identified by the given ID string. ID is the unique key attribute of the Item class.
If no match is found, NULLTAG is given.
If more than one case insensitive match is found, an error is returned. Use ITEM_find in this case.
item_id | (I) ID of an Item |
item | (O) Tag of Item |
TCCORE_API int ITEM_find_item_in_idcontext | ( | const char * | id, | |
tag_t | idcontext_tag, | |||
tag_t * | item_tag | |||
) |
Similar to ITEM_find_in_idcontext except if more than one item found, it returns an error.
id | (I) Id to be searched for. May include wild cards. |
idcontext_tag | (I) Tag of an IdContext or NULLTAG |
item_tag | (O) Tag of found Item |
TCCORE_API int ITEM_find_item_revs_by_key_attributes | ( | int | num_attributes, | |
const char ** | attribute_names, | |||
const char ** | attribute_values, | |||
const char * | rev_id, | |||
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant.
For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.
num_attributes | (I) number of attributes |
attribute_names | (I) Attribute Names |
attribute_values | (I) Attribute Values |
rev_id | (I) Revision ID |
n_items | (O) Number of matching Items found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_item_revs_by_string | ( | const char * | av_string, | |
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given string containing attribute-value pairs in the following format:
attr_1=value_1,attr_2=value_2,...,attr_n=value_n
All attributes in the attribute-value pair string must the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.
Also, the last attribute-value pair in the string must be: rev_id=<revision name>.
The input parameter av_string contains delimited Item attribute-value pairs, and must in the format of:
attr_1=value1,attr_2=value2,...
The default delimiter and separator used in the attribute-value pairs are "," and "=". However, user can define own delimiter and separator using the preference: TC_KEY_STRING_DELIMITER_VALUES.
av_string | (I) delimited Item attribute-value pair string |
n_items | (O) Number of matching ItemsRevisions found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_item_revs_by_string_and_revid | ( | const char * | av_string, | |
const char * | revid, | |||
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given string containing attribute-value pairs. The attributes must be the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.
The input parameter av_string contains delimited Item attribute-value pairs, and must in the format of:
attr_1=value1,attr_2=value2,...
The default delimiter and separator used in the attribute-value pairs are "," and "=". However, user can define own delimiter and separator using the preference: TC_KEY_STRING_DELIMITER_VALUES.
av_string | (I) delimited Item attribute-value pair string |
revid | (I) delimited Item attribute-value pair string |
n_items | (O) Number of matching ItemsRevisions found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_items_by_key_attributes | ( | int | num_attributes, | |
const char ** | attribute_names, | |||
const char ** | attribute_values, | |||
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
This function searches the database for all Items and returns a list of item tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the item class. Currently, only "item_id" attribute should be used.
num_attributes | (I) number of attributes |
attribute_names | (I) Attribute Names |
attribute_values | (I) Attribute Values |
n_items | (O) Number of matching Items found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_items_by_string | ( | const char * | av_string, | |
int * | n_items, | |||
tag_t ** | item_tags | |||
) |
av_string | (I) delimited Item attribute-value pair string |
n_items | (O) Number of matching Items found |
item_tags | (OF) n_items Array of tags of found Items |
TCCORE_API int ITEM_find_rev | ( | const char * | item_id, | |
const char * | rev_id, | |||
tag_t * | rev_tag | |||
) |
This function will return the tag of a specific Item Revision. Use ITEM_find_revision instead if you already have the tag of the Item, it will be a slightly quicker query.
item_id | (I) Item ID |
rev_id | (I) Item Revision ID |
rev_tag | (O) Tag of the Item Revision |
This function will return the tag of a specific Item Revision. It should be used in preference to ITEM_find_rev when you already have the tag of the Item.
If more than one match (case insensitive) is found, an error is returned. Use ITEM_find_revisions in this case.
item | (I) Tag of the Item |
rev_id | (I) Item Revision ID |
rev_tag | (O) Tag of the Item Revision |
TCCORE_API int ITEM_find_revisions | ( | tag_t | item, | |
const char * | rev_id, | |||
int * | n_revs, | |||
tag_t ** | rev_tags | |||
) |
This function searches the database for all Item Revisions (of the given Item) with IDs that match the given string. Wildcards may be used. The search will always be case insensitive.
item | (I) Tag of the Item |
rev_id | (I) Item Revision ID |
n_revs | (O) Number of matching Revisions found |
rev_tags | (OF) n_revs Array of tags of found Revisions |
TCCORE_API int ITEM_find_revs_in_idcontext | ( | const char * | id, | |
const char * | rev_id, | |||
tag_t | idcontext_tag, | |||
int * | num_revs, | |||
tag_t ** | rev_tags | |||
) |
Returns all supplemental revisions (Identifiers) that have the given id and revision id in specified IdContext. Uses case-insensitive search and allows wildcards in id. If idcontext_tag is null, it assumes a search across all alternate identifiers of Items as well as Items.
id | (I) Id for an item |
rev_id | (I) Id for an item revision |
idcontext_tag | (I) Tag of an IdContext or NULLTAG |
num_revs | (O) Number of item revisions with the given id, rev_id, and IdContext |
rev_tags | (OF) num_revs An array of tags to supplemental revisions (Identifiers) |
TCCORE_API void ITEM_free_exclude_list | ( | ) |
TCCORE_API void ITEM_get_exclude_list | ( | int * | count, | |
tag_t ** | exclude_list | |||
) |
count | (O) |
exclude_list | (OF) count |
TCCORE_API int ITEM_id_exists | ( | const char * | id, | |
logical * | verdict | |||
) |
Checks if any item exists with the given id. If Id in Context is not implemented, it checks for Items as well as all alternate identifiers of Items. If it is implemented, it checks only the Items.
id | (I) Id for an item |
verdict | (O) TRUE if an Item exists, otherwise FALSE |
TCCORE_API int ITEM_id_owners | ( | const char * | id, | |
int * | num_objs, | |||
tag_t ** | obj_tags | |||
) |
Returns all objects that have the given id. If "Id In Context" is not implemented, then the Items and alternate Identifiers are searched and returned. Otherwise, only Items are searched and returned.
id | (I) Id for an object |
num_objs | (O) Number of objects for the given id |
obj_tags | (OF) num_objs An array of tags to Items and/or Alternate Identifiers |
TCCORE_API int ITEM_init_module | ( | ) |
This function initializes the Item module. You must call it before calling any other ITEM functions.
TCCORE_API int ITEM_list_all_attachments | ( | tag_t | item, | |
int * | count, | |||
ITEM_attached_object_t ** | objects | |||
) |
DEPRECATED FUNCTION This function will return all objects attached to the Item.
item | (I) Tag of an existing Item |
count | (O) Number of attachments found |
objects | (OF) count Objects attached to the Item. The tag of each object and its attachment type can be obtained within the structure defined by ITEM_attached_object_t. |
TCCORE_API int ITEM_list_all_attachments_tag | ( | tag_t | item, | |
int * | count, | |||
ITEM_attached_object_tag_t ** | objects | |||
) |
DEPRECATED FUNCTION
item | (I) |
count | (O) |
objects | (OF) count |
TCCORE_API int ITEM_list_all_rev_attachments | ( | tag_t | rev, | |
int * | count, | |||
ITEM_attached_object_t ** | objects | |||
) |
DEPRECATED FUNCTION This function will return all objects attached to the Item Revision.
rev | (I) Item Revision tag |
count | (O) Number of objects attached to the Item Revision |
objects | (OF) count List of objects related to the Item Revision |
This function will return all Item Revisions attached to a specified Item. All tags returned by this function will be sorted by the Item Revision creation date.
item | (I) Tag of an existing Item |
count | (O) Total number of revisions of the Item |
rev_list | (OF) count Tag list of all the revisions of the Item |
TCCORE_API int ITEM_list_attachs_of_type | ( | tag_t | item, | |
ITEM_attachment_type_t | attachment_type, | |||
int * | count, | |||
ITEM_attached_object_t ** | objects | |||
) |
DEPRECATED FUNCTION This function will return all objects attached to the Item of specific attachment type.
item | (I) Tag of an existing Item |
attachment_type | (I) Type of attachment |
count | (O) Number of objects attached to the Item |
objects | (OF) count Objects attached to the Item. The tag of each object and its attachment type can be obtained within the structure defined by ITEM_attached_object_t. |
TCCORE_API int ITEM_list_attachs_of_type_tag | ( | tag_t | item, | |
tag_t | attachment_type, | |||
int * | count, | |||
tag_t ** | tag_list | |||
) |
DEPRECATED FUNCTION
item | (I) |
attachment_type | (I) |
count | (O) |
tag_list | (OF) count |
This function will return the tags of all bom views related to the Item.
item | (I) Tag of an existing Item |
count | (O) Number of bom view found for the Item |
bv_list | (OF) count Tag list of all the bom views for the Item |
TCCORE_API int ITEM_list_possible_attachments_tag | ( | const char * | obj_type, | |
int * | count, | |||
tag_t ** | attachment_types | |||
) |
DEPRECATED FUNCTION
obj_type | (I) |
count | (O) |
attachment_types | (OF) count |
TCCORE_API int ITEM_list_rev_attachs_of_type | ( | tag_t | rev, | |
ITEM_attachment_type_t | relation_type, | |||
int * | count, | |||
ITEM_attached_object_t ** | objects | |||
) |
DEPRECATED FUNCTION This function will return all objects related to the Item with the specific attachment type.
rev | (I) Item Revision tag |
relation_type | (I) Type of attachment |
count | (O) Number of objects attached to the Item Revision |
objects | (OF) count List of objects attached to the Item Revision |
TCCORE_API int ITEM_perform_deepcopy | ( | tag_t | new_item_rev, | |
char * | operation, | |||
tag_t | parent_item_rev, | |||
int * | count, | |||
tag_t ** | deepcopiedobjects | |||
) |
This ITK Performs the Deep copy of the attachments Based on the deep copy rules specified using the Business Modeler deep copy rule application. This ITK will get the rules from the database and then after processing them performs the deep copy operation.
new_item_rev | (I) The Item Revision Tag to which attachments to be deep copied |
operation |
(I) The Type of operation: ITEM_revise_operation ITEM_saveas_operation |
parent_item_rev | (I) The Item Revision through which is revised to create the new_item_rev |
count | (O) Number of deep copied objects |
deepcopiedobjects | (OF) count Array of deep copied objects |
TCCORE_API int ITEM_perform_deepcopy_using | ( | tag_t | new_item_rev, | |
char * | operation, | |||
tag_t | parent_item_rev, | |||
const int | option_count, | |||
const tag_t * | obj_tags, | |||
const char ** | copy_option, | |||
const char ** | option_names, | |||
const char ** | relation_types, | |||
int * | count, | |||
tag_t ** | deepcopiedobjects | |||
) |
new_item_rev | (I) The Item Revision Tag to which attachments to be deep copied |
operation |
(I) The Type of operation: ITEM_revise_operation ITEM_saveas_operation |
parent_item_rev | (I) The Item Revision through which is revised to create the new_item_rev |
option_count | (I) |
obj_tags | (I) Tags of the objects that need to be copied or not be copied |
copy_option | (I) Copy options such as strings defined by ITEM_copy_as_object, ITEM_no_copy |
option_names | (I) User supplied names for the objects |
relation_types | (I) Names of the relation types |
count | (O) Number of deep copied objects |
deepcopiedobjects | (OF) count Array of deep copied objects |
TCCORE_API int ITEM_perform_deepcopy_using2 | ( | tag_t | new_item_rev, | |
char * | operation, | |||
tag_t | parent_item_rev, | |||
const int | option_count, | |||
const tag_t * | obj_tags, | |||
const char ** | copy_types, | |||
const char ** | obj_names, | |||
const char ** | relation_types, | |||
const char ** | copy_relations, | |||
int * | count, | |||
tag_t ** | deepcopiedobjects | |||
) |
new_item_rev | (I) The Item Revision Tag to which attachments to be deep copied |
operation |
(I) The Type of operation: ITEM_revise_operation ITEM_saveas_operation |
parent_item_rev | (I) The Item Revision through which is revised to create the new_item_rev |
option_count | (I) |
obj_tags | (I) Tags of the objects that need to be copied or not be copied |
copy_types | (I) Copy options such as strings defined by ITEM_copy_as_object, ITEM_no_copy |
obj_names | (I) User supplied names for the objects |
relation_types | (I) Names of the relation types |
copy_relations | (I) relation_count Carry forward the Properties on the Relation |
count | (O) Number of deep copied objects |
deepcopiedobjects | (OF) count Array of deep copied objects |
itemrev | (I) |
n | (O) |
mappings | (OF) n |
This function return the GDE BOMViewRevision of the specified view_type for a given Item Revision.
item_rev_tag | (I) Tag of the item revision under which the GDE BomViewRevision should be created |
view_type | (I) Tag of the view_type to be associated with the new GDE BomViewRevision |
gde_bvr_tag | (O) Tag of the GDE BomViewRevision. If no GDE BOMViewRevision is found NULLTAG is returned. |
Used to determine whether or not an item revision has a module.
item_rev | (I) The item rev being queried |
is_module | (O) True if the item rev has a module, otherwise false |
The new BOMView Revision is not saved; it can be saved to the database using AOM_save. Note that the parent Item Revision is modified and must also be saved
item_rev_tag | (I) Tag of the item revision under which the GDE BomViewRevision should be created |
view_type | (I) Tag of the view_type to be associated with the new GDE BomViewRevision |
gde_bvr_tag | (O) Tag of the newly created GDE BomViewRevision |
Removes the (PS) BOMViewRevision from the Item Revision and deletes it. If that leaves the corresponding BOMView with no BOMViewRevisions, then the BOMView is removed from the Item and deleted too.
rev | (I) Item Revision tag |
bvr | (I) BOMViewRevision tag |
This ITK returns the base item revision with which the baseline_rev is having the IMAN_baseline relation. If no revision is found, i.e., the input baseline_rev is not a Baseline Revision, then NULLTAG is returned as the base_rev.
baseline_rev | (I) The Baseline Item Revision Tag |
base_rev | (O) The base Revision of the given Baseline Item Revision |
TCCORE_API int ITEM_rev_get_key_string | ( | tag_t | item_revision_tag, | |
char ** | key_string | |||
) |
item_revision_tag | (I) Tag of Item Revision |
key_string | (OF) A delimited string representing the key attr/value pairs for the Itemm |
This function will return all the BOMViewRevision, including GDE BOMViewRevisions, for a given Item Revision.
rev | (I) Tag of the item revision under which the GDE BomViewRevision should be created |
count | (O) Number of BOM Views Revision attached to the above Item Revision |
bvrs | (OF) count Tags of BOMView Revisions (including GDE BOMViewRevisions) for the Item Revision |
TCCORE_API int ITEM_rev_list_baselineRevs | ( | tag_t | base_rev, | |
const char * | baselineStatusName, | |||
int * | n_revs, | |||
tag_t ** | baseline_revs | |||
) |
This ITK lists all the various Baseline Revisions that the base_rev has with the given baseline release status (baselineStatusName). If an empty baselineStatusName is sent, then it lists all the Baseline Revisions for the given base revision. The memory for the baseline_revs is allocated by the ITK and needs to be MEM_free()d.
base_rev | (I) Tag of the Item Revision for which the list of Baselines is requested |
baselineStatusName | (I) The release status name of the Baseline Revisions that are requested. If empty, then all the Baseline Revisions are returned. |
n_revs | (O) Number of Baseline Revisions matching the specified criteria. |
baseline_revs | (OF) n_revs The list of memory allocated Baseline Revisions |
This function will return all objects attached to the Item Revision.
rev | (I) Item Revision tag |
count | (O) Number of BOM Views attached to the Item Revision |
bvrs | (OF) count BOMView revisions for the Item Revision |
TCCORE_API int ITEM_save_item | ( | tag_t | item | ) |
This function saves an Item in the database.
Restrictions:
An Item must be saved before attachments can be made to it.
item | (I) Tag for identifying the Item to be saved |
TCCORE_API int ITEM_save_rev | ( | tag_t | rev | ) |
This function will save an Item Revision.
rev | (I) Tag for identifying the Item Revision to be saved |
TCCORE_API int ITEM_set_description | ( | tag_t | item, | |
const char * | item_desc | |||
) |
This function will set the description of the Item.
item | (I) Tag of an Item |
item_desc | (I) Description of an Item |
TCCORE_API int ITEM_set_id | ( | tag_t | item, | |
const char * | item_id | |||
) |
This function will set the ID of the Item.
item | (I) Tag of an Item |
item_id | (I) ID of an Item |
TCCORE_API int ITEM_set_name | ( | tag_t | item, | |
const char * | item_name | |||
) |
This function will set the name of the Item.
item | (I) Tag of an Item |
item_name | (I) Name of an Item |
TCCORE_API int ITEM_set_rev_description | ( | tag_t | rev, | |
const char * | rev_desc | |||
) |
This function will set the description of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_desc | (I) Description of an Item |
TCCORE_API int ITEM_set_rev_id | ( | tag_t | rev, | |
const char * | rev_id | |||
) |
This function will set the ID of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_id | (I) ID of the Item Revision |
TCCORE_API int ITEM_set_rev_name | ( | tag_t | rev, | |
const char * | rev_name | |||
) |
This function will set the name of the Item Revision.
rev | (I) Tag of an Item Revision |
rev_name | (I) Name of the Item Revision |
Sets the variant expression block associated with the specified Item Revision. A NULLTAG block clears the currently set value.
rev | (I) Tag of an Item Revision |
variant_expression_block | (I) Tag of the variant expression block |
Sets the unit of measure in which quantities of this Item must be expressed. Units of measure are objects defined for the Teamcenter Engineering site by the system administrator.
By default, Items have no UOM. In this case this function will give NULLTAG. This implies that quantities of such Items are expressed in terms of "Each" or "Pieces". In other words they refer to a discrete number of component parts. In PSE if no specific quantity value is associated with the use of such Items, the default quantity is assumed to be "1 component".
item | (I) Tag of an Item |
uom | (I) Tag of the unit of measure to be assigned to this Item (may be NULLTAG) |
TCCORE_API int ITEM_translate_rev_mvl | ( | tag_t | from_rev, | |
tag_t | to_rev, | |||
int | n_modules, | |||
char ** | from_modules, | |||
char ** | to_modules | |||
) |
Modular options are scoped by an item id. This function helps translate MVL text to subsitute new item id (this helps in scenarios like SaveAs where options in new structure should be scoped by new item id) Along with MVL text, an ItemRevision also has references to PSOption objects. These references should also mimic the scoping by Item, hence copies of PSOption objects are created for the new revision (to_rev).
from_rev | (I) |
to_rev | (I) |
n_modules | (I) |
from_modules | (I) n_modules |
to_modules | (I) n_modules |
TCCORE_API int ITEM_update_item_attachment | ( | tag_t | item, | |
tag_t | old_object, | |||
ITEM_attachment_type_t | attachment_type, | |||
tag_t | new_object | |||
) |
DEPRECATED FUNCTION This function replaces an old object that is attached to the Item with a new object.
item | (I) Tag of the Item |
old_object | (I) Tag of the old object |
attachment_type | (I) Type of attachment |
new_object | (I) Tag of the new object |
TCCORE_API int ITEM_update_rev_attachment | ( | tag_t | rev, | |
tag_t | old_object, | |||
ITEM_attachment_type_t | attachment_type, | |||
tag_t | new_object | |||
) |
DEPRECATED FUNCTION This function replaces the old object that is attached to an Item Revision with a new object.
rev | (I) Tag of the Item Revision |
old_object | (I) Tag of the old object |
attachment_type | (I) Type of attachment |
new_object | (I) Tag of the new object |
Provides the module stored within a variant item. A variant item’s module is the generic component it instantiates.
item | (I) The item being queried |
module_item_rev | (O) The VI’s generic component (module). NULLTAG if the item is not a VI. |
States whether or not a link is maintained between a variant item and its generic component. A linked VI cannot have structure changes made to it if those changes make it fundamentally different to the generic structure it instantiates.
item | (I) The item being queried |
is_linked |
(O) True if the item is a VI that maintains a link to its generic component, false if the item is not a VI or if it is a VI that does not require structure validation |
Provides the saved configuration stored within a variant item. The saved configuration describes how a variant item instantiates the generic component it originates from.
item | (I) The item being queried |
db_sos | (O) The VI’s saved configuration (stored option set). NULLTAG if the item is not a VI |
TCCORE_API int ITEM_vi_find | ( | tag_t | generic_item_rev, | |
int | n, | |||
tag_t * | items, | |||
char ** | options, | |||
int * | ops, | |||
int * | valueTypes, | |||
char ** | lowValues, | |||
char ** | highValues, | |||
int * | n_matches, | |||
tag_t ** | matches | |||
) |
Searches for variant items for the given generic component based on a set of option value criteria. Criteria for different options are ANDed together (e.g. "option1 = 5 and option2 = 10"). Criteria for the same option are ORed together (e.g. "option1 = 5 or option1 = 8").
generic_item_rev | (I) The generic component |
n | (I) Number of search criteria. Setting n to 0 will return all VIs of the generic component. |
items | (I) n Array of items against which the following options are defined |
options | (I) n Array of options that are being queried |
ops |
(I) n Array of query operators. Defined in bom_tokens.h: BOM_DB_SOS_OP_LIKE - Like (string matching with wildcards) BOM_DB_SOS_OP_NOT_LIKE - Not like BOM_DB_SOS_OP_EQ - Equals BOM_DB_SOS_OP_NE - Not equals BOM_DB_SOS_OP_LT - Less than BOM_DB_SOS_OP_GT - Greater than BOM_DB_SOS_OP_LTEQ - Less than or equal BOM_DB_SOS_OP_GTEQ - Greater than or equal BOM_DB_SOS_OP_IN - Inside range BOM_DB_SOS_OP_OUT - Outside range |
valueTypes |
(I) n Array of option value type definitions. Defined in bom_tokens.h: BOM_DB_SOS_LOGICAL BOM_DB_SOS_INTEGER BOM_DB_SOS_DOUBLE BOM_DB_SOS_STRING |
lowValues | (I) n Array of values to match. Passed as strings, converted internally to previously defined value type. |
highValues | (I) n Array of upper bound values when using range operators |
n_matches | (O) Number of matching VIs found |
matches | (OF) n_matches Array of matching VI's |
TCCORE_API int ITEM_vi_unlink_from_generic | ( | tag_t | item | ) |
Unlinks a variant item from its generic component. An unlinked VI can have structure that is different from its generic component.
Restrictions:
This action is not possible if the item is not a variant item
This action is permanent and not reversible. As soon as a VI is unlinked, this new VI state is saved to the database. It is not possible to unlink a VI and then relink it.
item | (I) The variant item that is to be unlinked |