API Documentation
Loading...
Searching...
No Matches
HardwareException.h
Go to the documentation of this file.
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Hardware
28File: HardwareException
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/Exception.h>
34#include <NDEVR/String.h>
35#include <NDEVR/Translator.h>
36namespace NDEVR
37{
38 /**--------------------------------------------------------------------------------------------------
39 \brief A typical exception thrown when something fails with a Device.
40 **/
42 {
43 public:
44 explicit HardwareException(const TranslatedString& error)
45 : Exception(_t("Hardware Fault"), error, false)
46 {
47 setCategory(_t("Hardware Error"));
48 }
50 : Exception(_t("Hardware Fault"), error, false)
51 {
52 setCategory(category);
53 }
54 };
55}
#define _t(english_string)
Definition Translator.h:90
Provides consistent interface to handle errors through the throw expression. All exceptions generated...
Definition Exception.hpp:47
void setCategory(const TranslatedString &category)
Definition Exception.hpp:62
A typical exception thrown when something fails with a Device.
Definition HardwareException.h:42
HardwareException(const TranslatedString &error)
Definition HardwareException.h:44
HardwareException(const TranslatedString &error, const TranslatedString &category)
Definition HardwareException.h:49
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
Definition TranslatedString.h:13
Definition ACIColor.h:37