|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
Modules | |
| IDCXT Errors | |
Functions | |
| TCCORE_API int | IDCXT_ask_description (tag_t idcontext_tag, char **description) |
| TCCORE_API int | IDCXT_ask_name (tag_t idcontext_tag, char **name) |
| TCCORE_API int | IDCXT_find (const char *name, int *num_idcontexts, tag_t **idcontext_tags) |
| TCCORE_API int | IDCXT_find_idcontext (const char *name, tag_t *idcontext_tag) |
IDCONTEXT class name and property name constants | |
| #define | IDCONTEXT_class_name_c "IdContext" |
| #define | IDCONTEXT_name "idcxt_name" |
| #define | IDCONTEXT_description "idcxt_desc" |
IDCONTEXTRULE class name and property constants | |
| #define | IDCONTEXTRULE_class_name_c "IdContextRule" |
| #define | IDCONTEXTRULE_idfbl_type "idfbl_type" |
| #define | IDCONTEXTRULE_idfr_type "idfr_type" |
| #define | IDCONTEXTRULE_idcontext "idcontext" |
| #define | IDCONTEXTRULE_rule "idcxt_rule" |
An id is defined in a context. The initial ids of an item (item_id) as well as item revision (item_revision_id) are conceptually defined in a Teamcenter Engineering Site context.
All ids in a given context are unique. However, the item revision defines its revision id as a unique revision id in the context of its owning item. Thus, an id is considered defined in an IdContext as well as a Supplemental Context. The initial ids are defined in a conceptual IdContext of value null.
An IdContext defines a context for an id. Names of IdContexts are unique within a Teamcenter Engineering site. To ensure the case insensitive uniqueness of IdContext names, a site administrator must install a functional index, otherwise performance will be negatively impacted. Only an administrator should be able to create/delete/modify an IdContext.
For most objects, the supplemental context is null. Thus, they define an id that is unique within the IdContext. However, item revisions define an id that is unique within the IdContext and Supplemental Context (Alternate id of the owning item).
Use AOM functionality to refresh, save, and delete idcontext objects. Use MEM_free to release allocated storage.
IDCXT � IdContext Functions
Messages Supported By IdContext
All types of IdContext class and its sub-classes support the following messages:
| TCCORE_API int IDCXT_ask_description | ( | tag_t | idcontext_tag, |
| char ** | description | ||
| ) |
Returns the description attribute for the given idcontext.
| idcontext_tag | (I) Tag of existing idcontext |
| description | (OF) Description attribute value for the given idcontext |
| TCCORE_API int IDCXT_ask_name | ( | tag_t | idcontext_tag, |
| char ** | name | ||
| ) |
Returns the name attribute for the given idcontext.
| idcontext_tag | (I) Tag of existing idcontext |
| name | (OF) Name attribute value for the given idcontext |
| TCCORE_API int IDCXT_find | ( | const char * | name, |
| int * | num_idcontexts, | ||
| tag_t ** | idcontext_tags | ||
| ) |
Returns all the idcontext objects that have the given name. Uses case-insensitive search and allows wildcards in name.
| name | (I) Name attribute value of an idcontext |
| num_idcontexts | (O) Number of idcontext objects |
| idcontext_tags | (OF) num_idcontexts An array of tags to idcontext objects |
| TCCORE_API int IDCXT_find_idcontext | ( | const char * | name, |
| tag_t * | idcontext_tag | ||
| ) |
Returns one idcontext object that has the given name. Uses case-insensitive search and allows wildcards in name. An error will be returned if more than one name is qualified in the search.
| name | (I) Name attribute value of an idcontext |
| idcontext_tag | (O) Tag of idcontext object |