GM6000 Digital Heater Controller Build: 16 (Branch = develop)
SDX-1330
HwSafety.h
Go to the documentation of this file.
1#ifndef Eros_TShell_HwSafety_h
2#define Eros_TShell_HwSafety_h
3/*-----------------------------------------------------------------------------
4* This file is part of the Colony.Core Project. The Colony.Core Project is an
5* open source project with a BSD type of licensing agreement. See the license
6* agreement (license.txt) in the top/ directory or on the Internet at
7* http://integerfox.com/colony.core/license.txt
8*
9* Copyright (c) 2014-2022 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file */
14
15#include "colony_config.h"
17#include "Driver/DIO/In.h"
18
19///
20namespace Eros {
21///
22namespace TShell {
23
24/** This class implements a TShell command to verify the PWM signals on the board
25 */
27{
28public:
29 /// The command verb/identifier
30 static constexpr const char* verb = "hws";
31
32 /// The command usage string
33 static constexpr const char* usage = "hws";
34
35 /** The command detailed help string (recommended that lines do not exceed 80 chars)
36 1 2 3 4 5 6 7 8
37 12345678901234567890123456789012345678901234567890123456789012345678901234567890
38 */
39 static constexpr const char* detailedHelp = " Samples the Hardware Safety Limit tripped signal.";
40
41public:
42 /// See Cpl::TShell::Command `
43 const char* getUsage() const noexcept { return usage; }
44
45 /// See Cpl::TShell::Command
46 const char* getHelp() const noexcept { return detailedHelp; }
47
48
49public:
50 /// Constructor
52 Driver::DIO::In& hwSafetyInDriver,
54
55
56public:
57 /// See Cpl::TShell::Command
58 Cpl::TShell::Command::Result_T execute( Cpl::TShell::Context_& context, char* cmdString, Cpl::Io::Output& outfd ) noexcept;
59
60protected:
61 /// Driver
63};
64
65} // end namespaces
66}
67#endif // end header latch
#define OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL
Default Permission level for all commands.
Definition Command.h:22
This template class implements a THREAD SAFE Ring Buffer.
Definition RingBufferMT.h:33
This partially abstract class defines a interface for operating on an output stream (example of a str...
Definition Output.h:34
This partially concrete class implements infrastructure and/or common functionality for a Shell comma...
Definition Command.h:37
Result_T
Possible result codes when executing a command.
Definition Command.h:35
This Private Namespace class defines a "Context" for a TShell command.
Definition Context_.h:32
Permission_T
Permissions levels.
Definition Security.h:34
This class defines a generic interface for sampling a single Digital Input signal.
Definition In.h:32
This class implements a TShell command to verify the PWM signals on the board.
Definition HwSafety.h:27
Cpl::TShell::Command::Result_T execute(Cpl::TShell::Context_ &context, char *cmdString, Cpl::Io::Output &outfd) noexcept
See Cpl::TShell::Command.
const char * getHelp() const noexcept
See Cpl::TShell::Command.
Definition HwSafety.h:46
static constexpr const char * verb
The command verb/identifier.
Definition HwSafety.h:30
Driver::DIO::In & m_hwSafetyInDriver
Driver.
Definition HwSafety.h:62
static constexpr const char * usage
The command usage string.
Definition HwSafety.h:33
const char * getUsage() const noexcept
See Cpl::TShell::Command `.
Definition HwSafety.h:43
HwSafety(Cpl::Container::SList< Cpl::TShell::Command > &commandList, Driver::DIO::In &hwSafetyInDriver, Cpl::TShell::Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
Constructor.
static constexpr const char * detailedHelp
The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 1234...
Definition HwSafety.h:39
The 'Eros' namespace is the root name space all of the GM6000 Engineering Test Application specific s...
Definition screens.h:22