This file contains a typedef for a common Return Codes enum. More...
Go to the source code of this file.
Macros | |
| #define | SDH__attribute__(...) __attribute__(__VA_ARGS__) |
| #define | SDH_USE_VCC 0 |
Typedefs | |
| typedef enum eReturnCodeEnum | eReturnCode |
| typedef for eCommandCodeEnum, see there More... | |
Enumerations | |
| enum | eReturnCodeEnum |
Functions | |
| enum eReturnCodeEnum | SDH__attribute__ ((__packed__)) |
Variables | |
| RC_ACCESS_DENIED | |
| RC_ALREADY_OPEN | |
| RC_ALREADY_RUNNING | |
| Error: Data acquisition: the acquisition loop is already running. More... | |
| RC_AXIS_DISABLED | |
| RC_CHECKSUM_ERROR | |
| RC_CMD_ABORTED | |
| RC_CMD_FAILED | |
| RC_CMD_FORMAT_ERROR | |
| Error: invalid format of command line parameters. More... | |
| RC_CMD_UNKNOWN | |
| Error: unknown command on command line. More... | |
| RC_CRC_ERROR | |
| Cyclic Redundancy Code error while receiving binary input. More... | |
| RC_DEVICE_NOT_FOUND | |
| RC_DEVICE_NOT_OPENED | |
| RC_DIMENSION | |
| < End marker and dimension More... | |
| RC_FEATURE_NOT_SUPPORTED | |
| RC_HOMING_ERROR | |
| RC_INCONSISTENT_DATA | |
| RC_INDEX_OUT_OF_BOUNDS | |
| Error: A given index parameter is invalid. More... | |
| RC_INSUFFICIENT_RESOURCES | |
| Error: Insufficient ressources. More... | |
| RC_INTERNAL | |
| Error: callback function reports internal error. More... | |
| RC_INVALID_HANDLE | |
| RC_INVALID_PARAMETER | |
| Error: invalid parameter on command line. More... | |
| RC_INVALID_PASSWORD | |
| Error: invalid password given for change user command. More... | |
| RC_IO_ERROR | |
| Error: Input/Output error like bus-off detected. More... | |
| RC_MAX_COMMANDLINE_EXCEEDED | |
| Error: the command line given is too long. More... | |
| RC_MAX_COMMANDS_EXCEEDED | |
| Error: cannot add more than CI_MAX_COMMANDS to interpreter / POSCON_MAX_OSCILLOSCOPE parameters to oscilloscope. More... | |
| RC_NO_COMMAND | |
| Not really an error: reading input did not yield a new command. More... | |
| RC_NO_DATAPIPE | |
| RC_NO_PARAMS_EXPECTED | |
| RC_NOT_AVAILABLE | |
| Error: An accessed ressource is not available. More... | |
| RC_NOT_ENOUGH_PARAMS | |
| Error: not enough parameters on command line. More... | |
| RC_NOT_INITIALIZED | |
| Error: An accessed ressource has not been initialized. More... | |
| RC_OK = 0 | |
| Success, no error. More... | |
| RC_OVER_TEMPERATURE | |
| RC_RANGE_ERROR | |
| RC_READ_ERROR | |
| Error: could not read. More... | |
| RC_TIMEOUT | |
| Error: timeout occured. More... | |
| RC_UNKNOWN_ERROR | |
| Error: unknown error. More... | |
| RC_WRITE_ERROR | |
| Error: could not write. More... | |
Detailed Description
This file contains a typedef for a common Return Codes enum.
General file information
- Date
- 2011-02-04
Copyright
Copyright (c) 2011 SCHUNK GmbH & Co. KG
Definition in file sdh_return_codes.h.
Macro Definition Documentation
◆ SDH__attribute__
| #define SDH__attribute__ | ( | ... | ) | __attribute__(__VA_ARGS__) |
Definition at line 51 of file sdh_return_codes.h.
◆ SDH_USE_VCC
| #define SDH_USE_VCC 0 |
Definition at line 55 of file sdh_return_codes.h.
Typedef Documentation
◆ eReturnCode
| typedef enum eReturnCodeEnum eReturnCode |
typedef for eCommandCodeEnum, see there
Definition at line 118 of file sdh_return_codes.h.
Enumeration Type Documentation
◆ eReturnCodeEnum
| enum eReturnCodeEnum |
Packed (1 Byte) enum with binary return codes used to indicate the status of the SDH sent in the binary communiation request or response.
- Remarks
- To make this definition work with both C (nios-gcc) and C++ (std gcc/VCC) we have to separate the enum definition from the typedef.
- You may use the corresponding typedef eReturnCode
Definition at line 72 of file sdh_return_codes.h.
Function Documentation
◆ SDH__attribute__()
| enum eReturnCodeEnum SDH__attribute__ | ( | (__packed__) | ) |
Variable Documentation
◆ RC_ACCESS_DENIED
| RC_ACCESS_DENIED |
Definition at line 17 of file sdh_return_codes.h.
◆ RC_ALREADY_OPEN
| RC_ALREADY_OPEN |
Definition at line 18 of file sdh_return_codes.h.
◆ RC_ALREADY_RUNNING
| RC_ALREADY_RUNNING |
Error: Data acquisition: the acquisition loop is already running.
Definition at line 5 of file sdh_return_codes.h.
◆ RC_AXIS_DISABLED
| RC_AXIS_DISABLED |
Definition at line 30 of file sdh_return_codes.h.
◆ RC_CHECKSUM_ERROR
| RC_CHECKSUM_ERROR |
Definition at line 12 of file sdh_return_codes.h.
◆ RC_CMD_ABORTED
| RC_CMD_ABORTED |
Definition at line 20 of file sdh_return_codes.h.
◆ RC_CMD_FAILED
| RC_CMD_FAILED |
Definition at line 19 of file sdh_return_codes.h.
◆ RC_CMD_FORMAT_ERROR
| RC_CMD_FORMAT_ERROR |
Error: invalid format of command line parameters.
Definition at line 16 of file sdh_return_codes.h.
◆ RC_CMD_UNKNOWN
| RC_CMD_UNKNOWN |
Error: unknown command on command line.
Definition at line 15 of file sdh_return_codes.h.
◆ RC_CRC_ERROR
| RC_CRC_ERROR |
Cyclic Redundancy Code error while receiving binary input.
Definition at line 35 of file sdh_return_codes.h.
◆ RC_DEVICE_NOT_FOUND
| RC_DEVICE_NOT_FOUND |
Definition at line 22 of file sdh_return_codes.h.
◆ RC_DEVICE_NOT_OPENED
| RC_DEVICE_NOT_OPENED |
Definition at line 23 of file sdh_return_codes.h.
◆ RC_DIMENSION
| RC_DIMENSION |
< End marker and dimension
End marker and dimension.
Definition at line 43 of file sdh_return_codes.h.
◆ RC_FEATURE_NOT_SUPPORTED
| RC_FEATURE_NOT_SUPPORTED |
Definition at line 6 of file sdh_return_codes.h.
◆ RC_HOMING_ERROR
| RC_HOMING_ERROR |
Definition at line 29 of file sdh_return_codes.h.
◆ RC_INCONSISTENT_DATA
| RC_INCONSISTENT_DATA |
Definition at line 7 of file sdh_return_codes.h.
◆ RC_INDEX_OUT_OF_BOUNDS
| RC_INDEX_OUT_OF_BOUNDS |
Error: A given index parameter is invalid.
Definition at line 28 of file sdh_return_codes.h.
◆ RC_INSUFFICIENT_RESOURCES
| RC_INSUFFICIENT_RESOURCES |
Error: Insufficient ressources.
Definition at line 11 of file sdh_return_codes.h.
◆ RC_INTERNAL
| RC_INTERNAL |
Error: callback function reports internal error.
Definition at line 38 of file sdh_return_codes.h.
◆ RC_INVALID_HANDLE
| RC_INVALID_HANDLE |
Definition at line 21 of file sdh_return_codes.h.
◆ RC_INVALID_PARAMETER
| RC_INVALID_PARAMETER |
Error: invalid parameter on command line.
Definition at line 25 of file sdh_return_codes.h.
◆ RC_INVALID_PASSWORD
| RC_INVALID_PASSWORD |
Error: invalid password given for change user command.
Definition at line 33 of file sdh_return_codes.h.
◆ RC_IO_ERROR
| RC_IO_ERROR |
Error: Input/Output error like bus-off detected.
Definition at line 24 of file sdh_return_codes.h.
◆ RC_MAX_COMMANDLINE_EXCEEDED
| RC_MAX_COMMANDLINE_EXCEEDED |
Error: the command line given is too long.
Definition at line 34 of file sdh_return_codes.h.
◆ RC_MAX_COMMANDS_EXCEEDED
| RC_MAX_COMMANDS_EXCEEDED |
Error: cannot add more than CI_MAX_COMMANDS to interpreter / POSCON_MAX_OSCILLOSCOPE parameters to oscilloscope.
Definition at line 32 of file sdh_return_codes.h.
◆ RC_NO_COMMAND
| RC_NO_COMMAND |
Not really an error: reading input did not yield a new command.
Definition at line 36 of file sdh_return_codes.h.
◆ RC_NO_DATAPIPE
| RC_NO_DATAPIPE |
Definition at line 27 of file sdh_return_codes.h.
◆ RC_NO_PARAMS_EXPECTED
| RC_NO_PARAMS_EXPECTED |
Definition at line 14 of file sdh_return_codes.h.
◆ RC_NOT_AVAILABLE
| RC_NOT_AVAILABLE |
Error: An accessed ressource is not available.
Definition at line 3 of file sdh_return_codes.h.
◆ RC_NOT_ENOUGH_PARAMS
| RC_NOT_ENOUGH_PARAMS |
Error: not enough parameters on command line.
Definition at line 13 of file sdh_return_codes.h.
◆ RC_NOT_INITIALIZED
| RC_NOT_INITIALIZED |
Error: An accessed ressource has not been initialized.
Definition at line 4 of file sdh_return_codes.h.
◆ RC_OK
| RC_OK = 0 |
Success, no error.
Definition at line 2 of file sdh_return_codes.h.
◆ RC_OVER_TEMPERATURE
| RC_OVER_TEMPERATURE |
Definition at line 31 of file sdh_return_codes.h.
◆ RC_RANGE_ERROR
| RC_RANGE_ERROR |
Definition at line 26 of file sdh_return_codes.h.
◆ RC_READ_ERROR
| RC_READ_ERROR |
Error: could not read.
Definition at line 9 of file sdh_return_codes.h.
◆ RC_TIMEOUT
| RC_TIMEOUT |
Error: timeout occured.
Definition at line 8 of file sdh_return_codes.h.
◆ RC_UNKNOWN_ERROR
| RC_UNKNOWN_ERROR |
Error: unknown error.
Definition at line 39 of file sdh_return_codes.h.
◆ RC_WRITE_ERROR
| RC_WRITE_ERROR |
Error: could not write.
Definition at line 10 of file sdh_return_codes.h.