![]() |
XMP Toolkit SDK
6.0.0
|
Version1 of the interface that represents an error/warning encountered during processing. More...
#include <IError.h>
Public Types | |
enum | eErrorSeverity { kESNone = 0, kESWarning = 1 << 0, kESOperationFatal = 1 << 1, kESProcessFatal = 1 << 2, kESMaxValue = 1 << 31, kESAll = kAllBits } |
Indicates various types of errors. More... | |
enum | eErrorDomain { kEDNone = 0, kEDGeneral = 1, kEDMemoryManagement = 2, kEDConfigurable = 3, kEDMultiThreading = 4, kEDDataModel = 100, kEDParser = 101, kEDSerializer = 102, kEDXMPFiles = 200, kEDConflictIdentification = 400, kEDConflictResolution = 500, kEDThreeWayMerge = 600, kEDGenericStrategyDatabase = 601, kEDAssetManagement = 10000, kEDMaxValue = kMaxEnumValue } |
Indicates various types of error domains. More... | |
typedef uint32 | eErrorCode |
Public Member Functions | |
virtual eErrorCode APICALL | GetCode () const =0 |
Get the error code. More... | |
virtual eErrorDomain APICALL | GetDomain () const =0 |
Get the error domain. More... | |
virtual eErrorSeverity APICALL | GetSeverity () const =0 |
Get the error severity. More... | |
virtual spcIUTF8String APICALL | GetMessage () const =0 |
Get the error message. More... | |
virtual spcIUTF8String APICALL | GetLocation () const =0 |
Get the location of the error origin. More... | |
virtual spcIUTF8String APICALL | GetParameter (sizet index) const =0 |
Get the value of a parameter at a particular index. More... | |
virtual sizet APICALL | GetParametersCount () const __NOTHROW__=0 |
Get the count of parameters. More... | |
virtual spIError APICALL | SetNextError (const spIError &error)=0 |
Set the next error in the chain. More... | |
virtual void APICALL | SetMessage (const char *message, sizet len=npos) __NOTHROW__=0 |
Set the error message. More... | |
virtual void APICALL | SetLocation (const char *fileName, sizet lineNumber) __NOTHROW__=0 |
Set the location of origin of error. More... | |
virtual void APICALL | AppendParameter (const char *parameter, sizet len=npos) __NOTHROW__=0 |
Appends a parameter to the list of parameters. More... | |
virtual void APICALL | AppendParameter (void *addressParameter) __NOTHROW__=0 |
Appends an address as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const uint32 &integerValue) __NOTHROW__=0 |
Appends a 32 bit unsigned integer value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const uint64 &integerValue) __NOTHROW__=0 |
Appends a 64 bit unsigned integer value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const int32 &integerValue) __NOTHROW__=0 |
Appends a 32 bit integer value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const int64 &integerValue) __NOTHROW__=0 |
Appends a 64 bit integer value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const float &floatValue) __NOTHROW__=0 |
Appends a floating value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (const double &doubleValue) __NOTHROW__=0 |
Appends a double floating value as a string to the list of parameters. More... | |
virtual void APICALL | AppendParameter (bool booleanValue) __NOTHROW__=0 |
Appends a boolean value as a string to the list of parameters. More... | |
virtual spIError APICALL | GetNextError ()=0 |
Get the next error in the chain. More... | |
XMP_PRIVATE spcIError | GetNextError () const |
![]() | |
virtual void APICALL | Acquire () const __NOTHROW__=0 |
Called by the clients of the object to indicate that he has acquired the shared ownership of the object. More... | |
virtual void APICALL | Release () const __NOTHROW__=0 |
Called by the clients of the object to indicate he has released his shared ownership of the object. If this being the last client than this function should call Destroy to delete and release the memory. More... | |
![]() | |
template<typename requestedInterface > | |
XMP_PRIVATE requestedInterface * | GetInterfacePointer () |
Get the raw pointer to an interface object implementing the requested version. More... | |
template<typename requestedInterface > | |
const XMP_PRIVATE requestedInterface * | GetInterfacePointer () const |
Get the raw pointer to a const interface object implementing the requested version. More... | |
Static Public Member Functions | |
static spIError | CreateError (pIObjectFactory objFactory, eErrorDomain errDomain, eErrorCode errCode, eErrorSeverity errSeverity) |
Creates an error object. More... | |
Protected Member Functions | |
virtual | ~IError_v1 () __NOTHROW__ |
![]() | |
virtual | ~ISharedObject () __NOTHROW__=0 |
REQ_FRIEND_CLASS_DECLARATION () | |
![]() | |
virtual | ~IVersionable () |
REQ_FRIEND_CLASS_DECLARATION () | |
Version1 of the interface that represents an error/warning encountered during processing.
Provides all the functions to get required information regarding error scenario.
Indicates various types of error domains.
Definition at line 62 of file IError.h.
Indicates various types of errors.
Definition at line 36 of file IError.h.
|
inlineprotectedvirtual |
|
pure virtual |
Appends a boolean value as a string to the list of parameters.
[in] | booleanValue | A value of bool type containing the boolean value to be used as parameter. |
|
pure virtual |
Appends a parameter to the list of parameters.
[in] | parameter | Pointer to a constant char buffer containing parameter. It can be null terminated or not. NULL pointer will be treated as empty message string. |
[in] | len | A value of AdobeXMPCommon::sizet indicating the length in case parameter is not null terminated. In case parameter is null terminated it can be set to its default value ( npos ). |
|
pure virtual |
Appends a double floating value as a string to the list of parameters.
[in] | doubleValue | A value of double type containing the floating value to be used as parameter. |
|
pure virtual |
Appends a floating value as a string to the list of parameters.
[in] | floatValue | A value of float type containing the floating value to be used as parameter. |
|
pure virtual |
Appends a 32 bit integer value as a string to the list of parameters.
[in] | integerValue | A value of AdobeXMPCommon::int32 type containing the integral value to be used as parameter. |
|
pure virtual |
Appends a 64 bit integer value as a string to the list of parameters.
[in] | integerValue | A value of AdobeXMPCommon::uint64 type containing the integral value to be used as parameter. |
|
pure virtual |
Appends a 32 bit unsigned integer value as a string to the list of parameters.
[in] | integerValue | A value of AdobeXMPCommon::uint32 type containing the integral value to be used as parameter. |
|
pure virtual |
Appends a 64 bit unsigned integer value as a string to the list of parameters.
[in] | integerValue | A value of AdobeXMPCommon::uint64 type containing the integral value to be used as parameter. |
|
pure virtual |
Appends an address as a string to the list of parameters.
[in] | addressParameter | A value of void * type containing the address of the location to be used as parameter. |
|
static |
Creates an error object.
[in] | objFactory | A pointer to IObjectFactory object. |
[in] | errDomain | A value of eErrorDomain indicating the error domain. |
[in] | errCode | A value of eErrorCode indicating the error code. |
[in] | errSeverity | A value of eErrorSeverity indicating the severity of the error. |
|
pure virtual |
Get the error code.
|
pure virtual |
Get the error domain.
|
pure virtual |
Get the location of the error origin.
|
pure virtual |
Get the error message.
Error message contains a descriptive string, for debugging use only. It must not be shown to users in a final product. It is written for developers, not users, and never localized.
|
inline |
|
pure virtual |
Get the next error in the chain.
|
pure virtual |
Get the value of a parameter at a particular index.
Based on each error condition various parameters are stored along with the error object. Clients can one by one get access to each parameter that can be later used for debugging.
[in] | index | A value of #AdobeXMPCommon::sizet indicating the index of the parameter client is interested in retrieving. |
|
pure virtual |
Get the count of parameters.
|
pure virtual |
Get the error severity.
|
pure virtual |
Set the location of origin of error.
[in] | fileName | Pointer to a null terminated char buffer containing the file name from which the error originated. NULL pointer will be treated as empty fileName. |
[in] | lineNumber | A value of #AdobeXMPCommon::sizet indicating the line in source file from which the error originated. |
|
pure virtual |
Set the error message.
[in] | message | Pointer to a constant char buffer containing message. It can be null terminated or not. NULL pointer will be treated as empty message string. |
[in] | len | A value of #AdobeXMPCommon::sizet indicating the length in case message is not null terminated. In case message is null terminated it can be set to its default value ( npos ). |
|
pure virtual |
Set the next error in the chain.
[in] | error | A pointer to #AdobeXMP::IError object which will be the next error in the chain. |