ITK Function Reference

(V10000.1.0.60_20160308.00)
Data Structures | Macros | Typedefs | Enumerations | Functions
tctype.h File Reference
#include <property/prop.h>
#include <tccore/tctype_msg.h>
#include <user_exits/user_exits.h>
#include <tccore/libtccore_exports.h>
#include <tccore/libtccore_undef.h>

Go to the source code of this file.

Data Structures

struct  TCTYPE_availablerel_s
 

Macros

#define TC_set_description_msg   "IMAN_set_description"
 
#define TC_set_id_msg   "IMAN_set_id"
 
#define TC_set_name_msg   "IMAN_set_name"
 
#define TC_set_type_directly_msg   "IMAN_set_type_directly"
 
#define TC_set_type_msg   "IMAN_set_type"
 
#define TCTYPE_class_name_size_c   27
 
#define TCTYPE_DISABLE_UPDATE_LIST   0
 
#define TCTYPE_ENABLE_UPDATE_LIST   1
 
#define TCTYPE_name_size_c   32
 
#define TCTYPE_RESUME_UPDATE_LIST   3
 
#define TCTYPE_SUSPEND_UPDATE_LIST   2
 
#define TCTYPE_UPDATE_ALL_PROPS   "_update_all_"
 

Typedefs

typedef struct
TCTYPE_availablerel_s 
TCTYPE_availablerel_t
 
typedef enum TCTYPE_category_e TCTYPE_category_t
 
typedef enum
TCTYPE_compounding_ctxt_e 
TCTYPE_compounding_ctxt_t
 
typedef enum TCTYPE_display_e TCTYPE_display_t
 
typedef enum
TCTYPE_operation_input_e 
TCTYPE_operation_input_t
 
typedef enum
TCTYPE_save_operation_context_e 
TCTYPE_save_operation_context_t
 

Enumerations

enum  TCTYPE_category_e {
  TCTYPE_Persistent, TCTYPE_Runtime, TCTYPE_OperationInput, TCTYPE_Root,
  TCTYPE_Dynamic, TCTYPE_All
}
 
enum  TCTYPE_compounding_ctxt_e { TCTYPE_compounding_ctxt_unknown, TCTYPE_compounding_ctxt_relation, TCTYPE_compounding_ctxt_secondary }
 
enum  TCTYPE_display_e {
  TCTYPE_DISPLAYABLE =0, TCTYPE_HIDDEN_AT_SYSTEM_LEVEL, TCTYPE_HIDDEN_AT_SITE_LEVEL, TCTYPE_HIDDEN_AT_PARENT_LEVEL,
  TCTYPE_HIDDEN_AT_CURRENT_LEVEL
}
 
enum  TCTYPE_operation_input_e { TCTYPE_OPERATIONINPUT_CREATE, TCTYPE_OPEARTIONINPUT_REVISE, TCTYPE_OPERATIONINPUT_SAVEAS, TCTYPE_OPERATIONINPUT_ANY }
 
enum  TCTYPE_save_operation_context_e {
  TCTYPE_save_on_create, TCTYPE_save_on_saveas, TCTYPE_save_on_revise, TCTYPE_save_on_update,
  TCTYPE_save_on_clone, TCTYPE_unknown_operation_context
}
 

Functions

TCCORE_API int TCTYPE_add_relation_property (tag_t type_tag, const char *prop_name, tag_t rel_type, tag_t *pd_tag)
 
TCCORE_API int TCTYPE_add_runtime_array_property (tag_t type_tag, const char *prop_name, PROP_value_type_t valuetype, int maxstrlen, int maxnumelements, tag_t *pd_tag)
 
TCCORE_API int TCTYPE_add_runtime_property (tag_t type_tag, const char *prop_name, PROP_value_type_t valuetype, int maxstrlen, tag_t *pd_tag)
 
TCCORE_API int TCTYPE_add_to_changed_tag_list (tag_t object, const char *properties)
 
TCCORE_API int TCTYPE_add_to_deleted_tag_list (tag_t object)
 
TCCORE_API int TCTYPE_ask_available_relation_names (tag_t type_tag, int *relationNameCount, char ***relationDisplayNames, char ***relationActualNames)
 
TCCORE_API int TCTYPE_ask_available_relations (tag_t type_tag, int *relationCount, TCTYPE_availablerel_t **relationNames)
 
TCCORE_API int TCTYPE_ask_child_primary_types (tag_t type_tag, int *numOfChildTypes, tag_t **listOfChildTypes)
 
TCCORE_API int TCTYPE_ask_child_types (tag_t type_tag, logical forSameClassOnly, int *numOfChildTypes, tag_t **listOfChildTypes)
 
TCCORE_API int TCTYPE_ask_class_name (tag_t type_tag, char type_class[TCTYPE_class_name_size_c+1])
 
TCCORE_API int TCTYPE_ask_class_name2 (tag_t type_tag, char **type_class)
 
TCCORE_API int TCTYPE_ask_create_descriptor (tag_t boTypeTag, tag_t *createDescTag)
 
TCCORE_API int TCTYPE_ask_create_prop_descriptors (tag_t createDescTag, int *n_propDescTags, tag_t **propDescTags, int *n_secPropNames, char ***secPropNames, tag_t **secBOTypeTags, logical **isRequired, logical **isArray, int **compoundingCtxts, tag_t **secCreateDescTags)
 
TCCORE_API int TCTYPE_ask_deepcopydata (tag_t object_tag, TCTYPE_operation_input_t opvar, int *num_attached_objs, tag_t **deepcopydata_tags)
 
TCCORE_API int TCTYPE_ask_display_name (tag_t type_tag, char **display_type_name)
 
TCCORE_API int TCTYPE_ask_name (tag_t type_tag, char type_name[TCTYPE_name_size_c+1])
 
TCCORE_API int TCTYPE_ask_name2 (tag_t type_tag, char **type_name)
 
TCCORE_API int TCTYPE_ask_name_rule_patterns (const char *boName, int *n_propNames, char ***propNames, int **patternCountArray, int *n_patterns, char ***patterns)
 
TCCORE_API int TCTYPE_ask_object_type (tag_t obj_tag, tag_t *type_tag)
 
TCCORE_API int TCTYPE_ask_object_type_with_stubs (tag_t obj_tag, tag_t *type_tag)
 
TCCORE_API int TCTYPE_ask_object_types (int number_of_objects, const tag_t *obj_tags, tag_t **types)
 
TCCORE_API int TCTYPE_ask_parent_type (tag_t type_tag, tag_t *parent_type_tag)
 
TCCORE_API int TCTYPE_ask_property_by_display_name (tag_t type_tag, const char *disp_name, tag_t *pd_tag)
 
TCCORE_API int TCTYPE_ask_property_by_name (tag_t type_tag, const char *prop_name, tag_t *pd_tag)
 
TCCORE_API int TCTYPE_ask_revise_descriptor (tag_t object_type_tag, tag_t *revise_desc_tag)
 
TCCORE_API int TCTYPE_ask_save_operation_context (TCTYPE_save_operation_context_t *opEnmSvOprnCtxt)
 
TCCORE_API int TCTYPE_ask_saveas_descriptor (tag_t objectTypeTag, tag_t *saveAsDescTag)
 
TCCORE_API int TCTYPE_ask_saveas_prop_descriptors (tag_t saveasDescTag, int *n_propDescTags, tag_t **propDescTags)
 
TCCORE_API int TCTYPE_ask_subtypes (tag_t type_tag, logical forSameClassOnly, int *numOfSubtypes, tag_t **listOfSubtypes)
 
TCCORE_API int TCTYPE_ask_subtypes_with_exclusions (tag_t type_tag, logical for_same_class_only, int n_exclusion_bo_names, const char **exclusion_bo_names, int *num_of_sub_types, tag_t **list_of_sub_types)
 
TCCORE_API int TCTYPE_ask_target_deepcopydata (tag_t objectTag, int *numAttachedObjs, tag_t **deepCopyDataTags)
 
TCCORE_API int TCTYPE_ask_type (const char *type_name, tag_t *type_tag)
 
TCCORE_API int TCTYPE_construct_create_input (tag_t boTypeTag, tag_t *createInputTag)
 
TCCORE_API int TCTYPE_construct_operationinput (tag_t targetObjTypeTag, TCTYPE_operation_input_t opvar, tag_t *targetSaveAsInputTag)
 
TCCORE_API int TCTYPE_construct_saveasinput (tag_t boTypeTag, tag_t *saveAsInputTag)
 
TCCORE_API int TCTYPE_create_object (tag_t creInputTag, tag_t *boTag)
 
TCCORE_API int TCTYPE_create_objects (int n_bulks, int *quantities, tag_t *create_inputs, int *n_objects, tag_t **objects)
 
TCCORE_API int TCTYPE_create_single_objects (int n_bulks, const tag_t *create_inputs, int *n_objects, tag_t **objects)
 
TCCORE_API int TCTYPE_exit_module ()
 
TCCORE_API int TCTYPE_extent (int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_extent_by_category (TCTYPE_category_t type_category, int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_find_alltypes_for_class (const char *class_name, int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_find_displayable_business_objects (const char *boName, int n_exclusionBONames, const char **exclusionBONames, int *n_displayableTypeTags, tag_t **displayableTypeTags)
 
TCCORE_API int TCTYPE_find_displayable_types_for_class (const char *class_name, logical include_subclasses, int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_find_displayable_types_for_class_and_accessor (const char *class_name, tag_t accessor_tag, logical include_subclasses, int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_find_hidden_types_for_class_and_accessor (const char *class_name, tag_t accessor_tag, logical include_subclasses, int *number_of_types, tag_t **type_tags, TCTYPE_display_t **details)
 
TCCORE_API int TCTYPE_find_type (const char *type_name, const char *class_name, tag_t *type_tag)
 
TCCORE_API int TCTYPE_find_types_for_class (const char *class_name, int *number_of_types, tag_t **type_tags)
 
TCCORE_API int TCTYPE_free_deepcopydata (int numDeepCopyData, tag_t *deepCopyDataTags)
 
TCCORE_API int TCTYPE_get_modified_tag_list (logical clear_lists, int *num_objects, tag_t **tags, int **deleted_or_modified, char ***properties)
 
TCCORE_API int TCTYPE_init_module ()
 
TCCORE_API logical TCTYPE_is_extent_already_called ()
 
TCCORE_API int TCTYPE_is_type_of (tag_t type, tag_t parent_type, logical *answer)
 
TCCORE_API int TCTYPE_is_type_of_as_str (tag_t type_tag, const char *parent_type_name, logical *answer)
 
TCCORE_API int TCTYPE_list_displayable_properties (tag_t type_tag, int *num, tag_t **pd_tags)
 
TCCORE_API int TCTYPE_list_primary_rtypes (tag_t primary_type, int *n_rtypes, tag_t **rtypes)
 
TCCORE_API int TCTYPE_list_properties (tag_t type_tag, int *num, tag_t **pd_tags)
 
TCCORE_API int TCTYPE_load_all_delayed_types ()
 
TCCORE_API int TCTYPE_property_exists (tag_t type_tag, const char *prop_name, logical *verdict)
 
TCCORE_API int TCTYPE_refresh (tag_t type_tag, logical lock_or_not)
 
TCCORE_API int TCTYPE_register_properties (USER_prop_init_entry_t *user_types_methods, int array_size)
 
TCCORE_API int TCTYPE_remove_from_modified_tag_list (tag_t object)
 
TCCORE_API int TCTYPE_revise_objects (int num_target_objs, tag_t *target_object_tags, tag_t *revise_input_tags, int *num_attached_objs, tag_t *deepcopydata_tags, tag_t **target_copy_tags, int **ifails)
 
TCCORE_API int TCTYPE_saveas_object (tag_t targetObjectTag, tag_t saveAsInputTag, int numAttachedObjects, tag_t *deepCopyDataTags, tag_t *targetCopyTag)
 
TCCORE_API int TCTYPE_set_create_display_value (tag_t creInputTag, char *propName, int n_dispValues, const char **dispValues)
 
TCCORE_API int TCTYPE_set_OperationInput_DisplayValue (tag_t opInputTag, char *propName, const char **dispValues)
 
TCCORE_API int TCTYPE_UIF_find_displayable_business_objects (const char *boName, int n_exclusionBONames, const char **exclusionBONames, int *n_displayableTypeTags, tag_t **displayableTypeTags, char ***typeNames, char ***displayTypeNames)
 
TCCORE_API int TCTYPE_UIF_find_displayable_types_for_class (const char *class_name, logical include_subclasses, int *number_of_types, tag_t **type_tags, char ***type_names, char ***display_type_names)
 
TCCORE_API int TCTYPE_UIF_find_generically_creatable_business_objects (const char *bo_name, int n_exclusion_bo_names, const char **exclusion_bo_names, int *n_displayable_type_tags, tag_t **displayable_type_tags, char ***type_names, char ***display_type_names)
 

Detailed Description

This file contains the interface to Teamcenter types. These are similar to the EXPRESS notion of defined data type.

Definition in file tctype.h.