ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros
prop_msg.h File Reference
#include <property/libproperty_exports.h>
#include <property/libproperty_undef.h>

Go to the source code of this file.

Macros

#define PROP_ask_displayable_values_msg   "PROP_ask_displayable_values"
 
#define PROP_ask_lov_chars_msg   "PROP_ask_lov_chars"
 
#define PROP_ask_lov_dates_msg   "PROP_ask_lov_dates"
 
#define PROP_ask_lov_doubles_msg   "PROP_ask_lov_doubles"
 
#define PROP_ask_lov_ints_msg   "PROP_ask_lov_ints"
 
#define PROP_ask_lov_logicals_msg   "PROP_ask_lov_logicals"
 
#define PROP_ask_lov_strings_msg   "PROP_ask_lov_strings"
 
#define PROP_ask_lov_tags_msg   "PROP_ask_lov_tags"
 
#define PROP_ask_value_char_at_msg   "PROP_ask_value_char_at"
 
#define PROP_ask_value_char_msg   "PROP_ask_value_char"
 
#define PROP_ask_value_chars_msg   "PROP_ask_value_chars"
 
#define PROP_ask_value_date_at_msg   "PROP_ask_value_date_at"
 
#define PROP_ask_value_date_msg   "PROP_ask_value_date"
 
#define PROP_ask_value_dates_msg   "PROP_ask_value_dates"
 
#define PROP_ask_value_double_at_msg   "PROP_ask_value_double_at"
 
#define PROP_ask_value_double_msg   "PROP_ask_value_double"
 
#define PROP_ask_value_doubles_msg   "PROP_ask_value_doubles"
 
#define PROP_ask_value_int_at_msg   "PROP_ask_value_int_at"
 
#define PROP_ask_value_int_msg   "PROP_ask_value_int"
 
#define PROP_ask_value_ints_msg   "PROP_ask_value_ints"
 
#define PROP_ask_value_logical_at_msg   "PROP_ask_value_logical_at"
 
#define PROP_ask_value_logical_msg   "PROP_ask_value_logical"
 
#define PROP_ask_value_logicals_msg   "PROP_ask_value_logicals"
 
#define PROP_ask_value_string_at_msg   "PROP_ask_value_string_at"
 
#define PROP_ask_value_string_msg   "PROP_ask_value_string"
 
#define PROP_ask_value_strings_msg   "PROP_ask_value_strings"
 
#define PROP_ask_value_tag_at_msg   "PROP_ask_value_tag_at"
 
#define PROP_ask_value_tag_msg   "PROP_ask_value_tag"
 
#define PROP_ask_value_tags_msg   "PROP_ask_value_tags"
 
#define PROP_is_modifiable_msg   "PROP_is_modifiable"
 
#define PROP_set_value_char_at_msg   "PROP_set_value_char_at"
 
#define PROP_set_value_char_msg   "PROP_set_value_char"
 
#define PROP_set_value_chars_msg   "PROP_set_value_chars"
 
#define PROP_set_value_date_at_msg   "PROP_set_value_date_at"
 
#define PROP_set_value_date_msg   "PROP_set_value_date"
 
#define PROP_set_value_dates_msg   "PROP_set_value_dates"
 
#define PROP_set_value_double_at_msg   "PROP_set_value_double_at"
 
#define PROP_set_value_double_msg   "PROP_set_value_double"
 
#define PROP_set_value_doubles_msg   "PROP_set_value_doubles"
 
#define PROP_set_value_int_at_msg   "PROP_set_value_int_at"
 
#define PROP_set_value_int_msg   "PROP_set_value_int"
 
#define PROP_set_value_ints_msg   "PROP_set_value_ints"
 
#define PROP_set_value_logical_at_msg   "PROP_set_value_logical_at"
 
#define PROP_set_value_logical_msg   "PROP_set_value_logical"
 
#define PROP_set_value_logicals_msg   "PROP_set_value_logicals"
 
#define PROP_set_value_string_at_msg   "PROP_set_value_string_at"
 
#define PROP_set_value_string_msg   "PROP_set_value_string"
 
#define PROP_set_value_strings_msg   "PROP_set_value_strings"
 
#define PROP_set_value_tag_at_msg   "PROP_set_value_tag_at"
 
#define PROP_set_value_tag_msg   "PROP_set_value_tag"
 
#define PROP_set_value_tags_msg   "PROP_set_value_tags"
 
#define PROP_UIF_ask_value_msg   "PROP_UIF_ask_value"
 
#define PROP_UIF_set_value_msg   "PROP_UIF_set_value"
 
#define PROP_validate_lov_char_msg   "PROP_validate_lov_char"
 
#define PROP_validate_lov_date_msg   "PROP_validate_lov_date"
 
#define PROP_validate_lov_double_msg   "PROP_validate_lov_double"
 
#define PROP_validate_lov_int_msg   "PROP_validate_lov_int"
 
#define PROP_validate_lov_logical_msg   "PROP_validate_lov_logical"
 
#define PROP_validate_lov_string_msg   "PROP_validate_lov_string"
 
#define PROP_validate_lov_tag_msg   "PROP_validate_lov_tag"
 

Functions

Property Method Utilities

This section defines ITK utilities to use in the writing of property ask, set, and initialization methods. Go to Property Messages for a description of the methods that might be written.

PROPERTY_API int PROP_assign_string (tag_t prop_tag, const char *value)
 
PROPERTY_API int PROP_assign_string_at (tag_t prop_tag, int position, const char *value)
 
PROPERTY_API int PROP_assign_strings (tag_t prop_tag, int num, char **values)
 
PROPERTY_API int PROP_assign_date (tag_t prop_tag, date_t value)
 
PROPERTY_API int PROP_assign_date_at (tag_t prop_tag, int position, date_t value)
 
PROPERTY_API int PROP_assign_dates (tag_t prop_tag, int num, const date_t *values)
 
PROPERTY_API int PROP_assign_double (tag_t prop_tag, double value)
 
PROPERTY_API int PROP_assign_double_at (tag_t prop_tag, int position, double value)
 
PROPERTY_API int PROP_assign_doubles (tag_t prop_tag, int num, const double *values)
 
PROPERTY_API int PROP_assign_int (tag_t prop_tag, int value)
 
PROPERTY_API int PROP_assign_int_at (tag_t prop_tag, int position, int value)
 
PROPERTY_API int PROP_assign_ints (tag_t prop_tag, int num, const int *values)
 
PROPERTY_API int PROP_assign_logical (tag_t prop_tag, logical value)
 
PROPERTY_API int PROP_assign_logical_at (tag_t prop_tag, int position, logical value)
 
PROPERTY_API int PROP_assign_logicals (tag_t prop_tag, int num, const logical *values)
 
PROPERTY_API int PROP_assign_tag (tag_t prop_tag, tag_t value)
 
PROPERTY_API int PROP_assign_tag_at (tag_t prop_tag, int position, tag_t value)
 
PROPERTY_API int PROP_assign_tags (tag_t prop_tag, int num, const tag_t *values)
 
PROPERTY_API int PROP_assign_char (tag_t prop_tag, char value)
 
PROPERTY_API int PROP_assign_char_at (tag_t prop_tag, int position, char value)
 
PROPERTY_API int PROP_assign_chars (tag_t prop_tag, int num, const char *values)
 
PROPERTY_API int PROP_get_value_string (tag_t prop_tag, char **value)
 
PROPERTY_API int PROP_get_value_strings (tag_t prop_tag, int *num, char ***values)
 
PROPERTY_API int PROP_get_value_string_at (tag_t prop_tag, int position, char **value)
 
PROPERTY_API int PROP_get_value_date (tag_t prop_tag, date_t *value)
 
PROPERTY_API int PROP_get_value_dates (tag_t prop_tag, int *num, date_t **values)
 
PROPERTY_API int PROP_get_value_date_at (tag_t prop_tag, int position, date_t *value)
 
PROPERTY_API int PROP_get_value_double (tag_t prop_tag, double *value)
 
PROPERTY_API int PROP_get_value_doubles (tag_t prop_tag, int *num, double **values)
 
PROPERTY_API int PROP_get_value_double_at (tag_t prop_tag, int position, double *value)
 
PROPERTY_API int PROP_get_value_int (tag_t prop_tag, int *value)
 
PROPERTY_API int PROP_get_value_ints (tag_t prop_tag, int *num, int **values)
 
PROPERTY_API int PROP_get_value_int_at (tag_t prop_tag, int position, int *value)
 
PROPERTY_API int PROP_get_value_logical (tag_t prop_tag, logical *value)
 
PROPERTY_API int PROP_get_value_logicals (tag_t prop_tag, int *num, logical **values)
 
PROPERTY_API int PROP_get_value_logical_at (tag_t prop_tag, int position, logical *value)
 
PROPERTY_API int PROP_get_value_tag (tag_t prop_tag, tag_t *value)
 
PROPERTY_API int PROP_get_value_tags (tag_t prop_tag, int *num, tag_t **values)
 
PROPERTY_API int PROP_get_value_tag_at (tag_t prop_tag, int position, tag_t *value)
 
PROPERTY_API int PROP_get_value_char (tag_t prop_tag, char *value)
 
PROPERTY_API int PROP_get_value_chars (tag_t prop_tag, int *num, char **values)
 
PROPERTY_API int PROP_get_value_char_at (tag_t prop_tag, int position, char *value)
 
PROPERTY_API int PROP_ask_relations (tag_t prop_tag, int *num, tag_t **relation_tags)
 
PROPERTY_API int PROP_tag_to_string (tag_t the_tag, char **the_string)
 
PROPERTY_API int PROP_string_to_tag (const char *the_string, tag_t *the_tag)
 

Detailed Description

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

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 prop_msg.h.