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 stringstream parameter. */

    66

        CommandException(

    67

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

    68

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

    69

};

    70

    71

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

    72

    73

class Command

    74

{

    75

    public:

    76

        Command(const string &, const string &);

    77

        virtual ~Command();

    78

    79

        const string &getName() const;

    80

        const string &getBriefDescription() const;

    81

    82

        typedef list<unsigned int> MasterIndexList;

    83

        void setMasterIndices(const MasterIndexList &);

    84

        const MasterIndexList &getMasterIndices() const;

    85

        enum Verbosity {

    86

            Quiet,

    87

            Normal,

    88

            Verbose

    89

        };

    90

        void setVerbosity(Verbosity);

    91

        Verbosity getVerbosity() const;

    92

        void setAlias(int);

    93

        int getAlias() const;

    94

        void setPosition(int);

    95

        int getPosition() const;

    96

        void setDomain(int);

    97

        int getDomain() const;

    98

        void setDataType(const string &);

    99

        const string &getDataType() const;

   100

        void setForce(bool);

   101

        bool getForce() const;

   102

        void setOutputFile(const string &);

   103

        const string &getOutputFile() const;

   104

   105

        bool matchesSubstr(const string &) const;

   106

        bool matchesAbbrev(const string &) const;

   107

   108

        virtual string helpString() const = 0;

   109

   110

        typedef vector<string> StringVector;

   111

        virtual void execute(const StringVector &) = 0;

   112

   113

        static string numericInfo();

   114

   115

    protected:

   116

        enum {BreakAfterBytes = 16};

   117

   118

        void throwInvalidUsageException(const stringstream &) const;

   119

        void throwCommandException(const stringstream &) const;

   120

        void throwSingleSlaveRequired(unsigned int) const;

   121

   122

        typedef list<ec_ioctl_slave_t> SlaveList;

   123

        SlaveList selectedSlaves(MasterDevice &);

   124

        typedef list<ec_ioctl_config_t> ConfigList;

   125

        ConfigList selectedConfigs(MasterDevice &);

   126

        typedef list<ec_ioctl_domain_t> DomainList;

   127

        DomainList selectedDomains(MasterDevice &);

   128

   129

        static string alStateString(uint8_t);

   130

   131

    private:

   132

        string name;

   133

        string briefDesc;

   134

        MasterIndexList masterIndices;

   135

        Verbosity verbosity;

   136

        int alias;

   137

        int position;

   138

        int domain;

   139

        string dataType;

   140

        bool force;

   141

        string outputFile;

   142

   143

        Command();

   144

};

   145

   146

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

   147

   148

inline const string &Command::getName() const

   149

{

   150

    return name;

   151

}

   152

   153

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

   154

   155

inline const string &Command::getBriefDescription() const

   156

{

   157

    return briefDesc;

   158

}

   159

   160

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

   161

   162

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

   163

{

   164

    return masterIndices;

   165

}

   166

   167

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

   168

   169

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

   170

{

   171

    return verbosity;

   172

}

   173

   174

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

   175

   176

inline int Command::getAlias() const

   177

{

   178

    return alias;

   179

}

   180

   181

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

   182

   183

inline int Command::getPosition() const

   184

{

   185

    return position;

   186

}

   187

   188

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

   189

   190

inline int Command::getDomain() const

   191

{

   192

    return domain;

   193

}

   194

   195

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

   196

   197

inline const string &Command::getDataType() const

   198

{

   199

    return dataType;

   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

#endif