All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Class CATPspCheckViolation
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATPspCheckViolation
Usage: you can derive this class.
public class CATPspCheckViolation
Super class to derive validation check violation object
Role: Meta class
Always subtype from this object
Constructor and Destructor Index
- o
CATPspCheckViolation(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Constructor
Role: Initialize the class.
- o
~CATPspCheckViolation()
-
Method Index
- o
GetCheckViolationData(CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- DO NOT USE -- TO BE DELETED Get the check violation data
- o
GetCheckViolationData(int&,CATListValCATUnicodeString**)
- Get check violation data.
- o
GetDescription(CATUnicodeString&,CATUnicodeString&)
- Get the NLS description for a given key
- o
GetRowCount()
- Get the number of violation data rows.
- o
GetValidationCheck(CATUnicodeString&)
- Get the validation check name.
- o
GetValidationCheckName(CATUnicodeString&)
- Get the validation check NLS name.
- o
GetValidationType(CATUnicodeString&)
- Get the validation type.
- o
IsAViolationOf(CATUnicodeString&)
- Check if object is a violation.
Data Member Index
- o
_uResource
- Natural language resource.
- o
_uValidationCheck
- Validation check name.
- o
_uValidationType
- Validation check type.
Constructor and Destructor
o CATPspCheckViolation
-
Constructor
Role: Initialize the class.
- Parameters:
-
- iType
- The type of this validation check (e.g. CATDVSpec).
- iCheck
- Validation check name (e.g. Spec01)
- iResource
- .CATNls resource name
o ~CATPspCheckViolation
public virtual ~CATPspCheckViolation( | ) |
-
Methods
o GetCheckViolationData
-
DO NOT USE -- TO BE DELETED Get the check violation data
- Parameters:
-
- oDesc
- Description of data
- oValue
- Data value
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCheckViolationData
-
Get check violation data.
Role: Get the data associated with this violation.
- Parameters:
-
- oRow
- The number of rows in oLValues
- oLValues
- The array of values. A violation may consist of multiple rows of data.
Delete array when no longer needed.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetDescription
-
Get the NLS description for a given key
- Parameters:
-
- iDescKey
- Key within the NLS file
- oDescription
- NLS message associated with iDescKey
- Returns:
- An int value.
Legal values:
- 0
- empty string
- 1
- Description found
o GetRowCount
public virtual int GetRowCount( | ) |
-
Get the number of violation data rows.
Role: Get the number of rows of data that exist for this violation.
Note: A violation check may result in multiple rows of data.
- Returns:
- An int value. The number of rows
o GetValidationCheck
-
Get the validation check name.
Role: Get the validation check name associated with this check violation.
- Parameters:
-
- oCheck
- Validation check name (e.g. Spec01)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetValidationCheckName
-
Get the validation check NLS name.
Role: Get the natural language validation check name associated with this check violation.
- Parameters:
-
- oName
- Validation check NLS name (e.g. Out-of-spec)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetValidationType
-
Get the validation type.
Role: Get the validation type associated with this check violation.
- Parameters:
-
- oType
- Validation type (e.g. CATDVSpec)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o IsAViolationOf
-
Check if object is a violation.
Role: Determine if this object violates the input check.
- Parameters:
-
- iCheck
- Validation check name (e.g. Spec01)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
Data Members
o _uResource
protected CATString _uResource
-
Natural language resource.
The name of a resource that holds strings in the local language.
o _uValidationCheck
protected CATUnicodeString _uValidationCheck
-
Validation check name.
Validation check name (e.g. Spec01)
o _uValidationType
protected CATUnicodeString _uValidationType
-
Validation check type.
The type of this validation check (e.g. CATDVSpec).
This object is included in the file: CATPspCheckViolation.h
If needed, your Imakefile.mk should include the module: CATPspItfCPP