The MultiEncoder::Error class is used to report errors during multi-image encoding. More...

#include <>>

Inherits Qx::AbstractError< "PxCrypt::MultiEncoder::Error", 6979 >.

Public Types
enum	Type { NoError , MissingPayload , MissingMediums , InvalidImage , WontFit , InvalidBpc , WeaveFailed }

Public Member Functions
	Error (Type t=NoError, qsizetype idx=-1, const QString &s={})

QString	errorString () const

qsizetype	imageIndex () const

bool	isValid () const

QString	specific () const

Type	type () const

Detailed Description

See also: MultiEncoder and MultiDecoder::Error.

Member Enumeration Documentation

◆ Type

enum PxCrypt::MultiEncoder::Error::Type

This enum specifies the type of encoding error that occurred.

Enumerator
NoError	No error occurred.
MissingPayload	No payload data was provided.
MissingMediums	No medium images were provided.
InvalidImage	A medium was invalid.
WontFit	A medium's dimensions were not large enough to fit the payload.
InvalidBpc	The BPC value was not between 1 and 7.
WeaveFailed	An unexpected error occurred while weaving data into a medium.

Constructor & Destructor Documentation

◆ Error()

PxCrypt::Error::Error	(	Type	t = NoError,
		qsizetype	idx = -1,
		const QString &	s = {} )

Constructs an error of type t, with specific information s, related to the input image at index idx.

Note: An index of -1 is used to indicate an error that is not tied to a specific image.

See also: isValid().

Member Function Documentation

◆ errorString()

QString PxCrypt::MultiEncoder::Error::errorString ( ) const

Returns the string representation of the error.

See also: type().

◆ imageIndex()

qsizetype PxCrypt::MultiEncoder::Error::imageIndex ( ) const

Returns the index of the image that caused the error, or -1 if the error is not image specific.

◆ isValid()

bool PxCrypt::MultiEncoder::Error::isValid ( ) const

Returns true if the error's type is one other than NoError; otherwise, returns false.

See also: Type.

◆ specific()

QString PxCrypt::MultiEncoder::Error::specific ( ) const

Returns instance specific error information, if any.

See also: errorString().

◆ type()

Error::Type PxCrypt::MultiEncoder::Error::type ( ) const

Returns the type of encoding error.

See also: errorString().

The documentation for this class was generated from the following files:

multi_encoder.h
multi_encoder.cpp

Public Types

Public Member Functions