intel_adsp::ErrorCode Struct Reference

Scoped enumeration of common error code values which can be reported to ADSP System. More...

#include <system_error.h>

Inheritance diagram for intel_adsp::ErrorCode:

Public Types
enum	Enum { NO_ERROR = ADSP_NO_ERROR , INVALID_PARAMETERS = ADSP_INVALID_PARAMETERS , BUSY = ADSP_BUSY_RESOURCE , FATAL_FAILURE = ADSP_FATAL_FAILURE }
	list of named error codes More...
typedef int	Type
	type of the error code value

Public Member Functions
	ErrorCode (Type value)
	Initializes a new ErrorCode instance given a value of error code.
Type	operator() () const
	Returns the current value of the ErrorCode.
	operator Type (void) const
	Converts the ErrorCode instance into its code value.
bool	operator== (Type a)
	Evaluates the ErrorCode value against a given value.
const Type &	Value () const
	Gets a const reference on the error code value.

Static Public Attributes
static Enum const	MinValue = NO_ERROR
	Indicates the minimal value in the enumeration list.
static Enum const	MaxValue = FATAL_FAILURE
	Indicates the maximal value in the enumeration list.

Protected Member Functions
Type &	Value ()
	Gets a reference on the error code value.

Detailed Description

Scoped enumeration of common error code values which can be reported to ADSP System.

Member Typedef Documentation

Type

typedef int intel_adsp::ErrorCode::Type

type of the error code value

Member Enumeration Documentation

Enum

enum intel_adsp::ErrorCode::Enum

list of named error codes

Enumerator
NO_ERROR
INVALID_PARAMETERS
BUSY
FATAL_FAILURE

Constructor & Destructor Documentation

ErrorCode()

intel_adsp::ErrorCode::ErrorCode ( Type value )

inlineexplicit

Initializes a new ErrorCode instance given a value of error code.

Member Function Documentation

operator Type()

intel_adsp::ErrorCode::operator Type ( void ) const

inline

Converts the ErrorCode instance into its code value.

operator()()

Type intel_adsp::ErrorCode::operator() ( ) const

inline

Returns the current value of the ErrorCode.

operator==()

bool intel_adsp::ErrorCode::operator== ( Type a )

inline

Evaluates the ErrorCode value against a given value.

Value() [1/2]

Type & intel_adsp::ErrorCode::Value ( )

inlineprotected

Gets a reference on the error code value.

Value() [2/2]

const Type & intel_adsp::ErrorCode::Value ( ) const

inline

Gets a const reference on the error code value.

Field Documentation

MaxValue

Enum const intel_adsp::ErrorCode::MaxValue = FATAL_FAILURE

static

Indicates the maximal value in the enumeration list.

MinValue

Enum const intel_adsp::ErrorCode::MinValue = NO_ERROR

static

Indicates the minimal value in the enumeration list.

---

The documentation for this struct was generated from the following file:

• /home/lrg/work/sof-dox-work/src/include/sof/audio/module_adapter/iadk/system_error.h