Property Messages
[Properties]

Detailed Description

This section documents messages that are used to implement asking and setting property values. Each message is a defined action performed on a specified property type (e.g., ask value of a string, set value of a logical).

Methods A method is an implementation of a message. Each of the messages documented in this section has an associated default method. Calling a message that is implemented via the default method is referred to as default message behavior.

Methods ITK In Teamcenter Engineering, default message behavior can be customized by registering new methods against the message. Adding a new method to a message overrides the default method each time the message is called. This is significant because Teamcenter Engineering calls many of the messages documented in this section internally. Therefore, modifying the default behavior of any message not only affects ITK behavior but also potentially affects Workspace, PSE, etc. Go to Methods for additional information about customizing default behavior using methods ITK.

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)

Defines

#define PROP_ask_value_string_msg "PROP_ask_value_string"
#define PROP_ask_value_strings_msg "PROP_ask_value_strings"
#define PROP_ask_value_string_at_msg "PROP_ask_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_ask_value_char_msg "PROP_ask_value_char"
#define PROP_ask_value_chars_msg "PROP_ask_value_chars"
#define PROP_ask_value_char_at_msg "PROP_ask_value_char_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_date_at_msg "PROP_ask_value_date_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_double_at_msg "PROP_ask_value_double_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_int_at_msg "PROP_ask_value_int_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_logical_at_msg "PROP_ask_value_logical_at"
#define PROP_ask_value_tag_msg "PROP_ask_value_tag"
#define PROP_ask_value_tags_msg "PROP_ask_value_tags"
#define PROP_ask_value_tag_at_msg "PROP_ask_value_tag_at"
#define PROP_set_value_string_at_msg "PROP_set_value_string_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_char_at_msg "PROP_set_value_char_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_date_at_msg "PROP_set_value_date_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_double_at_msg "PROP_set_value_double_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_int_at_msg "PROP_set_value_int_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_logical_at_msg "PROP_set_value_logical_at"
#define PROP_set_value_tag_msg "PROP_set_value_tag"
#define PROP_set_value_tags_msg "PROP_set_value_tags"
#define PROP_set_value_tag_at_msg "PROP_set_value_tag_at"
#define PROP_is_modifiable_msg "PROP_is_modifiable"
#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"
#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 Documentation

#define PROP_ask_lov_chars_msg "PROP_ask_lov_chars"

Ask allowable values as chars which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	char**	values The allowable values

Definition at line 574 of file prop_msg.h.

#define PROP_ask_lov_dates_msg "PROP_ask_lov_dates"

Ask allowable values as dates which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	date_t**	values The allowable values

Definition at line 584 of file prop_msg.h.

#define PROP_ask_lov_doubles_msg "PROP_ask_lov_doubles"

Ask allowable values as doubles which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	double**	values The allowable values

Definition at line 594 of file prop_msg.h.

#define PROP_ask_lov_ints_msg "PROP_ask_lov_ints"

Ask allowable values as ints which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	int**	values The allowable values

Definition at line 604 of file prop_msg.h.

#define PROP_ask_lov_logicals_msg "PROP_ask_lov_logicals"

Ask allowable values as logicals which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	logical**	values The allowable values

Definition at line 614 of file prop_msg.h.

#define PROP_ask_lov_strings_msg "PROP_ask_lov_strings"

Ask allowable values as strings which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	char***	values The allowable values

Definition at line 624 of file prop_msg.h.

#define PROP_ask_lov_tags_msg "PROP_ask_lov_tags"

Ask allowable values as tags which are able to set into this property

Parameters:

	tag_t	prop_tag The tag of the property
	LOV_usage_t*	usage The usage of allowable values
	int*	n_values The count of allowable values
	tag_t**	values The allowable values

Definition at line 634 of file prop_msg.h.

#define PROP_ask_value_char_at_msg "PROP_ask_value_char_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_char_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	char*	values The char value of a property at a particular index position

Definition at line 129 of file prop_msg.h.

#define PROP_ask_value_char_msg "PROP_ask_value_char"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_char.

Parameters:

	tag_t	prop_tag The tag of the property
	char*	value The char value of a single-valued property

Definition at line 107 of file prop_msg.h.

#define PROP_ask_value_chars_msg "PROP_ask_value_chars"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_chars.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	char**	values The char values of single-valued or multi-valued property

Definition at line 119 of file prop_msg.h.

#define PROP_ask_value_date_at_msg "PROP_ask_value_date_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_date_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	date_t*	value The date value of a multi-valued property at a particular index position

Definition at line 159 of file prop_msg.h.

#define PROP_ask_value_date_msg "PROP_ask_value_date"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_date.

Parameters:

	tag_t	prop_tag The tag of the property
	date_t*	value The date value of a single-valued property

Definition at line 137 of file prop_msg.h.

#define PROP_ask_value_dates_msg "PROP_ask_value_dates"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_dates.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	date_t**	values The date values of a single-valued or multi-valued property

Definition at line 149 of file prop_msg.h.

#define PROP_ask_value_double_at_msg "PROP_ask_value_double_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_double_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	double*	value The double value of a multi-valued property at a particular index position

Definition at line 189 of file prop_msg.h.

#define PROP_ask_value_double_msg "PROP_ask_value_double"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_double.

Parameters:

	tag_t	prop_tag The tag of the property
	double*	value The double value of a single-valued property

Definition at line 167 of file prop_msg.h.

#define PROP_ask_value_doubles_msg "PROP_ask_value_doubles"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_doubles.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	double**	values The double values of a single-valued or multi-valued property

Definition at line 179 of file prop_msg.h.

#define PROP_ask_value_int_at_msg "PROP_ask_value_int_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_int_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	int*	value The int value of a multi-valued property at a particular index position

Definition at line 219 of file prop_msg.h.

#define PROP_ask_value_int_msg "PROP_ask_value_int"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_int.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	value The int value of a single-valued property

Definition at line 197 of file prop_msg.h.

#define PROP_ask_value_ints_msg "PROP_ask_value_ints"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_ints.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	int**	values The int values of a single-valued or multi-valued property

Definition at line 209 of file prop_msg.h.

#define PROP_ask_value_logical_at_msg "PROP_ask_value_logical_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_logical_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	logical*	value The logical value of a multi-valued property at a particular index position

Definition at line 249 of file prop_msg.h.

#define PROP_ask_value_logical_msg "PROP_ask_value_logical"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_logical.

Parameters:

	tag_t	prop_tag The tag of the property
	logical*	value The logical value of a single-valued property

Definition at line 227 of file prop_msg.h.

#define PROP_ask_value_logicals_msg "PROP_ask_value_logicals"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_logicals.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	logical**	values The logical values of a single-valued or multi-valued property

Definition at line 239 of file prop_msg.h.

#define PROP_ask_value_string_at_msg "PROP_ask_value_string_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_string_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	char**	values The string value of a multi-valued property at a particular index position

Definition at line 81 of file prop_msg.h.

#define PROP_ask_value_string_msg "PROP_ask_value_string"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_string.

Parameters:

	tag_t	prop_tag The tag of the property
	char**	value The string value of a single-valued property

Definition at line 59 of file prop_msg.h.

#define PROP_ask_value_strings_msg "PROP_ask_value_strings"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_strings.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	char***	values One or more string values of a property

Definition at line 71 of file prop_msg.h.

#define PROP_ask_value_tag_at_msg "PROP_ask_value_tag_at"

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_ask_value_tag_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	tag_t*	value The tag value of a multi-valued property at a particular index position

Definition at line 279 of file prop_msg.h.

#define PROP_ask_value_tag_msg "PROP_ask_value_tag"

Asks value of a single-valued property. The property cannot be an array or list. This message is called by PROP_ask_value_tag.

Parameters:

	tag_t	prop_tag The tag of the property
	tag_t*	value The tag value of a single-valued property

Definition at line 257 of file prop_msg.h.

#define PROP_ask_value_tags_msg "PROP_ask_value_tags"

Asks one or more values of a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_ask_value_tags.

This message should use MEM_alloc to allocate space for setting * values.

Parameters:

	tag_t	prop_tag The tag of the property
	int*	num The count of values
	tag_t**	values The tag values of a single-valued or multi-valued property

Definition at line 269 of file prop_msg.h.

#define PROP_is_modifiable_msg "PROP_is_modifiable"

Indicates whether a property can be modified by the user. Is called by PROP_is_modifiable, or whenever an attempt is made to set the value of a property.

A default method for this message is registered for properties automatically. The default checks if the property descriptor is set to PROP_write and if the user has permission to write to the object the property instance is describing.

A programmer can register a post-action to the default method that does additional checks or a programmer can register a method for this message that does a different set of checks altogether.

Parameters:

	tag_t	prop_tag The tag of the property
	logical*	value The value indicating whether a property can be modified by the user

Definition at line 472 of file prop_msg.h.

#define PROP_set_value_char_at_msg "PROP_set_value_char_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_char_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	char	value The char value at a particular index position of a multi-valued property

Definition at line 317 of file prop_msg.h.

#define PROP_set_value_char_msg "PROP_set_value_char"

Sets value on a single-valued property. This message is called by PROP_set_value_char.

Parameters:

	tag_t	prop_tag The tag of the property
	char	value The char value on a single-valued property

Definition at line 297 of file prop_msg.h.

#define PROP_set_value_chars_msg "PROP_set_value_chars"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_chars.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	char* values The values of a multi-valued property from a list of char values

Definition at line 307 of file prop_msg.h.

#define PROP_set_value_date_at_msg "PROP_set_value_date_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_date_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	date_t	value The date value at a particular index position of a multi-valued property

Definition at line 345 of file prop_msg.h.

#define PROP_set_value_date_msg "PROP_set_value_date"

Sets value on a single-valued property. This message is called by PROP_set_value_date.

Parameters:

	tag_t	prop_tag The tag of the property
	date_t	value The value of a property from a date value

Definition at line 325 of file prop_msg.h.

#define PROP_set_value_dates_msg "PROP_set_value_dates"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_dates.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	date_t* values The values of a multi-valued property from a list of date values

Definition at line 335 of file prop_msg.h.

#define PROP_set_value_double_at_msg "PROP_set_value_double_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_double_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	position The position of value
	double	value The double value at a particular index position of a multi-valued property

Definition at line 373 of file prop_msg.h.

#define PROP_set_value_double_msg "PROP_set_value_double"

Sets value on a single-valued property. This message is called by PROP_set_value_double.

Parameters:

	tag_t	prop_tag The tag of the property
	double	value The value of a property from a double value

Definition at line 353 of file prop_msg.h.

#define PROP_set_value_doubles_msg "PROP_set_value_doubles"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_doubles.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	double* values The values of a multi-valued property from a list of double values

Definition at line 363 of file prop_msg.h.

#define PROP_set_value_int_at_msg "PROP_set_value_int_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_int_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	int	value The int value at a particular index position of a multi-valued property

Definition at line 401 of file prop_msg.h.

#define PROP_set_value_int_msg "PROP_set_value_int"

Sets value on a single-valued property. This message is called by PROP_set_value_int.

Parameters:

	tag_t	prop_tag The tag of the property
	int	value The value of a property from a int value

Definition at line 381 of file prop_msg.h.

#define PROP_set_value_ints_msg "PROP_set_value_ints"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_ints.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	int* values The values of a multi-valued property from a list of int values

Definition at line 391 of file prop_msg.h.

#define PROP_set_value_logical_at_msg "PROP_set_value_logical_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_logical_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	pos The position of value
	logical	value The logical value at a particular index position of a multi-valued property

Definition at line 429 of file prop_msg.h.

#define PROP_set_value_logical_msg "PROP_set_value_logical"

Sets value on a single-valued property. This message is called by PROP_set_value_logical.

Parameters:

	tag_t	prop_tag The tag of the property
	logical	value The value of a property from a logical value

Definition at line 409 of file prop_msg.h.

#define PROP_set_value_logicals_msg "PROP_set_value_logicals"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_logicals.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	logical* values The values of a multi-valued property from a list of logical values

Definition at line 419 of file prop_msg.h.

#define PROP_set_value_string_at_msg "PROP_set_value_string_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_string_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	position The position of value
	const	char* value The character string value of a multi-valued property at a particular index position

Definition at line 289 of file prop_msg.h.

#define PROP_set_value_string_msg "PROP_set_value_string"

Sets value on a single-valued property. This message is called by PROP_set_value_string.

Parameters:

	tag_t	prop_tag The tag of the property
	const	char* value The string value on a single-valued property

Definition at line 89 of file prop_msg.h.

#define PROP_set_value_strings_msg "PROP_set_value_strings"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_strings.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	char**	values One or more string values on a property

Definition at line 99 of file prop_msg.h.

#define PROP_set_value_tag_at_msg "PROP_set_value_tag_at"

Sets value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0. This message is called by PROP_set_value_tag_at.

Parameters:

	tag_t	prop_tag The tag of the property
	int	position The position of value
	tag_t	value The tag value at a particular index position of a multi-valued property

Definition at line 457 of file prop_msg.h.

#define PROP_set_value_tag_msg "PROP_set_value_tag"

Sets value on a single-valued property. This message is called by PROP_set_value_tag.

Parameters:

	tag_t	prop_tag The tag of the property
	tag_t	value The value of a property from a tag value

Definition at line 437 of file prop_msg.h.

#define PROP_set_value_tags_msg "PROP_set_value_tags"

Sets one or more values on a property. The property can be single-valued or multi-valued (i.e., array or list). This message is called by PROP_set_value_tags.

Parameters:

	tag_t	prop_tag The tag of the property
	int	num The count of values
	const	tag_t* values The values of a multi-valued property from a list of tag values

Definition at line 447 of file prop_msg.h.

#define PROP_UIF_ask_value_msg "PROP_UIF_ask_value"

Asks display value of any type of property. This message is called by AOM_UIF_ask_value and determines the way a particular property type is displayed in Workspace, PSE, Properties dialog box and Objects dialog box.

Note:: This method is responsible for insuring that the ask method corresponding to the fundamental value type of the property is not circumvented. For example if the value type of the property is PROP_int, then PROP_ask_value_int should be used.

Parameters:

	tag_t	prop_tag The tag of the property
	char**	d_value The display value of a property

Definition at line 485 of file prop_msg.h.

#define PROP_UIF_set_value_msg "PROP_UIF_set_value"

Sets the value of any type of property using a display value as input. This message is called by AOM_UIF_set_value and is used for setting the value of a property from some function that deals with display values. Internally, Teamcenter Engineering calls this when the user sets a value from the Properties dialog box, Workspace or PSE.

Note:: This method is responsible for insuring that the set method corresponding to the fundamental value type of the property is not circumvented. For example, if the value type of the property is PROP_int, then PROP_set_value_int should be used.

Parameters:

	tag_t	prop_tag The tag of the property
	const	char* value The value of a property from a string, regardless of the fundamental property value type

Definition at line 501 of file prop_msg.h.

#define PROP_validate_lov_char_msg "PROP_validate_lov_char"

Validate Value of a Property as a char by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	char	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 510 of file prop_msg.h.

#define PROP_validate_lov_date_msg "PROP_validate_lov_date"

Validate Value of a Property as a date by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	date_t	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 519 of file prop_msg.h.

#define PROP_validate_lov_double_msg "PROP_validate_lov_double"

Validate Value of a Property as a double by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	double	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 528 of file prop_msg.h.

#define PROP_validate_lov_int_msg "PROP_validate_lov_int"

Validate Value of a Property as a int by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	int	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 537 of file prop_msg.h.

#define PROP_validate_lov_logical_msg "PROP_validate_lov_logical"

Validate Value of a Property as a logical by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	logical	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 546 of file prop_msg.h.

#define PROP_validate_lov_string_msg "PROP_validate_lov_string"

Validate Value of a Property as a string by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	char*	value The value to be validated
	logical*	verdict Indicates if value is settable

Definition at line 555 of file prop_msg.h.

#define PROP_validate_lov_tag_msg "PROP_validate_lov_tag"

Validate Value of a Property as a tag by LOV

Parameters:

	tag_t	prop_tag The tag of the property
	tag_t	value The value to be validated
	logical*	verdict Tndicates if value is settable

Definition at line 564 of file prop_msg.h.

Function Documentation

PROPERTY_API int PROP_ask_relations	(	tag_t	prop_tag,
		int *	num,
		tag_t **	relation_tags
	)

Asks for the ImanRelations used by a Relation property. This is to enable the programmer to use the GRM ITK calls on those relations.

This can only be used for properties of property type PROP_relation.

The reason there are multiple relation_tags for a single relation property is because a relation property represents a particular relation type on a particular type. An object of a particular type may be related to several objects through a particular relation type, each using a separate ImanRelation.

For example, an ItemRevision might have two datasets related to it through a relationship or type specification. Each dataset is related to the ItemRevision using a separate ImanRelation instance.

Note:: This function is not supported after version 10.0. Use AOM_ask_relations instead.

Parameters:

prop_tag	(I) The tag of the property
num	(O) Number of relation_tags returned
relation_tags	(OF) num The tags for the ImanRelations used by the property

PROPERTY_API int PROP_assign_char	(	tag_t	prop_tag,
		char	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_char instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_char_at	(	tag_t	prop_tag,
		int	position,
		char	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_char_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_chars	(	tag_t	prop_tag,
		int	num,
		const char *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_chars instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_date	(	tag_t	prop_tag,
		date_t	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_date instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_date_at	(	tag_t	prop_tag,
		int	position,
		date_t	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_date_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_dates	(	tag_t	prop_tag,
		int	num,
		const date_t *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_dates instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_double	(	tag_t	prop_tag,
		double	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_double instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_double_at	(	tag_t	prop_tag,
		int	position,
		double	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_double_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_doubles	(	tag_t	prop_tag,
		int	num,
		const double *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_doubles instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_int	(	tag_t	prop_tag,
		int	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_int instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_int_at	(	tag_t	prop_tag,
		int	position,
		int	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_int_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_ints	(	tag_t	prop_tag,
		int	num,
		const int *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_ints instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_logical	(	tag_t	prop_tag,
		logical	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_logical instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_logical_at	(	tag_t	prop_tag,
		int	position,
		logical	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_logical_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_logicals	(	tag_t	prop_tag,
		int	num,
		const logical *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_logicals instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_string	(	tag_t	prop_tag,
		const char *	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_string instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_string_at	(	tag_t	prop_tag,
		int	position,
		const char *	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_string_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_strings	(	tag_t	prop_tag,
		int	num,
		char **	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_strings instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_assign_tag	(	tag_t	prop_tag,
		tag_t	value
	)

Assigns value to a single-valued property. The property cannot be an array or list.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_tag instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_tag_at	(	tag_t	prop_tag,
		int	position,
		tag_t	value
	)

Assigns value to a multi-valued (i.e., list or array) property at a specified index position. The property can be single-valued if position = 0.

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_tag_at instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
position	(I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value	(I) Actual value assigned to the property

PROPERTY_API int PROP_assign_tags	(	tag_t	prop_tag,
		int	num,
		const tag_t *	values
	)

Assigns one or more values to a property. The property can be single-valued or multi-valued (i.e., array or list).

This function is intended to be called from within a PROP_set_value method in order to store a value in a property after all customized validation and derivation has been completed.

Deprecated:: Use AOM_assign_tags instead

Parameters:

prop_tag	(I) Unique identifier (tag) of the property instance
num	(I) Number of values assigned
values	(I) Actual values assigned to the property. This must be a list or array of characters. If the property is an array, the number of values passed must equal the size of the array.

PROPERTY_API int PROP_get_value_char	(	tag_t	prop_tag,
		char *	value
	)

Returns (gets) a value from a single-valued property. The property cannot be an array or list.