ITK Function Reference

(V10000.1.0.60_20160308.00)
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions
Business Modeler Framework

Modules

 BMF Errors
 

Data Structures

struct  BMF_extension_arguments_s
 
struct  ExtensionDescDetail_s
 

Macros

#define BMF_EXECUTE_USER_EXIT_EXTENSIONS(args)
 
#define BMF_IMPLEMENTER_CLASS_DELIMETER   "::"
 

Typedefs

typedef struct
BMF_extension_arguments_s 
BMF_extension_arguments_t
 
typedef enum
BMF_user_exit_process_e 
BMF_user_exit_process_t
 
typedef int(* CPLUSPLUS_EXTENSION )(const char *, METHOD_message_t *, va_list)
 
typedef struct
ExtensionDescDetail_s 
ExtensionDescDetail_t
 
typedef enum ExtensionLangType_e ExtensionLangType_t
 
typedef enum ExtensionPointType_e ExtensionPointType_t
 

Enumerations

enum  BMF_user_exit_process_e { BMF_UE_CONTINUE, BMF_USER_EXIT_RETURN, BMF_USER_EXIT_ERROR }
 
enum  ExtensionLangType_e {
  extensionLangType_unknown, extensionLangType_c, extensionLangType_c_plusplus, extensionLangType_java,
  extensionLangType_script, extensionLangType_dotnet
}
 
enum  ExtensionPointType_e {
  ExtensionPointType_Unknown, ExtensionPointType_PreCondition, ExtensionPointType_PreAction, ExtensionPointType_Post,
  ExtensionPointType_Base
}
 

Functions

ITK_API int BMF_get_user_params (METHOD_message_t *msg, int *ext_param_cnt, BMF_extension_arguments_t **ext_params)
 
ITK_API int BMF_process_userexit (char *typeName, char *propName, char *msgName,...)
 

Maximum BMF sizes

#define BMF_NAME_size_c   32
 
#define BMF_TYPE_size_c   32
 
#define BMF_PROP_NAME_size_c   132
 
#define BMF_LIB_NAME_size_c   64
 
#define BMF_MESSAGE_NAME_size_c   1024
 
#define BMF_CONDITION_size_c   132
 
#define BMF_EXTENSION_NAME_size_c   132
 
#define BMF_VALIDITY_size_c   1280
 
#define BMF_EXTENSION_ARGNAME_size_c   64
 
#define BMF_EXTENSION_STRGVAL_size_c   64
 

BMF Class Names

#define BMOperationClassName   "BMOperation"
 
#define ExtensionClassName   "Extension"
 
#define ExtensionDescriptorClassName   "ExtensionDescriptor"
 
#define ExtensionPointClassName   "ExtensionPoint"
 
#define PropertyBMOperationClassName   "PropertyBMOperation"
 
#define TypeBMOperationClassName   "TypeBMOperation"
 
#define EXTENSION_POINT_PRECONDITION_STR   "pre-condition"
 
#define EXTENSION_POINT_PREACTION_STR   "pre-action"
 
#define EXTENSION_POINT_BASEACTION_STR   "base"
 
#define EXTENSION_POINT_POSTACTION_STR   "post-action"
 

BMF Preferences

#define BMF_BYPASS_ALL_EXTENSION_RULES_PREF   "BMF_BYPASS_ALL_EXTENSION_RULES"
 
#define BMF_CLASS_AND_TYPE_DISPLAY_LIST_PREF   "BMF_CLASS_AND_TYPE_DISPLAY_LIST"
 
#define BMF_CUSTOM_IMPLEMENTOR_PATH_PREF   "BMF_CUSTOM_IMPLEMENTOR_PATH"
 
#define BMF_ENABLE_DEBUG_PREF   "BMF_ENABLE_DEBUG"
 
#define BMF_SUPPRESS_ACTION_RULES_DISPLAY_PREF   "BMF_SUPPRESS_ACTION_RULES_DISPLAY"
 
#define BMF_USE_BMF_PREF   "BMF_USE_BMF"
 
#define BMF_LOAD_IND_OBJECT_PREF   "BMF_LOAD_IND_OBJECT"
 

Detailed Description

Macro Definition Documentation

#define BMF_BYPASS_ALL_EXTENSION_RULES_PREF   "BMF_BYPASS_ALL_EXTENSION_RULES"

Definition at line 65 of file bmf.h.

#define BMF_CLASS_AND_TYPE_DISPLAY_LIST_PREF   "BMF_CLASS_AND_TYPE_DISPLAY_LIST"

Definition at line 66 of file bmf.h.

#define BMF_CONDITION_size_c   132

Definition at line 37 of file bmf.h.

#define BMF_CUSTOM_IMPLEMENTOR_PATH_PREF   "BMF_CUSTOM_IMPLEMENTOR_PATH"

Definition at line 67 of file bmf.h.

#define BMF_ENABLE_DEBUG_PREF   "BMF_ENABLE_DEBUG"

Definition at line 68 of file bmf.h.

#define BMF_EXECUTE_USER_EXIT_EXTENSIONS (   args)
Value:
{\
int bmf_stat = BMF_UE_CONTINUE; \
bmf_stat = BMF_process_userexit args;\
if (bmf_stat == BMF_USER_EXIT_RETURN ) \
return ITK_ok; \
else if (bmf_stat == BMF_USER_EXIT_ERROR ) { EMH_ask_last_error(&bmf_stat); return bmf_stat;}\
}

Definition at line 130 of file bmf.h.

#define BMF_EXTENSION_ARGNAME_size_c   64

Definition at line 40 of file bmf.h.

#define BMF_EXTENSION_NAME_size_c   132

Definition at line 38 of file bmf.h.

#define BMF_EXTENSION_STRGVAL_size_c   64

Definition at line 41 of file bmf.h.

#define BMF_IMPLEMENTER_CLASS_DELIMETER   "::"

Definition at line 74 of file bmf.h.

#define BMF_LIB_NAME_size_c   64

Definition at line 35 of file bmf.h.

#define BMF_LOAD_IND_OBJECT_PREF   "BMF_LOAD_IND_OBJECT"

Definition at line 71 of file bmf.h.

#define BMF_MESSAGE_NAME_size_c   1024

Definition at line 36 of file bmf.h.

#define BMF_NAME_size_c   32

BMF_MESSAGE_NAME_size_c has been increased to 1024 due to meta operationID requirement. BMF_VALIDITY_size_c has been increased to 1280 due to same

Definition at line 32 of file bmf.h.

#define BMF_PROP_NAME_size_c   132

Definition at line 34 of file bmf.h.

#define BMF_SUPPRESS_ACTION_RULES_DISPLAY_PREF   "BMF_SUPPRESS_ACTION_RULES_DISPLAY"

Definition at line 69 of file bmf.h.

#define BMF_TYPE_size_c   32

Definition at line 33 of file bmf.h.

#define BMF_USE_BMF_PREF   "BMF_USE_BMF"

Definition at line 70 of file bmf.h.

#define BMF_VALIDITY_size_c   1280

Definition at line 39 of file bmf.h.

#define BMOperationClassName   "BMOperation"

Definition at line 48 of file bmf.h.

#define EXTENSION_POINT_BASEACTION_STR   "base"

Definition at line 57 of file bmf.h.

#define EXTENSION_POINT_POSTACTION_STR   "post-action"

Definition at line 58 of file bmf.h.

#define EXTENSION_POINT_PREACTION_STR   "pre-action"

Definition at line 56 of file bmf.h.

#define EXTENSION_POINT_PRECONDITION_STR   "pre-condition"

Definition at line 55 of file bmf.h.

#define ExtensionClassName   "Extension"

Definition at line 49 of file bmf.h.

#define ExtensionDescriptorClassName   "ExtensionDescriptor"

Definition at line 50 of file bmf.h.

#define ExtensionPointClassName   "ExtensionPoint"

Definition at line 51 of file bmf.h.

#define PropertyBMOperationClassName   "PropertyBMOperation"

Definition at line 52 of file bmf.h.

#define TypeBMOperationClassName   "TypeBMOperation"

Definition at line 53 of file bmf.h.

Typedef Documentation

Stucture for storing the extionsion user arguments

Enumeration for BMF User Exit Processes

typedef int(* CPLUSPLUS_EXTENSION)(const char *, METHOD_message_t *, va_list)

Definition at line 139 of file bmf.h.

Enumeration for Extension Language Type

Enumeration for Extension Point Type Operation

Enumeration Type Documentation

Enumeration for BMF User Exit Processes

Enumerator
BMF_UE_CONTINUE 
BMF_USER_EXIT_RETURN 
BMF_USER_EXIT_ERROR 

Definition at line 110 of file bmf.h.

Enumeration for Extension Language Type

Enumerator
extensionLangType_unknown 
extensionLangType_c 
extensionLangType_c_plusplus 
extensionLangType_java 
extensionLangType_script 
extensionLangType_dotnet 

Definition at line 88 of file bmf.h.

Enumeration for Extension Point Type Operation

Enumerator
ExtensionPointType_Unknown 
ExtensionPointType_PreCondition 
ExtensionPointType_PreAction 
ExtensionPointType_Post 
ExtensionPointType_Base 

Definition at line 77 of file bmf.h.

Function Documentation

ITK_API int BMF_get_user_params ( METHOD_message_t msg,
int *  ext_param_cnt,
BMF_extension_arguments_t **  ext_params 
)

This function is used for extracting the user arguments from the message.(OF)

Parameters
msg(I)
ext_param_cnt(O)
ITK_API int BMF_process_userexit ( char *  typeName,
char *  propName,
char *  msgName,
  ... 
)

This is an unpublished ITK function and should not be used directly. This function can change without notice.

Parameters
typeName(I)
propName(I)
msgName(I)