mfg_maturity_rule_interface.hxx File Reference

#include <vector>
#include <string>
#include <unidefs.h>
#include <mfg/libmfg_exports.h>
#include <mfg/libmfg_undef.h>

Go to the source code of this file.

Classes
struct	MFG_maturity_property_data_s

Typedefs
typedef int(*	maturity_report_callback_fn_t )(const int ruleID, const tag_t objectScope, const tag_t targetObject, const std::map< std::string, std::string > &ruleAttributes, std::vector< MFG_maturity_property_data_t > &ruleResults)
typedef struct MFG_maturity_property_data_s	MFG_maturity_property_data_t

Typedef Documentation

typedef int(* maturity_report_callback_fn_t)(const int ruleID,const tag_t objectScope,const tag_t targetObject,const std::map< std::string, std::string > &ruleAttributes,std::vector< MFG_maturity_property_data_t > &ruleResults)

The function pointer suggests the parameter a custom API must have for the Maturity Report functionality to work in the application Manufcaturing Process Planner (MPP). The custom API must be registered with teamcenter using install_callback utility. Refer to technical documentation on how this utility is used. Once registered, the Maturity Report functionality will invoke the custom API and use the response in the report. The response must be in specific format as describe below.

• Rule status: One of the property data in the response must have property name as "status" with data type as "string". The acceptable values are "pass","fail" and "error" to suggest the rule status. This property data is required.
• Rule display value: One of the property data in the response may have property name as "statusDisplayValue" with corresponding data type specified. Maturity report functionality does the conversion based on the specfied data type. Refer to technical documentation of Custom Maturity Report on how a specific data type is converted to string and vice-versa. This value is used as display value of the rule in the report. This property data is optional.
• Rule tooltip: One of the property data in the response can may property name as "tooltip" with data type as "string". This value is used as tooltip. This property data is optional.

Note

If any of input parameter is invalid, ruleResults should be empty.

Returns

ITK_ok always

Definition at line 42 of file mfg_maturity_rule_interface.hxx.

typedef struct MFG_maturity_property_data_s MFG_maturity_property_data_t

mfg_maturity_rule_interface.hxx

example for maturity rule registered as a callback function Represents property data containing property name and its corresponding value.

Note

for value, only first member of the vector will be considered.