All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface CATIPspValidation
Usage: you can reimplement this interface by deriving the supplied CATEAPspValidation adapter class.
interface CATIPspValidation
Interface base for all types of validation check interfaces.
Should not be implemented.
Role: Base for other validation check interfaces.
Method Index
- o
GetCheckName(CATUnicodeString&,CATUnicodeString&)
- Get the NLS name for the given validation check
- o
GetClassification(CATUnicodeString&)
- Get the validation check classification for this type (e.
- o
GetColumnTitles(CATListValCATUnicodeString&)
- Get the NLS column titles for the given validation type.
- o
GetContextObjectViolationCount(int&)
- Get the number of violation objects (e.
- o
GetContextObjectViolation(int&,CATPspViolationProduct**,CATListPV**)
- Get the violation product and check violation data for the given
context violation index.
- o
GetDocColumnTitles(CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- Get the NLS column titles of the document and the object for a given validation type.
- o
GetValidationChecks(CATListValCATUnicodeString&)
- Get the validation checks associated with this type (e.
- o
GetViolationObjectType(CATUnicodeString&)
- Get the violation object type
- o
IsAFromToCheck()
- Determine if the validation type has FROM/TO validation checks.
- o
IsAnIntegrationCheck()
- Determine if the validation type has integration validation checks.
- o
IsMemberAViolation(CATIPspGroup*,CATIUnknownList*,IUnknown*,CATListValCATUnicodeString&,CATListPV**,unsigned int&)
- Is the group members in violation with any of the given validation checks?
- o
IsObjectAViolation(CATBaseUnknown*,CATListValCATUnicodeString&,CATListPV**,unsigned int&)
- Is the object in violation with any of the given validation checks?
- o
LogContextObject(CATBaseUnknown*,unsigned int&)
- If this object is applicable for this check, then retain this object for
post-processing.
Methods
o GetCheckName
| public virtual GetCheckName( | const | iCheck, |
| | oName) |
-
Get the NLS name for the given validation check
- Parameters:
-
- iCheck
- The validation check (e.g. Spec01)
- oName
- The validation check name (e.g. Out-of-spec )
- Returns:
- HRESULT S_OK if oName is non-blank
o GetClassification
| public virtual GetClassification( | | oClassification) |
-
Get the validation check classification for this type (e.g. Object)
- Parameters:
-
- oClassification
- The validation check classification
- Returns:
- HRESULT S_OK if oClassification is non-blank
o GetColumnTitles
| public virtual GetColumnTitles( | | oTitles) |
-
Get the NLS column titles for the given validation type. The data
return is specific to the validation type does NOT include the
column titles for the violation object.
- Parameters:
-
- oTitles
- The column titles (e.g. Part Spec Line Spec )
- Returns:
- HRESULT S_OK if oTitles is not empty
o GetContextObjectViolationCount
| public virtual GetContextObjectViolationCount( | | oNumber) |
-
Get the number of violation objects (e.g. CATPspViolationProduct) that
will be generated as a result of this validation check. This method
must be execute after the whole context has been processed through
LogContextObject method.
- Parameters:
-
- oNumber
- The number of violation products to be generated.
- Returns:
- HRESULT S_OK if oNumber > 0
o GetContextObjectViolation
| public virtual GetContextObjectViolation( | const | iIndex, |
| | oProduct, |
| | oViolation) |
-
Get the violation product and check violation data for the given
context violation index.
- Parameters:
-
- iIndex
- Violation index beginning with 1
- oProduct
- CATPspViolationProduct identification record. This record excludes
any violation checks.
- oViolation
- The check violation, CATPspCheckViolation, information. Delete array
when done.
- Returns:
- HRESULT S_OK check violation returned
E_FAIL invalid input or no violation found
o GetDocColumnTitles
| public virtual GetDocColumnTitles( | | oDocTitles, |
| | oObjectTitles) |
-
Get the NLS column titles of the document and the object for a given validation type.
There is a one to one relation between oDocTitles and oObjectTitles
(for each title listed in oDocTitles, there must be a title in oObjectTitles.)
- Parameters:
-
- oDocTitles
- The column titles for the documents (e.g. "Document Name", "Function Document Name")
The documents listed in this column will be available for viewing when the report is shown.
- oObjectTitles
- The column titles for the object to be reframed (e.g. "Part Instance Name")
The object listed in this column will be reframed. If there is no object to be reframed,
a null should be appended to oObjectTitles.
- Returns:
- HRESULT S_OK if oDocTitles and oObjectTitles are not empty
o GetValidationChecks
| public virtual GetValidationChecks( | | oChecks) |
-
Get the validation checks associated with this type (e.g. Spec01, Spec02)
- Parameters:
-
- oChecks
- The list of validation checks
- Returns:
- HRESULT S_OK if checks exist; E_FAIL no checks exist
o GetViolationObjectType
| public virtual GetViolationObjectType( | | oType) |
-
Get the violation object type
- Parameters:
-
- oType
- The violation object type
- Returns:
- HRESULT S_OK if oType is non-blank
o IsAFromToCheck
| public virtual IsAFromToCheck( | ) |
-
Determine if the validation type has FROM/TO validation checks.
- Returns:
- HRESULT S_OK Is a FROM/TO check; else FALSE
o IsAnIntegrationCheck
| public virtual IsAnIntegrationCheck( | ) |
-
Determine if the validation type has integration validation checks.
- Returns:
- HRESULT S_OK Is an integration check; else FALSE
o IsMemberAViolation
| public virtual IsMemberAViolation( | const | iGroup, |
| const | iMembers, |
| const | iObject, |
| const | iChecks, |
| | oViolation, |
| const | iErrorFile | = 0 ) |
-
Is the group members in violation with any of the given validation checks?
- Parameters:
-
- iMembers
- iGroup's members.
- iObject
- The group member being processed
- iChecks
- The list of check to be processed
- oViolation
- The check violation, CATPspCheckViolation, information. Delete array
when done.
- iErrorFile
- The file descriptor to the opened error file.
- Returns:
- HRESULT S_OK iObject violated at least one check
S_FALSE iObject did not violate any checks or not applicable for check
E_FAIL invalid input or error found such that check can not be performed
o IsObjectAViolation
| public virtual IsObjectAViolation( | const | iObject, |
| const | iChecks, |
| | oViolation, |
| const | iErrorFile | = 0 ) |
-
Is the object in violation with any of the given validation checks?
- Parameters:
-
- iObject
- The object to be checked
- iChecks
- The list of check to be processed
- oViolation
- The check violation, CATPspCheckViolation, information. Delete array
when done.
- iErrorFile
- The file descriptor to the opened error file.
- Returns:
- HRESULT S_OK iObject violated at least one check
S_FALSE iObject did not violate any checks or not applicable for check
E_FAIL invalid input or error found such that check can not be performed
o LogContextObject
| public virtual LogContextObject( | const | iObject, |
| const | iErrorFile | =0 ) |
-
If this object is applicable for this check, then retain this object for
post-processing. This object will be processed through the validation
check.
- Parameters:
-
- iObject
- The object to be checked
- iErrorFile
- The file descriptor to the opened error file.
- Returns:
- HRESULT E_FAIL invalid input or error found such that check can not be performed;
otherwise S_OK
This object is included in the file: CATIPspValidation.h