Matthias Mitscherlich
d5e389f1bd
The update on the interface required FunctionStatus and the logger to be updated, too
80 lines
3.3 KiB
C
80 lines
3.3 KiB
C
// --------------------------------------------------------------------------------------------------------------------
|
|
/// \file FunctionStatus.h
|
|
/// \brief File description
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
//
|
|
// vbchaos software design
|
|
//
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
/// $Revision: $
|
|
/// $Author: $
|
|
/// $Date: $
|
|
// (c) 2023 vbchaos
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
#ifndef MAIN_FUNCTIONSTATUS_H_
|
|
#define MAIN_FUNCTIONSTATUS_H_
|
|
|
|
/**
|
|
* FunctionStatus implementation
|
|
* \addtogroup Global
|
|
*
|
|
* The FunctionStatus enumeration is the global function status representation. The values defined here shall
|
|
* be used throughout the whole project.
|
|
* @{
|
|
*/
|
|
|
|
|
|
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
// Include files
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
// Constant and macro definitions
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
// Type definitions.
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* \enum FunctionStatus
|
|
* @{
|
|
*/
|
|
|
|
typedef enum
|
|
{
|
|
FUNCTION_STATUS_OK = 0, //!< The function execution was successful
|
|
FUNCTION_STATUS_ERROR = 1, //!< The function execution caused an unspecified error
|
|
FUNCTION_STATUS_NOT_INITIALIZED = 2, //!< The function execution was aborted because the module
|
|
//!< instance is not initialized
|
|
FUNCTION_STATUS_ALREADY_INITIALIZED = 3, //!< The function execution was aborted because the module
|
|
//!< instance is already initialized
|
|
FUNCTION_STATUS_UNDEFINED_VALUE = 4, //!< The function failed because an undefined value was used
|
|
//!< This most probably happened when checking an enum
|
|
FUNCTION_STATUS_NOT_IMPLEMENTED = 5, //!< The required functionality is not (yet) implemented
|
|
// Interfaces/Busses
|
|
FUNCTION_STATUS_NOT_OPEN = 10, //!< The Interface cannot be used because it has not been opened
|
|
FUNCTION_STATUS_ALREADY_OPEN = 11, //!< The interface cannot be opened because it is already open
|
|
FUNCTION_STATUS_ALREADY_CLOSE = 12, //!< The interface cannot be closed because it is already closed
|
|
|
|
} FunctionStatus;
|
|
|
|
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
// Function declarations
|
|
// --------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
/** @} */
|
|
|
|
|
|
#endif /* MAIN_FUNCTIONSTATUS_H_ */
|