propdesc.h File Reference

#include <unidefs.h>
#include <property/libproperty_exports.h>
#include <property/libproperty_undef.h>

Go to the source code of this file.

Data Structures
struct	PROP_values_stat_s
struct	PRULE_val_s

Typedefs
typedef enum PROP_field_type_e	PROP_field_type_t
typedef enum PROP_lov_attach_category_e	PROP_lov_attach_category_t
typedef enum PROP_protection_e	PROP_protection_t
typedef enum PROP_type_e	PROP_type_t
typedef enum PROP_valid_e	PROP_valid_t
typedef enum PROP_value_type_e	PROP_value_type_t
typedef struct PROP_values_stat_s	PROP_values_stat_t
typedef struct PRULE_val_s	PRULE_val_t

Enumerations
enum	PROP_field_type_e { PROP_field_unknown, PROP_simple_property, PROP_compound_object, PROP_compound_relation }
enum	PROP_lov_attach_category_e { PROP_lov_no_attaches, PROP_lov_istrue_attaches, PROP_lov_session_attaches, PROP_lov_object_based_attaches }
enum	PROP_protection_e { PROP_write, PROP_read, PROP_write_only_if_null }
enum	PROP_type_e {   PROP_unknown, PROP_attribute, PROP_reference, PROP_relation,   PROP_compound, PROP_runtime, PROP_operationinput }
enum	PROP_valid_e { PROP_valid_id, PROP_invalid_id, PROP_override_id, PROP_duplicate_id }
enum	PROP_value_type_e {   PROP_untyped, PROP_char, PROP_date, PROP_double,   PROP_float, PROP_int, PROP_logical, PROP_short,   PROP_string, PROP_typed_reference, PROP_untyped_reference, PROP_external_reference,   PROP_note, PROP_typed_relation, PROP_untyped_relation }

Functions
PROPERTY_API int	PROPDESC_ask_base_descriptor (tag_t prop_tag, tag_t *base_prop_tag, tag_t *base_type_tag)
PROPERTY_API int	PROPDESC_ask_compound_object_type (tag_t prop_tag, tag_t *compound_type_tag)
PROPERTY_API int	PROPDESC_ask_display_name (tag_t prop_tag, char **disp_name)
PROPERTY_API int	PROPDESC_ask_display_name_by_name (const char *name, char **disp_name)
PROPERTY_API int	PROPDESC_ask_display_values_from_LOV_attachments (tag_t prop_tag, int n_values, const char **values, char ***display_values)
PROPERTY_API int	PROPDESC_ask_field_type (tag_t prop_tag, PROP_field_type_t *field_type)
PROPERTY_API int	PROPDESC_ask_lov (tag_t prop_tag, tag_t *lov_tag)
PROPERTY_API int	PROPDESC_ask_lov_attach_dep_order (tag_t prop_tag, int *order)
PROPERTY_API int	PROPDESC_ask_lov_attach_parent_number (tag_t prop_tag, int *n_parent)
PROPERTY_API int	PROPDESC_ask_lov_interdependents (tag_t prop_tag, tag_t *lov_tag, int *n_props, tag_t **props, int **orders, int **n_parents, logical **descAttaches)
PROPERTY_API int	PROPDESC_ask_max_num_elements (tag_t prop_tag, int *maxnumelem)
PROPERTY_API int	PROPDESC_ask_max_string_length (tag_t prop_tag, int *maxstrlen)
PROPERTY_API int	PROPDESC_ask_name (tag_t prop_tag, char **name)
PROPERTY_API int	PROPDESC_ask_object_type (tag_t prop_tag, tag_t *type_tag)
PROPERTY_API int	PROPDESC_ask_parent_descriptor (tag_t prop_tag, tag_t *parent_prop_tag, tag_t *parent_type_tag)
PROPERTY_API int	PROPDESC_ask_property_type (tag_t prop_tag, PROP_type_t *proptype, char **proptype_n)
PROPERTY_API int	PROPDESC_ask_protection (tag_t prop_tag, PROP_protection_t *protection)
PROPERTY_API int	PROPDESC_ask_prule_init_value (tag_t prop_tag, char **prule_init_value)
PROPERTY_API int	PROPDESC_ask_source_object (tag_t object_tag, tag_t prop_tag, tag_t *source_obj_tag)
PROPERTY_API int	PROPDESC_ask_value_type (tag_t prop_tag, PROP_value_type_t *valtype, char **valtype_n)
PROPERTY_API int	PROPDESC_describe_prule (tag_t prop_tag, PRULE_val_t **argList)
PROPERTY_API void	PROPDESC_free_prule_struct (PRULE_val_t **argList)
PROPERTY_API int	PROPDESC_generate_next_values (int n_prop_desc_tags, tag_t *prop_desc_tags, char **pattern_strings, char *rule_suffix, char *basis_name, tag_t operation_in_tag, tag_t source_tag, tag_t relation_type, logical **is_modifiable_flags, char ***next_values, int **error_codes)
PROPERTY_API int	PROPDESC_get_auto_assign_info (tag_t prop_desc_tag, char *rule_suffix, logical *is_autoassignable, int *n_patterns, char ***pattern_strings, logical **has_counter, char **last_selected_pattern)
PROPERTY_API int	PROPDESC_get_next_rev_options (tag_t prop_desc_tag, tag_t item_rev_tag, int *n_formats, int **rev_formats, char ***rev_options, char ***rev_descs, char **excluded_letters)
PROPERTY_API int	PROPDESC_is_copyfromoriginal (tag_t propDescTag, logical *isCopyFromOriginal)
PROPERTY_API int	PROPDESC_is_displayable (tag_t prop_tag, logical *display_flag)
PROPERTY_API int	PROPDESC_is_enabled (tag_t prop_tag, logical *enab_flag)
PROPERTY_API int	PROPDESC_is_lov_desc_attach (tag_t prop_tag, logical *verdict)
PROPERTY_API int	PROPDESC_is_lov_localizable (tag_t propDescTag, logical *isLOVLocalizable)
PROPERTY_API int	PROPDESC_is_modifiable (tag_t prop_tag, logical *mod_flag)
PROPERTY_API int	PROPDESC_is_required (tag_t prop_tag, logical *req_flag)
PROPERTY_API int	PROPDESC_is_validatable (tag_t prop_tag, logical *validatable_flag)
PROPERTY_API int	PROPDESC_next_values_in_bulk (const char *type_name, int quantity, const char *prop_name, const tag_t item_tag, const char *ds_id, const char *preferred_type_name, const char *default_type_name, const tag_t parent_tag, const char *rule_suffix, const char *base_rev_id, const char *pattern, char ***next_ids)
PROPERTY_API int	PROPDESC_set_display_name (tag_t prop_tag, const char *disp_name)
PROPERTY_API int	PROPDESC_validate_values (int num_of_prop_desc_tags, tag_t *prop_desc_tags, tag_t oprn_input_tag, int operation_type, logical *is_unique, PROP_values_stat_t **values_status)

Detailed Description

This file contains the ANSI C interface to Teamcenter Engineering property descriptors. These provide the definition of a property. The interface for actual instances of a property is defined in imanproperty.h

Definition in file propdesc.h.