tccore/aom_prop.h File Reference

---

Detailed Description

This file contains the ANSI C interface to Teamcenter Engineering property messages and access functions.

Property Messages are conceptual actions to be done on a property. When a Message is sent to a specific Property, the Method registered with that Message/Type/Property combination will be executed. See ITK documentation on Property Methods for further details.

Each message has a unique set of parameters, which are defined here. These parameters are passed in the varargs list METHOD_execute / METHOD_execute_using, and received in the varargs list of action functions registered to perform methods.

Definition in file aom_prop.h.

#include <unidefs.h>
#include <property/propdesc.h>
#include <property/prop_msg.h>
#include <tccore/libtccore_exports.h>
#include <tccore/libtccore_undef.h>

Go to the source code of this file.

Data Structures

• struct LOC_values_s

Typedefs

• typedef struct LOC_values_s PROP_values_t

Functions

• TCCORE_API int AOM_ask_prop_names (tag_t object_tag, int *prop_count, char ***prop_names)
• TCCORE_API int AOM_ask_sorted_prop_names (tag_t object_tag, int *prop_count, char ***prop_names)
• TCCORE_API int AOM_set_value_string (tag_t object_tag, const char *prop_name, const char *value)
• TCCORE_API int AOM_set_value_strings (tag_t object_tag, const char *prop_name, int num, char **values)
• TCCORE_API int AOM_set_value_string_at (tag_t object_tag, const char *prop_name, int position, const char *value)
• TCCORE_API int AOM_set_value_date (tag_t object_tag, const char *prop_name, date_t value)
• TCCORE_API int AOM_set_value_dates (tag_t object_tag, const char *prop_name, int num, const date_t *values)
• TCCORE_API int AOM_set_value_date_at (tag_t object_tag, const char *prop_name, int position, date_t value)
• TCCORE_API int AOM_set_value_double (tag_t object_tag, const char *prop_name, double value)
• TCCORE_API int AOM_set_value_doubles (tag_t object_tag, const char *prop_name, int num, const double *values)
• TCCORE_API int AOM_set_value_double_at (tag_t object_tag, const char *prop_name, int position, double value)
• TCCORE_API int AOM_set_value_int (tag_t object_tag, const char *prop_name, int value)
• TCCORE_API int AOM_set_value_ints (tag_t object_tag, const char *prop_name, int num, const int *values)
• TCCORE_API int AOM_set_value_int_at (tag_t object_tag, const char *prop_name, int position, int value)
• TCCORE_API int AOM_set_value_logical (tag_t object_tag, const char *prop_name, logical value)
• TCCORE_API int AOM_set_value_logicals (tag_t object_tag, const char *prop_name, int num, const logical *values)
• TCCORE_API int AOM_set_value_logical_at (tag_t object_tag, const char *prop_name, int position, logical value)
• TCCORE_API int AOM_set_value_tag (tag_t object_tag, const char *prop_name, tag_t value)
• TCCORE_API int AOM_set_value_tags (tag_t object_tag, const char *prop_name, int num, const tag_t *values)
• TCCORE_API int AOM_set_value_tag_at (tag_t object_tag, const char *prop_name, int position, tag_t value)
• TCCORE_API int AOM_set_value_char (tag_t object_tag, const char *prop_name, char value)
• TCCORE_API int AOM_set_value_chars (tag_t object_tag, const char *prop_name, int num, const char *values)
• TCCORE_API int AOM_set_value_char_at (tag_t object_tag, const char *prop_name, int position, char value)
• TCCORE_API int AOM_ask_value_string (tag_t object_tag, const char *prop_name, char **value)
• TCCORE_API int AOM_ask_value_strings (tag_t object_tag, const char *prop_name, int *num, char ***values)
• TCCORE_API int AOM_ask_value_string_at (tag_t object_tag, const char *prop_name, int position, char **value)
• TCCORE_API int AOM_ask_value_date (tag_t object_tag, const char *prop_name, date_t *value)
• TCCORE_API int AOM_ask_value_dates (tag_t object_tag, const char *prop_name, int *num, date_t **values)
• TCCORE_API int AOM_ask_value_date_at (tag_t object_tag, const char *prop_name, int position, date_t *value)
• TCCORE_API int AOM_ask_value_double (tag_t object_tag, const char *prop_name, double *value)
• TCCORE_API int AOM_ask_value_doubles (tag_t object_tag, const char *prop_name, int *num, double **values)
• TCCORE_API int AOM_ask_value_double_at (tag_t object_tag, const char *prop_name, int position, double *value)
• TCCORE_API int AOM_ask_value_int (tag_t object_tag, const char *prop_name, int *value)
• TCCORE_API int AOM_ask_value_ints (tag_t object_tag, const char *prop_name, int *num, int **values)
• TCCORE_API int AOM_ask_value_int_at (tag_t object_tag, const char *prop_name, int position, int *value)
• TCCORE_API int AOM_ask_value_logical (tag_t object_tag, const char *prop_name, logical *value)
• TCCORE_API int AOM_ask_value_logicals (tag_t object_tag, const char *prop_name, int *num, logical **values)
• TCCORE_API int AOM_ask_value_logical_at (tag_t object_tag, const char *prop_name, int position, logical *value)
• TCCORE_API int AOM_ask_value_tag (tag_t object_tag, const char *prop_name, tag_t *value)
• TCCORE_API int AOM_ask_value_tags (tag_t object_tag, const char *prop_name, int *num, tag_t **values)
• TCCORE_API int AOM_ask_value_tag_at (tag_t object_tag, const char *prop_name, int position, tag_t *value)
• TCCORE_API int AOM_ask_value_char (tag_t object_tag, const char *prop_name, char *value)
• TCCORE_API int AOM_ask_value_chars (tag_t object_tag, const char *prop_name, int *num, char **values)
• TCCORE_API int AOM_ask_value_char_at (tag_t object_tag, const char *prop_name, int position, char *value)
• TCCORE_API int AOM_ask_num_elements (tag_t object_tag, const char *prop_name, int *num_elem)
• TCCORE_API int AOM_is_modifiable (tag_t object_tag, const char *prop_name, logical *mod_flag)
• TCCORE_API int AOM_ask_lov (tag_t object_tag, const char *prop_name, tag_t *lov_tag)
• TCCORE_API int AOM_ask_property_type (tag_t object_tag, const char *prop_name, PROP_type_t *proptype, char **proptype_n)
• TCCORE_API int AOM_ask_value_type (tag_t object_tag, const char *prop_name, PROP_value_type_t *valtype, char **valtype_n)
• TCCORE_API int AOM_ask_max_num_elements (tag_t object_tag, const char *prop_name, int *maxnumelem)
• TCCORE_API int AOM_ask_max_string_length (tag_t object_tag, const char *prop_name, int *maxstrlen)
• TCCORE_API int AOM_UIF_is_displayable (tag_t object_tag, const char *prop_name, logical *is_display)
• TCCORE_API int AOM_UIF_is_required (tag_t object_tag, const char *prop_name, logical *is_required)
• TCCORE_API int AOM_UIF_is_enabled (tag_t object_tag, const char *prop_name, logical *is_enabled)
• TCCORE_API int AOM_UIF_ask_name (tag_t object_tag, const char *prop_name, char **disp_name)
• TCCORE_API int AOM_UIF_ask_value (tag_t object_tag, const char *prop_name, char **d_value)
• TCCORE_API int AOM_UIF_set_value (tag_t object_tag, const char *prop_name, const char *value)
• TCCORE_API int AOM_ask_descriptor (tag_t object_tag, const char *prop_name, tag_t *descriptor)
• TCCORE_API int AOM_UIF_validate_display_value (tag_t object_tag, const char *prop_name, const char *val, logical *flag)
• TCCORE_API int AOM_ask_relations (tag_t object_tag, const char *prop_name, int *num, tag_t **relation_tags)
• TCCORE_API int AOM_tag_to_string (tag_t the_tag, char **the_string)
• TCCORE_API int AOM_string_to_tag (const char *the_string, tag_t *the_tag)
• TCCORE_API int AOM_assign_string (tag_t object_tag, const char *prop_name, const char *value)
• TCCORE_API int AOM_assign_string_at (tag_t object_tag, const char *prop_name, int position, const char *value)
• TCCORE_API int AOM_assign_strings (tag_t object_tag, const char *prop_name, int num, char **values)
• TCCORE_API int AOM_assign_date (tag_t object_tag, const char *prop_name, date_t value)
• TCCORE_API int AOM_assign_date_at (tag_t object_tag, const char *prop_name, int position, date_t value)
• TCCORE_API int AOM_assign_dates (tag_t object_tag, const char *prop_name, int num, const date_t *values)
• TCCORE_API int AOM_assign_double (tag_t object_tag, const char *prop_name, double value)
• TCCORE_API int AOM_assign_double_at (tag_t object_tag, const char *prop_name, int position, double value)
• TCCORE_API int AOM_assign_doubles (tag_t object_tag, const char *prop_name, int num, const double *values)
• TCCORE_API int AOM_assign_int (tag_t object_tag, const char *prop_name, int value)
• TCCORE_API int AOM_assign_int_at (tag_t object_tag, const char *prop_name, int position, int value)
• TCCORE_API int AOM_assign_ints (tag_t object_tag, const char *prop_name, int num, const int *values)
• TCCORE_API int AOM_assign_logical (tag_t object_tag, const char *prop_name, logical value)
• TCCORE_API int AOM_assign_logical_at (tag_t object_tag, const char *prop_name, int position, logical value)
• TCCORE_API int AOM_assign_logicals (tag_t object_tag, const char *prop_name, int num, const logical *values)
• TCCORE_API int AOM_assign_tag (tag_t object_tag, const char *prop_name, tag_t value)
• TCCORE_API int AOM_assign_tag_at (tag_t object_tag, const char *prop_name, int position, tag_t value)
• TCCORE_API int AOM_assign_tags (tag_t object_tag, const char *prop_name, int num, const tag_t *values)
• TCCORE_API int AOM_assign_char (tag_t object_tag, const char *prop_name, char value)
• TCCORE_API int AOM_assign_char_at (tag_t object_tag, const char *prop_name, int position, char value)
• TCCORE_API int AOM_assign_chars (tag_t object_tag, const char *prop_name, int num, const char *values)
• TCCORE_API int AOM_get_value_string (tag_t object_tag, const char *prop_name, char **value)
• TCCORE_API int AOM_get_value_strings (tag_t object_tag, const char *prop_name, int *num, char ***values)
• TCCORE_API int AOM_get_value_string_at (tag_t object_tag, const char *prop_name, int position, char **value)
• TCCORE_API int AOM_get_value_date (tag_t object_tag, const char *prop_name, date_t *value)
• TCCORE_API int AOM_get_value_dates (tag_t object_tag, const char *prop_name, int *num, date_t **values)
• TCCORE_API int AOM_get_value_date_at (tag_t object_tag, const char *prop_name, int position, date_t *value)
• TCCORE_API int AOM_get_value_double (tag_t object_tag, const char *prop_name, double *value)
• TCCORE_API int AOM_get_value_doubles (tag_t object_tag, const char *prop_name, int *num, double **values)
• TCCORE_API int AOM_get_value_double_at (tag_t object_tag, const char *prop_name, int position, double *value)
• TCCORE_API int AOM_get_value_int (tag_t object_tag, const char *prop_name, int *value)
• TCCORE_API int AOM_get_value_ints (tag_t object_tag, const char *prop_name, int *num, int **values)
• TCCORE_API int AOM_get_value_int_at (tag_t object_tag, const char *prop_name, int position, int *value)
• TCCORE_API int AOM_get_value_logical (tag_t object_tag, const char *prop_name, logical *value)
• TCCORE_API int AOM_get_value_logicals (tag_t object_tag, const char *prop_name, int *num, logical **values)
• TCCORE_API int AOM_get_value_logical_at (tag_t object_tag, const char *prop_name, int position, logical *value)
• TCCORE_API int AOM_get_value_tag (tag_t object_tag, const char *prop_name, tag_t *value)
• TCCORE_API int AOM_get_value_tags (tag_t object_tag, const char *prop_name, int *num, tag_t **values)
• TCCORE_API int AOM_get_value_tag_at (tag_t object_tag, const char *prop_name, int position, tag_t *value)
• TCCORE_API int AOM_get_value_char (tag_t object_tag, const char *prop_name, char *value)
• TCCORE_API int AOM_get_value_chars (tag_t object_tag, const char *prop_name, int *num, char **values)
• TCCORE_API int AOM_get_value_char_at (tag_t object_tag, const char *prop_name, int position, char *value)
• TCCORE_API int AOM_is_null_empty (tag_t object_tag, const char *prop_name, logical check_zero_length, logical *is_null_empty)
• TCCORE_API int AOM_UIF_set_localized_value_string (tag_t object_tag, const char *prop_name, const char *locale, const char *value, char localization_status, logical master)
• TCCORE_API int AOM_UIF_set_localized_value_strings (tag_t object_tag, const char *prop_name, const char *locale, int num, const char **values, char *localization_statuses, logical master)
• TCCORE_API int AOM_UIF_set_localized_value_string_at (tag_t object_tag, const char *prop_name, const char *locale, int position, const char *value, char localization_status, logical master)
• TCCORE_API int AOM_UIF_ask_localized_value_string (tag_t object_tag, const char *prop_name, const char *locale, char **value, char *localization_status, logical *master)
• TCCORE_API int AOM_UIF_ask_localized_value_strings (tag_t object_tag, const char *prop_name, const char *locale, int *num, char ***values, char **localization_statuses, logical *master)
• TCCORE_API int AOM_UIF_ask_localized_value_string_at (tag_t object_tag, const char *prop_name, const char *locale, int position, char **value, char *localization_status, logical *master)
• TCCORE_API int AOM_UIF_ask_multiple_localized_value_strings (int n_objects, tag_t *object_tags, int n_props, const char **prop_names, int n_locales, const char **locales, PROP_values_t ****prop_values)
• TCCORE_API int AOM_UIF_set_multiple_localized_value_strings (int n_objects, tag_t *object_tags, int n_props, const char **prop_names, int n_locales, const char **locales, PROP_values_t ***prop_values)
• TCCORE_API int AOM_UIF_ask_translations (tag_t object_tag, const char *prop_name, const int seq_num, int *num_translations, char ***translationLocales, char ***translationValues, char ***translationStatusNames, char ***translationStatusDescriptions)
• TCCORE_API int AOM_UIF_set_translations (tag_t object_tag, const char *prop_name, const int seq_num, int num_translations, char **translationLocales, char **translationValues, char **translationStatusCodes)
• TCCORE_API int AOM_UIF_ask_values (tag_t object_tag, const char *prop_name, int *num_values, char ***values)
• TCCORE_API int AOM_UIF_delete_localized_value_string (tag_t object_tag, const char *prop_name, int index, const char *locale)
• TCCORE_API int AOM_UIF_set_multiple_localized_value_strings_test_stub (int n_objects, tag_t *object_tags, int n_props, const char **prop_names, int n_locales, const char **locales, char **status, int n_values, char **values, int index_of_master)
• TCCORE_API int AOM_UIF_ask_multiple_localized_value_strings_test_stub (int n_objects, tag_t *object_tags, int n_props, const char **prop_names, int n_locales, const char **locales, int object_index, int property_index, int locale_index, int *numberOfValues, char ***values, logical *master, char **statuses)
• TCCORE_API int AOM_UIF_clear_translations (tag_t object_tag, const char *prop_name)
• TCCORE_API int AOM_ask_property_master_locale (tag_t object_tag, const char *prop_name, char **master_locale)