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 setMasterIndices(const MasterIndexList &);

    89

        const MasterIndexList &getMasterIndices() const;

    90

        enum Verbosity {

    91

            Quiet,

    92

            Normal,

    93

            Verbose

    94

        };

    95

        void setVerbosity(Verbosity);

    96

        Verbosity getVerbosity() const;

    97

        void setAlias(int);

    98

        int getAlias() const;

    99

        void setPosition(int);

   100

        int getPosition() const;

   101

        void setDomain(int);

   102

        int getDomain() const;

   103

        void setDataType(const string &);

   104

        const string &getDataType() const;

   105

        void setForce(bool);

   106

        bool getForce() const;

   107

        void setOutputFile(const string &);

   108

        const string &getOutputFile() const;

   109

   110

        bool matchesSubstr(const string &) const;

   111

        bool matchesAbbrev(const string &) const;

   112

   113

        virtual string helpString() const = 0;

   114

   115

        typedef vector<string> StringVector;

   116

        virtual void execute(const StringVector &) = 0;

   117

   118

        static string numericInfo();

   119

   120

    protected:

   121

        enum {BreakAfterBytes = 16};

   122

   123

        void throwInvalidUsageException(const stringstream &) const;

   124

        void throwCommandException(const string &) const;

   125

        void throwCommandException(const stringstream &) const;

   126

        void throwSingleSlaveRequired(unsigned int) const;

   127

   128

        typedef list<ec_ioctl_slave_t> SlaveList;

   129

        SlaveList selectedSlaves(MasterDevice &);

   130

        typedef list<ec_ioctl_config_t> ConfigList;

   131

        ConfigList selectedConfigs(MasterDevice &);

   132

        typedef list<ec_ioctl_domain_t> DomainList;

   133

        DomainList selectedDomains(MasterDevice &);

   134

   135

        static string alStateString(uint8_t);

   136

   137

    private:

   138

        string name;

   139

        string briefDesc;

   140

        MasterIndexList masterIndices;

   141

        Verbosity verbosity;

   142

        int alias;

   143

        int position;

   144

        int domain;

   145

        string dataType;

   146

        bool force;

   147

        string outputFile;

   148

   149

        Command();

   150

};

   151

   152

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

   153

   154

inline const string &Command::getName() const

   155

{

   156

    return name;

   157

}

   158

   159

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

   160

   161

inline const string &Command::getBriefDescription() const

   162

{

   163

    return briefDesc;

   164

}

   165

   166

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

   167

   168

inline const Command::MasterIndexList &Command::getMasterIndices() const

   169

{

   170

    return masterIndices;

   171

}

   172

   173

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

   174

   175

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

   176

{

   177

    return verbosity;

   178

}

   179

   180

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

   181

   182

inline int Command::getAlias() const

   183

{

   184

    return alias;

   185

}

   186

   187

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

   188

   189

inline int Command::getPosition() const

   190

{

   191

    return position;

   192

}

   193

   194

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

   195

   196

inline int Command::getDomain() const

   197

{

   198

    return domain;

   199

}

   200

   201

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

   202

   203

inline const string &Command::getDataType() const

   204

{

   205

    return dataType;

   206

}

   207

   208

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

   209

   210

inline bool Command::getForce() const

   211

{

   212

    return force;

   213

}

   214

   215

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

   216

   217

inline const string &Command::getOutputFile() const

   218

{

   219

    return outputFile;

   220

}

   221

   222

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

   223

   224

#endif