Namespaces
namespace	Teamcenter
	A convenient C++ class to manage a list of tag_t. This convenient class is derived from TagList class which is only available for internal developers.

Classes
class	Teamcenter::MfgValidationTestFrameworkAdapter

class	Teamcenter::MfgValidationTestSuite

struct	ValidationTestResult

Typedefs
typedef std::multimap < std::string, std::string >	ValidationTestTypeToValidationTestMMapType

Manufacturing Validation API data types
typedef std::map< tag_t, std::vector< tag_t > >	InputObjectToFoundObjectsMap

typedef std::map< tag_t, std::vector < ValidationTestResult > >	TestedObjectToValidationResultsMap

const int	ValidationTestResult_Pass = 0

const int	ValidationTestResult_Fail = 1

const int	ValidationTestResult_Warning = 2

const int	ValidationTestResult_Caution = 3

const int	ValidationTestResult_NotApplicable = 4

const int	ValidationTestResultMessageType_Info = 0

const int	ValidationTestResultMessageType_Error = 1

const int	ValidationTestResultMessageType_Warning = 2

const int	ValidationTestResultMessageType_Caution = 3

Manufacturing Validation API function definition
typedef int(*	validation_testsuite_callback_fn_t )(const InputObjectToFoundObjectsMap &inputObjectToFoundObjectsMap, const std::vector< std::string > &validationTestNames, std::vector< std::string > &additionalInfo, TestedObjectToValidationResultsMap &validationTestResults)

Detailed Description

MfgValidationTestFrameworkAdapter

Methods to adapt ITK parameters to mfg validation test framework parameters. Methods to adapt mfg validation test results to ITK validation test results. Methods to adapt mfg validation test results to SOA response form.

This header and its comments are oriented towards a developer writing a Validation Test Suite callback function to be registered with Teamcenter.

Additional Validation Test framework documentation available at Teamcenter Documentation Topic => reference 'TBD'

Terminology :

Validation Test Suite API : the API defined in this file that validation test suite callbacks are written to.

Validation Test Suite : A registered callback function written to the API defined by this file. The validation test suite function contains one or more Validation Tests. A validation test suite is registered to Teamcenter using the 'install_callback' routine. For example: install_callback -u=${TC_USER} -pf=${TC_USER_PASSWD_FILE} -g=dba -mode=create -type=MyMfgValidationsType -library=libmymfgvalidations -function=MyValidationSuiteA -name="My Validation Suite A" install_callback -u=${TC_USER} -pf=${TC_USER_PASSWD_FILE} -g=dba -mode=create -type=MyMfgValidationsType -library=libmymfgvalidations -function=MyValidationSuiteB -name="My Validation Suite B" The -name argument should be meaningful to the end user.

Validation Test : A subfunction within the validation test suite function that performs one validation test. Has a unique name within the Validation Test Suite. The name should be meaningful to an end user.

Validation Test Framework (or Manager) : a component of the Teamcenter server.

Communication with a Validation Test Client:
    a) Processes request for names of Validation Test Suites and contained Validation Test names.
    b) Processes request to execute Validation Test Suites or selected Validation Test(s) within a Validation Test Suite.

Communication with a Validation Test suite function:
    a) Request a list of the contained Validation Test names from a Validation Test Suite function.
    b) Request the Validation Test Suite to run all or a subset of its Validation Tests and return the Validation Test Results. 
    Note - Can run the MfgValidationTestFramework_EP_<ValidationTestSuiteTypeName>_ClosureRule on the input target objects before calling a Validation Test Suite.
            Passes found objects from closure rule to Validation Test Suite function.

Validation Test Client : Currently only EasyPlan . Can request list of Validation Test Suites and Validation Tests. Can request to execute a set of Validation Test Suites or Validation Tests and get associated Validation Test results.

Validation Test Framework Preferences:

Name:  MfgValidationTestFramework_Client_EP_ValidationTestTypes. 
Scope: Site and User Scope
Type:  Array of String 
Description : Each entry is a Manufacturing Validation Test Type that this client can present and handle.
              Each entry must match the the -type argument used during the 'install_callback' for a Validation Test Suite.
Required: Required if specified in MfgValidationTestFramework_Clients 

Name:  MfgValidationTestFramework_EP_<ValidationTestSuiteTypeName>_ClosureRule
Scope: Site and User Scope
Type:  Single String 
Description : Name of Closure Rule.
              <ValidationTestSuiteTypeName> must match the -type argument used during the 'install_callback' for the Validation Test Suite.
      This closure rule is associated with all the manufacturing test suites of this type. This closure rule will be run by the Mfg Test Framework before executing a Validation Test Suite.
      This is a closure rule that is relevant across all validation test suites within a registered type.  Of course, each Mfg Validation Test suite can do any further traversal refinements within its own implementation. 
Required: Optional

Note: In the future the validation test client will be able to select a subset of validation tests within a validation test suite and have only those tests executed. 
      The validation test suite developer should take this into account when designing and implementing the validation test suite implementation.

Typedef Documentation

typedef std::map<tag_t, std::vector<tag_t> > InputObjectToFoundObjectsMap

Defines the input object and associated found objects by closure rule (if specified)

Definition at line 128 of file MfgValidationTestInterface.hxx.

typedef std::map<tag_t, std::vector<ValidationTestResult> > TestedObjectToValidationResultsMap

Defines the tested object and its associated validation test results.

Definition at line 133 of file MfgValidationTestInterface.hxx.

typedef int(* validation_testsuite_callback_fn_t)(const InputObjectToFoundObjectsMap &inputObjectToFoundObjectsMap,const std::vector< std::string > &validationTestNames,std::vector< std::string > &additionalInfo,TestedObjectToValidationResultsMap &validationTestResults)

The API that Validation Test Suite functions must adhere too.

The validation framework creates a key in the inputObjectToFoundObjectsMap for each input object sent from the validation client with an empty found objects vector. If the MfgValidationTestFramework_<client_name>_<ValidationTestSuiteTypeName>_ClosureRule preference exist with a valid closure rule then: The validation framework runs this closure rule against each input target object creating a corresponding found objects vector. The validation framework inserts a [input object,found objects vector] entry in the map.

Definition at line 152 of file MfgValidationTestInterface.hxx.

typedef std::multimap<std::string,std::string> ValidationTestTypeToValidationTestMMapType

Multi map holds validation test type to validation tests info.

Definition at line 34 of file MfgValidationTestSuite.hxx.