1

/*****************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 ****************************************************************************/

    29

    30

#ifndef __COMMAND_H__

    31

#define __COMMAND_H__

    32

    33

#include <stdexcept>

    34

#include <vector>

    35

#include <list>

    36

#include <sstream>

    37

using namespace std;

    38

    39

#include "../master/ioctl.h"

    40

    41

class MasterDevice;

    42

    43

/****************************************************************************/

    44

    45

class InvalidUsageException:

    46

    public runtime_error

    47

{

    48

    friend class Command;

    49

    50

    protected:

    51

        /** Constructor with stringstream parameter. */

    52

        InvalidUsageException(

    53

                const stringstream &s /**< Message. */

    54

                ): runtime_error(s.str()) {}

    55

};

    56

    57

/****************************************************************************/

    58

    59

class CommandException:

    60

    public runtime_error

    61

{

    62

    friend class Command;

    63

    64

    protected:

    65

        /** Constructor with char * parameter. */

    66

        CommandException(

    67

                const string &msg /**< Message. */

    68

                ): runtime_error(msg) {}

    69

    70

        /** Constructor with stringstream parameter. */

    71

        CommandException(

    72

                const stringstream &s /**< Message. */

    73

                ): runtime_error(s.str()) {}

    74

};

    75

    76

/****************************************************************************/

    77

    78

class Command

    79

{

    80

    public:

    81

        Command(const string &, const string &);

    82

        virtual ~Command();

    83

    84

        const string &getName() const;

    85

        const string &getBriefDescription() const;

    86

    87

        typedef list<unsigned int> MasterIndexList;

    88

        void setMasters(const string &);

    89

        MasterIndexList getMasterIndices() const;

    90

		unsigned int getSingleMasterIndex() const;

    91

    92

        enum Verbosity {

    93

            Quiet,

    94

            Normal,

    95

            Verbose

    96

        };

    97

        void setVerbosity(Verbosity);

    98

        Verbosity getVerbosity() const;

    99

   100

        void setAliases(const string &);

   101

        void setPositions(const string &);

   102

   103

        void setDomains(const string &);

   104

        typedef list<unsigned int> DomainIndexList;

   105

        DomainIndexList getDomainIndices() const;

   106

   107

        void setDataType(const string &);

   108

        const string &getDataType() const;

   109

   110

        void setEmergency(bool);

   111

        bool getEmergency() const;

   112

   113

        void setForce(bool);

   114

        bool getForce() const;

   115

   116

        void setOutputFile(const string &);

   117

        const string &getOutputFile() const;

   118

   119

        void setSkin(const string &);

   120

        const string &getSkin() const;

   121

   122

        bool matchesSubstr(const string &) const;

   123

        bool matchesAbbrev(const string &) const;

   124

   125

        virtual string helpString(const string &) const = 0;

   126

   127

        typedef vector<string> StringVector;

   128

        virtual void execute(const StringVector &) = 0;

   129

   130

        static string numericInfo();

   131

   132

    protected:

   133

        enum {BreakAfterBytes = 16};

   134

   135

        void throwInvalidUsageException(const stringstream &) const;

   136

        void throwCommandException(const string &) const;

   137

        void throwCommandException(const stringstream &) const;

   138

        void throwSingleSlaveRequired(unsigned int) const;

   139

   140

        typedef list<ec_ioctl_slave_t> SlaveList;

   141

        SlaveList selectedSlaves(MasterDevice &);

   142

        typedef list<ec_ioctl_config_t> ConfigList;

   143

        ConfigList selectedConfigs(MasterDevice &);

   144

        typedef list<ec_ioctl_domain_t> DomainList;

   145

        DomainList selectedDomains(MasterDevice &, const ec_ioctl_master_t &);

   146

        int emergencySlave() const;

   147

   148

        static string alStateString(uint8_t);

   149

   150

    private:

   151

        string name;

   152

        string briefDesc;

   153

        string masters;

   154

        Verbosity verbosity;

   155

        string aliases;

   156

        string positions;

   157

        string domains;

   158

        string dataType;

   159

        bool emergency;

   160

        bool force;

   161

        string outputFile;

   162

        string skin;

   163

   164

        Command();

   165

};

   166

   167

/****************************************************************************/

   168

   169

inline const string &Command::getName() const

   170

{

   171

    return name;

   172

}

   173

   174

/****************************************************************************/

   175

   176

inline const string &Command::getBriefDescription() const

   177

{

   178

    return briefDesc;

   179

}

   180

   181

/****************************************************************************/

   182

   183

inline Command::Verbosity Command::getVerbosity() const

   184

{

   185

    return verbosity;

   186

}

   187

   188

/****************************************************************************/

   189

   190

inline const string &Command::getDataType() const

   191

{

   192

    return dataType;

   193

}

   194

   195

/****************************************************************************/

   196

   197

inline bool Command::getEmergency() const

   198

{

   199

    return emergency;

   200

}

   201

   202

/****************************************************************************/

   203

   204

inline bool Command::getForce() const

   205

{

   206

    return force;

   207

}

   208

   209

/****************************************************************************/

   210

   211

inline const string &Command::getOutputFile() const

   212

{

   213

    return outputFile;

   214

}

   215

   216

/****************************************************************************/

   217

   218

inline const string &Command::getSkin() const

   219

{

   220

    return skin;

   221

}

   222

   223

/****************************************************************************/

   224

   225

#endif