FLImaging module execution result object. More...

#include <ResultsDef.h>

Public Member Functions
	CResult ()
	Default constructor.
	CResult (const CResult &res)
	Copy constructor.
	CResult (const EResult eResult)
	Copy constructor.
const CResult &	operator= (const CResult &res)
	Assign operator.
const CResult &	operator= (const EResult eResult)
	Assign operator.
bool	operator== (const CResult &res) const
	Comparison operator.
bool	operator== (const EResult eResult) const
	Comparison operator.
bool	operator!= (const CResult &res) const
	Comparison operator.
bool	operator!= (const EResult eResult) const
	Comparison operator.
	operator EResult () const
	Cast operator.
	operator bool () const
	Cast operator.
	operator int32_t () const
	Cast operator.
	operator uint32_t () const
	Cast operator.
	operator int64_t () const
	Cast operator.
	operator uint64_t () const
	Cast operator.
bool	Assign (const CResult &res)
	Assign CResult object.
bool	Assign (const EResult eResult)
	Assign CResult object.
bool	Equal (const CResult &res) const
	Compare CResult object.
bool	Equal (const EResult eResult) const
	Compare CResult object.
virtual bool	IsOK () const
	Check the success. If the result is OK or PartialOK, it returns true. otherwise, it returns false.
virtual bool	IsStrictOK () const
	Check the success. If the result is OK, it returns true. otherwise, it returns false.
virtual bool	IsFail () const
	Check the failure. If the result is not OK or PartialOK, it returns true. otherwise, it returns false.
virtual bool	IsStrictFail () const
	Check the failure. If the result is not OK, it returns true. otherwise, it returns false.
virtual int32_t	GetResultCode () const
	Returns the result code.
virtual const wchar_t *	GetString () const
	Get the result string.
virtual EResult	GetResult () const
	Result return enum.

Friends
bool	operator== (const EResult eResult, const CResult &res)
	Comparison operator.
bool	operator!= (const EResult eResult, const CResult &res)
	Comparison operator.

Detailed Description

FLImaging module execution result object.

Constructor & Destructor Documentation

◆ CResult() [1/2]

FLImaging::CResult::CResult ( const CResult & res )

inline

Copy constructor.

Parameters

[in] res Copy instance

See also: FLImaging::CResult

◆ CResult() [2/2]

FLImaging::CResult::CResult ( const EResult eResult )

inline

Copy constructor.

Parameters

[in] eResult Result enum

See also: FLImaging::EResult

Member Function Documentation

◆ Assign() [1/2]

bool FLImaging::CResult::Assign ( const CResult & res )

inline

Assign CResult object.

Parameters

[in] res CResult object

Return values

bool	succeed true failed false

See also: FLImaging::CResult

◆ Assign() [2/2]

bool FLImaging::CResult::Assign ( const EResult eResult )

inline

Assign CResult object.

Parameters

[in] eResult Result enum

Return values

bool	succeed true failed false

See also: FLImaging::EResult

◆ Equal() [1/2]

bool FLImaging::CResult::Equal ( const CResult & res ) const

inline

Compare CResult object.

Parameters

[in] res CResult object.

Return values

bool	Equal true Not equal false

See also: FLImaging::CResult

◆ Equal() [2/2]

bool FLImaging::CResult::Equal ( const EResult eResult ) const

inline

Compare CResult object.

Parameters

[in] eResult Result enum

Return values

bool	Equal true Not equal false

See also: FLImaging::EResult

◆ GetResult()

virtual EResult FLImaging::CResult::GetResult ( ) const

inlinevirtual

Result return enum.

Return values

FLImaging::EResult Result enum

See also: FLImaging::EResult

◆ GetResultCode()

virtual int32_t FLImaging::CResult::GetResultCode ( ) const

inlinevirtual

Returns the result code.

Return values

int32_t Result Code value

◆ GetString()

virtual const wchar_t * FLImaging::CResult::GetString ( ) const

inlinevirtual

Get the result string.

Return values

const wchar_t* String pointer

◆ IsFail()

virtual bool FLImaging::CResult::IsFail ( ) const

inlinevirtual

Check the failure. If the result is not OK or PartialOK, it returns true. otherwise, it returns false.

Return values

bool	If the result is not OK or PartialOK, it returns true. otherwise, it returns false.

◆ IsOK()

virtual bool FLImaging::CResult::IsOK ( ) const

inlinevirtual

Check the success. If the result is OK or PartialOK, it returns true. otherwise, it returns false.

Return values

bool	If the result is OK or PartialOK, it returns true. otherwise, it returns false.

◆ IsStrictFail()

virtual bool FLImaging::CResult::IsStrictFail ( ) const

inlinevirtual

Check the failure. If the result is not OK, it returns true. otherwise, it returns false.

Return values

bool	If the result is not OK, it returns true. otherwise, it returns false.

◆ IsStrictOK()

virtual bool FLImaging::CResult::IsStrictOK ( ) const

inlinevirtual

Check the success. If the result is OK, it returns true. otherwise, it returns false.

Return values

bool	If the result is OK, it returns true. otherwise, it returns false.

◆ operator bool()

FLImaging::CResult::operator bool ( ) const

inline

Cast operator.

Return values

bool	The result value of the IsOK() member function of the result object.

◆ operator EResult()

FLImaging::CResult::operator EResult ( ) const

inline

Cast operator.

Return values

FLImaging::EResult Result enum

See also: FLImaging::EResult

◆ operator int32_t()

FLImaging::CResult::operator int32_t ( ) const

inline

Cast operator.

Return values

int32_t Result value

◆ operator int64_t()

FLImaging::CResult::operator int64_t ( ) const

inline

Cast operator.

Return values

int64_t Result value

◆ operator uint32_t()

FLImaging::CResult::operator uint32_t ( ) const

inline

Cast operator.

Return values

uint32_t Result value

◆ operator uint64_t()

FLImaging::CResult::operator uint64_t ( ) const

inline

Cast operator.

Return values

uint64_t Result value

◆ operator!=() [1/2]

bool FLImaging::CResult::operator!= ( const CResult & res ) const

inline

Comparison operator.

Parameters

[in] res CResult object

Return values

bool	Not equal true Equal false

See also: FLImaging::EResult

◆ operator!=() [2/2]

bool FLImaging::CResult::operator!= ( const EResult eResult ) const

inline

Comparison operator.

Parameters

[in] eResult Result enum

Return values

bool	Not equal true Equal false

See also: FLImaging::EResult

◆ operator=() [1/2]

const CResult & FLImaging::CResult::operator= ( const CResult & res )

inline

Assign operator.

Parameters

[in] res Input instance

Return values

const FLImaging::CResult& CResult object

See also: FLImaging::CResult

◆ operator=() [2/2]

const CResult & FLImaging::CResult::operator= ( const EResult eResult )

inline

Assign operator.

Parameters

[in] eResult Result enum

Return values

const FLImaging::CResult& CResult object

See also: FLImaging::EResult; FLImaging::CResult

◆ operator==() [1/2]

bool FLImaging::CResult::operator== ( const CResult & res ) const

inline

Comparison operator.

Parameters

[in] res CResult object

Return values

bool	Equal true Not equal false

See also: FLImaging::CResult

◆ operator==() [2/2]

bool FLImaging::CResult::operator== ( const EResult eResult ) const

inline

Comparison operator.

Parameters

[in] eResult Result enum

Return values

bool	Equal true Not equal false

See also: FLImaging::EResult

◆ operator!=

bool operator!=	(	const EResult	eResult,
		const CResult &	res )

friend

Comparison operator.

Parameters

[in]	eResult	Result enum
[in]	res	CResult object

Return values

bool	Not equal true Equal false

See also: FLImaging::EResult; FLImaging::CResult

◆ operator==

bool operator==	(	const EResult	eResult,
		const CResult &	res )

friend

Comparison operator.

Parameters

[in]	eResult	Result enum
[in]	res	CResult object

Return values

bool	Equal true Not equal false

See also: FLImaging::EResult; FLImaging::CResult

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CResult() [1/2]

◆ CResult() [2/2]

Member Function Documentation

◆ Assign() [1/2]

◆ Assign() [2/2]

◆ Equal() [1/2]

◆ Equal() [2/2]

◆ GetResult()

◆ GetResultCode()

◆ GetString()

◆ IsFail()

◆ IsOK()

◆ IsStrictFail()

◆ IsStrictOK()

◆ operator bool()

◆ operator EResult()

◆ operator int32_t()

◆ operator int64_t()

◆ operator uint32_t()

◆ operator uint64_t()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==