VerificationManagementServices.hxx File Reference

#include <string>
#include <vector>
#include <map>
#include <unidefs.h>
#include <pom/pom/pom.h>
#include <Crt0ValidationContract/libcrt0validationcontract_exports.h>
#include <Crt0ValidationContract/libcrt0validationcontract_undef.h>

Go to the source code of this file.

Classes
struct	ParameterInfo

Typedefs
typedef struct ParameterInfo	ParameterInfo_t

Enumerations
enum	ParameterType {   SOURCE_ATTRIBUTE = 1, OVERRIDDEN_ATTRIBUTE = 2, INPUT_ATTRIBUTE = 4, OUTPUT_ATTRIBUTE = 8,   UNUSED_ATTRIBUTE = 16, SYNC_CANDIDATE = 32, OUTPUTATTR_PUBLISHCANDIDATE = 64, OUTPUTATTR_PUBLISHED = 128,   NOTAPPLICABLE_ATTRIBUTE = 256 }

Functions
int	getVRParameters (const tag_t verificationRequestTag, const std::vector< tag_t > &assignedObjects, const std::vector< std::string > &options, std::map< tag_t, std::vector< ParameterInfo_t >> &parentObjectToInputOutputParametersMap, std::vector< ParameterInfo_t > &vrParameterInfo)

Detailed Description

This file provides APIs for Verification Management module.

Definition in file VerificationManagementServices.hxx.

Typedef Documentation

typedef struct ParameterInfo ParameterInfo_t

Structure of VR parameter information.

Enumeration Type Documentation

enum ParameterType

Specifies the type for a Measurable Attribute

Enumerator
SOURCE_ATTRIBUTE	Source Attribute for Input Attribute.
OVERRIDDEN_ATTRIBUTE	Overriden Attribute.
INPUT_ATTRIBUTE	Input Attribute.
OUTPUT_ATTRIBUTE	Output Attribute.
UNUSED_ATTRIBUTE	Unused Attribute.
SYNC_CANDIDATE	Attribute is candidate for Sync.
OUTPUTATTR_PUBLISHCANDIDATE	Attribute is candidate for Publish.
OUTPUTATTR_PUBLISHED	Attribute is Published.
NOTAPPLICABLE_ATTRIBUTE	Attribute type not applicable.

Definition at line 35 of file VerificationManagementServices.hxx.

Function Documentation

int getVRParameters	(	const tag_t	verificationRequestTag,
		const std::vector< tag_t > &	assignedObjects,
		const std::vector< std::string > &	options,
		std::map< tag_t, std::vector< ParameterInfo_t >> &	parentObjectToInputOutputParametersMap,
		std::vector< ParameterInfo_t > &	vrParameterInfo
	)

Returns all the Parameters added to Verification Request.

Returns

• #ITK_ok if there are no error in processing.

(O) List of all Parameters in the VR. Each entry in the vector has all the information about the Parameter like its result and the parent object

Parameters

verificationRequestTag	(I) Verification Request tag to get Parameters from.
assignedObjects	(I) If empty then Parameters from all assigned objects will be returned. If not empty then Parameters from only given objects will be returned. The object type can be WSO or BOMLine
options	(I) If "PopulateMappedParameters" is part of the options list then system will find the Mapped Parameters and will populate Mapped Mapped Parameter information in the parentObjectToInputOutputAttrsMap. If "HideMappedParameters" is part of the options list then seprate "MeasurableAttrData" object will not be returned for Mapped Parameters
parentObjectToInputOutputParametersMap	(O) Key is the object added to VR which can be WSO or BOMLine and value is information about all the Parameters for that perticular object