Sound Open Firmware
Loading...
Searching...
No Matches
intel_adsp::SystemAgentInterface::ErrorCode Struct Reference

Scoped enumeration of error code value which can be reported by a SystemAgentInterface object. More...

#include <system_agent_interface.h>

Inheritance diagram for intel_adsp::SystemAgentInterface::ErrorCode:
Collaboration diagram for intel_adsp::SystemAgentInterface::ErrorCode:

Public Types

enum  Enum { MODULE_CREATION_FAILURE = intel_adsp::ErrorCode::MaxValue + 1 }
 list of named error codes specific to the SystemAgentInterface More...
Public Types inherited from intel_adsp::ErrorCode
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 instance of ErrorCode given a value.
Public Member Functions inherited from intel_adsp::ErrorCode
 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 = MODULE_CREATION_FAILURE
 Indicates the minimal value of the enumeration.
static Enum const MaxValue = MODULE_CREATION_FAILURE
 Indicates the maximal value of the enumeration.
Static Public Attributes inherited from intel_adsp::ErrorCode
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.

Additional Inherited Members

Protected Member Functions inherited from intel_adsp::ErrorCode
Type & Value ()
 Gets a reference on the error code value.

Detailed Description

Scoped enumeration of error code value which can be reported by a SystemAgentInterface object.

Member Enumeration Documentation

◆ Enum

list of named error codes specific to the SystemAgentInterface

Enumerator
MODULE_CREATION_FAILURE 

Reports that ProcessingModuleFactoryInterface::Create() has exited with error

Constructor & Destructor Documentation

◆ ErrorCode()

intel_adsp::SystemAgentInterface::ErrorCode::ErrorCode ( Type value)
inlineexplicit

Initializes a new instance of ErrorCode given a value.

Field Documentation

◆ MaxValue

Enum const intel_adsp::SystemAgentInterface::ErrorCode::MaxValue = MODULE_CREATION_FAILURE
static

Indicates the maximal value of the enumeration.

◆ MinValue

Enum const intel_adsp::SystemAgentInterface::ErrorCode::MinValue = MODULE_CREATION_FAILURE
static

Indicates the minimal value of the enumeration.


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