Constants Framework

Modules
	CONSTANTS Errors

Macros
#define	PROPERTY_CONST_COMPLEXPROPERTY   "ComplexProperty"
#define	PROPERTY_CONST_COPYFROMORIGINAL   "CopyFromOriginal"
#define	PROPERTY_CONST_ENABLED   "Enabled"
#define	PROPERTY_CONST_INITIALVALUE   "InitialValue"
#define	PROPERTY_CONST_MODIFIABLE   "Modifiable"
#define	PROPERTY_CONST_REQUIRED   "Required"
#define	PROPERTY_CONST_TRIM_ZEROS   "Fnd0TrimZeroes"
#define	PROPERTY_CONST_VISIBLE   "Visible"

Functions
CONSTANTS_API int	CONSTANTS_find_type_by_type_constant_value (const char *type_constant_name, const char *attached_value, char **target_type_name)
CONSTANTS_API int	CONSTANTS_get_global_constant_value (const char *constant_name, char **value)
CONSTANTS_API int	CONSTANTS_get_global_constant_values (const char *constant_name, int *n_values, char ***values)
CONSTANTS_API int	CONSTANTS_get_property_constant_value (const char *constant_name, const char *type_name, const char *property_name, char **value)
CONSTANTS_API int	CONSTANTS_get_type_constant_value (const char *constant_name, const char *type_name, char **value)
CONSTANTS_API int	CONSTANTS_is_global_constant_multivalued (const char *constant_name, logical *is_multi_valued)

CONSTANTS Enumerations
enum	CONSTANTSDataType_e { StringDataType =0, ListDataType =1, BooleanDataType =2 }
typedef enum CONSTANTSDataType_e	CONSTANTSDataType_t

Detailed Description

Macro Definition Documentation

#define PROPERTY_CONST_COMPLEXPROPERTY   "ComplexProperty"

Definition at line 47 of file constants.h.

#define PROPERTY_CONST_COPYFROMORIGINAL   "CopyFromOriginal"

Definition at line 49 of file constants.h.

#define PROPERTY_CONST_ENABLED   "Enabled"

Definition at line 45 of file constants.h.

#define PROPERTY_CONST_INITIALVALUE   "InitialValue"

Definition at line 46 of file constants.h.

#define PROPERTY_CONST_MODIFIABLE   "Modifiable"

Definition at line 48 of file constants.h.

#define PROPERTY_CONST_REQUIRED   "Required"

Definition at line 43 of file constants.h.

#define PROPERTY_CONST_TRIM_ZEROS   "Fnd0TrimZeroes"

Definition at line 50 of file constants.h.

#define PROPERTY_CONST_VISIBLE   "Visible"

Definition at line 44 of file constants.h.

Typedef Documentation

typedef enum CONSTANTSDataType_e CONSTANTSDataType_t

Enumeration Type Documentation

enum CONSTANTSDataType_e

Enumerator
StringDataType
ListDataType
BooleanDataType

Definition at line 34 of file constants.h.

Function Documentation

CONSTANTS_API int CONSTANTS_find_type_by_type_constant_value	(	const char *	type_constant_name,
		const char *	attached_value,
		char **	target_type_name
	)

Finds the type by type constant value for the type object.

Returns

ITK_ok always

Parameters

type_constant_name	(I) The type constant name for which the information is desired.
attached_value	(I) The attached value for which the constant information is desired.
target_type_name	(OF) The target type name of the constant.

CONSTANTS_API int CONSTANTS_get_global_constant_value	(	const char *	constant_name,
		char **	value
	)

Get the Global constant value.

Parameters

constant_name	(I) The constant name for which the information is desired.
value	(OF) The current value of the Global Constant.

CONSTANTS_API int CONSTANTS_get_global_constant_values	(	const char *	constant_name,
		int *	n_values,
		char ***	values
	)

Get the Global constant values.

Parameters

constant_name	(I) The constant name for which the information is desired.
n_values	(O) The number of values being returned.
values	(OF) A pointer to the list of values.

CONSTANTS_API int CONSTANTS_get_property_constant_value	(	const char *	constant_name,
		const char *	type_name,
		const char *	property_name,
		char **	value
	)

Get the constant Value for a specific property for the type object.

Parameters

constant_name	(I) The constant name for which the information is desired.
type_name	(I) The business object name for which the constant information is desired.
property_name	(I) The property on the business object for which the constant information is desired.
value	(OF) The current value of the constant.

CONSTANTS_API int CONSTANTS_get_type_constant_value	(	const char *	constant_name,
		const char *	type_name,
		char **	value
	)

Get the constant Value for the type object.

Parameters

constant_name	(I) The constant name for which the information is desired.
type_name	(I) The business object name for which the constant information is desired.
value	(OF) The current value of the constant.

CONSTANTS_API int CONSTANTS_is_global_constant_multivalued	(	const char *	constant_name,
		logical *	is_multi_valued
	)

Check if the Global constant is single or multi valued.

Parameters

constant_name	(I) The constant name for which the information is desired.
is_multi_valued	(O) The value returned here will be "true" if the constant is multivalued, and "false" otherwise.