tccore/method.h File Reference

---

Detailed Description

Method function prototypes

Definition in file method.h.

#include <unidefs.h>
#include <tc/emh.h>
#include <tc/tc_startup.h>
#include <tc/tc_arguments.h>
#include <fclasses/tc_stdarg.h>
#include <tccore/libtccore_exports.h>
#include <tccore/libtccore_undef.h>

Go to the source code of this file.

Data Structures

• struct METHOD_id_s
• struct METHOD_message_s

METHOD Execution Functions

Note:

Execution of registered methods is implemented in Teamcenter core code for all Teamcenter defined messages. ITK is only only required to define custom messages.

• #define METHOD_SETUP_MESSAGE(msg_name, msg_id)
• TCCORE_API int METHOD_get_message_id (const char *msg_name, int *msg_id)
• TCCORE_API int METHOD_get_message_name (int msg_id, char **method_name)
• TCCORE_API int METHOD_get_prop_message_name (int msg_id, const char *property_name, char **method_name)

Defines

• #define METHOD_SETUP_PROP_MESSAGE(msg_name, property_name, msg_id)
• #define METHOD_PROP_MESSAGE_OBJECT(msg, objectTag)   (objectTag) = (msg)->object_tag;
• #define METHOD_PROP_MESSAGE_PROP_NAME(msg, propName)   (propName) = (msg)->prop_name;

Typedefs

• typedef struct METHOD_id_s METHOD_id_t
• typedef struct METHOD_message_s METHOD_message_t
• typedef int(* METHOD_function_t )(METHOD_message_t *, va_list)
• typedef enum METHOD_action_type_e METHOD_action_type_t

Enumerations

• enum METHOD_action_type_e { METHOD_pre_action_type, METHOD_post_action_type }

Functions

• TCCORE_API int METHOD_execute (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_execute_using (tag_t object, tag_t tc_type, int msg_id,...)
• TCCORE_API int METHOD_check_pre_conditions (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_check_pre_conditions_message (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_call_pre_action (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_call_pre_action_message (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_register_prop_method (const char *type_name, const char *property_name, const char *msg_name, METHOD_function_t base_action, TC_argument_list_t *user_args, METHOD_id_t *method_id)
• TCCORE_API int METHOD_find_prop_method (const char *type_name, const char *property_name, const char *msg_name, METHOD_id_t *method_id)
• TCCORE_API int METHOD_get_prop_message_id (const char *msg_name, const char *property_name, int *msg_id)
• TCCORE_API int METHOD_merge_prop_message_id (int merge_msg_id, const char *property_name, int *msg_id)
• TCCORE_API int METHOD__is_prop_registered (tag_t objTag, const char *methodName, const char *propName, logical *registered)
• TCCORE_API int METHOD_call_post_action (tag_t object, int msg_id,...)
• TCCORE_API int METHOD_call_post_action_message (tag_t object, int msg_id,...)
• TCCORE_API int METHOD__register_operationFn (const char *type_name, const char *msg_name, METHOD_function_t base_action, TC_argument_list_t *user_args, METHOD_id_t *method_id)
• TCCORE_API int METHOD__register_prop_operationFn (const char *type_name, const char *property_name, const char *msg_name, METHOD_function_t base_action, TC_argument_list_t *user_args, METHOD_id_t *method_id)

METHOD Registration Functions

• TCCORE_API int METHOD_attach_action (const char *typeName, const char *methodName, int prePostFlag, METHOD_function_t fn, TC_argument_list_t *userData)
• TCCORE_API int METHOD_register_method (const char *type_name, const char *msg_name, METHOD_function_t base_action, TC_argument_list_t *user_args, METHOD_id_t *method_id)
• TCCORE_API int METHOD_add_pre_condition (METHOD_id_t method_id, METHOD_function_t pre_condition_handler, TC_argument_list_t *user_args)
• TCCORE_API int METHOD_add_action (METHOD_id_t method_id, METHOD_action_type_t action_type, METHOD_function_t action_handler, TC_argument_list_t *user_args)
• TCCORE_API int METHOD_add_action2 (METHOD_id_t method_id, METHOD_action_type_t action_type, METHOD_function_t action_handler, TC_argument_list_t *user_args, logical auto_dispatched)
• TCCORE_API int METHOD_find_method (const char *type_name, const char *msg_name, METHOD_id_t *method_id)
• TCCORE_API int METHOD_find_dynamic_method (const char *type_name, const char *msg_name, METHOD_id_t *method_id)