summaryrefslogtreecommitdiff
path: root/riff/Shutdown.h
blob: 812ffb5b42c5e29f12aaf83c370009aa777df822 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/*
 * Shutdown.h
 *
 * Copyright (C) ST-Ericsson SA 2011
 * Authors: Srimanta Panda <srimanta.panda@stericsson.com>,
 *          Ola Borgelin <ola.borgelin@stericsson.com>,
 *          Karin Hedlund <karin.hedlund@stericsson.com>,
 *          Markus Andersson <markus.m.andersson@stericsson.com> for ST-Ericsson.
 * License terms: 3-clause BSD license
 *
 */

/*
 * @addtogroup Commands
 * @{
 */

#pragma once

#include "Command.h"
#include "Logger.h"

namespace System
{
/**
 * @brief Class implementing Shutdown command from System group.
 */
class Shutdown : public Command
{
public:
    /**
     * @brief Default constructor taking no parameters.
     */
    Shutdown();

    /**
     * @brief Method that executes the shutdown of the platform.
     *
     * @param[in] dut - Specific DUT instance on which to execute the command.
     * @return int    - Command execution error (0 on success, non-0 otherwise).
     */
    int run(DUT* dut);

    const char * get_command_name();
private:
    Logger logger_;
};
}

/* @} */