author | Florian Pose <fp@igh-essen.com> |
Tue, 05 Feb 2013 14:58:00 +0100 | |
branch | stable-1.5 |
changeset 2502 | 906ef8b1c0ec |
parent 2453 | d461b1f07296 |
child 2529 | c7e1f2616a9d |
permissions | -rw-r--r-- |
1142 | 1 |
/***************************************************************************** |
2 |
* |
|
1363
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
3 |
* $Id$ |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
4 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
5 |
* Copyright (C) 2006-2009 Florian Pose, Ingenieurgemeinschaft IgH |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
6 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
7 |
* This file is part of the IgH EtherCAT Master. |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
8 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
9 |
* The IgH EtherCAT Master is free software; you can redistribute it and/or |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
10 |
* modify it under the terms of the GNU General Public License version 2, as |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
11 |
* published by the Free Software Foundation. |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
12 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
13 |
* The IgH EtherCAT Master is distributed in the hope that it will be useful, |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
16 |
* Public License for more details. |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
17 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
18 |
* You should have received a copy of the GNU General Public License along |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
19 |
* with the IgH EtherCAT Master; if not, write to the Free Software |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
20 |
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
21 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
22 |
* --- |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
23 |
* |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
24 |
* The license mentioned above concerns the source code only. Using the |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
25 |
* EtherCAT technology and brand is only permitted in compliance with the |
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1335
diff
changeset
|
26 |
* industrial property and similar rights of Beckhoff Automation GmbH. |
1142 | 27 |
* |
28 |
****************************************************************************/ |
|
29 |
||
30 |
#ifndef __COMMAND_H__ |
|
31 |
#define __COMMAND_H__ |
|
32 |
||
33 |
#include <stdexcept> |
|
34 |
#include <vector> |
|
1151 | 35 |
#include <list> |
1826
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
36 |
#include <sstream> |
1142 | 37 |
using namespace std; |
38 |
||
1826
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
39 |
#include "../master/ioctl.h" |
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
40 |
|
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
41 |
class MasterDevice; |
1142 | 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: |
|
1834
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
65 |
/** Constructor with char * parameter. */ |
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
66 |
CommandException( |
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
67 |
const string &msg /**< Message. */ |
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
68 |
): runtime_error(msg) {} |
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
69 |
|
1142 | 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 &); |
|
1804 | 82 |
virtual ~Command(); |
1142 | 83 |
|
1151 | 84 |
const string &getName() const; |
85 |
const string &getBriefDescription() const; |
|
86 |
||
1826
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
87 |
typedef list<unsigned int> MasterIndexList; |
1869
14f634f5b613
Open master device as late as possible.
Florian Pose <fp@igh-essen.com>
parents:
1834
diff
changeset
|
88 |
void setMasters(const string &); |
14f634f5b613
Open master device as late as possible.
Florian Pose <fp@igh-essen.com>
parents:
1834
diff
changeset
|
89 |
MasterIndexList getMasterIndices() const; |
1870
0cee1fb7f0fd
Added getSingleMasterIndex() for command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1869
diff
changeset
|
90 |
unsigned int getSingleMasterIndex() const; |
1869
14f634f5b613
Open master device as late as possible.
Florian Pose <fp@igh-essen.com>
parents:
1834
diff
changeset
|
91 |
|
1142 | 92 |
enum Verbosity { |
93 |
Quiet, |
|
94 |
Normal, |
|
95 |
Verbose |
|
96 |
}; |
|
97 |
void setVerbosity(Verbosity); |
|
1804 | 98 |
Verbosity getVerbosity() const; |
2010
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
99 |
|
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
100 |
void setAliases(const string &); |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
101 |
void setPositions(const string &); |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
102 |
|
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
103 |
void setDomains(const string &); |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
104 |
typedef list<unsigned int> DomainIndexList; |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
105 |
DomainIndexList getDomainIndices() const; |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
106 |
|
1166 | 107 |
void setDataType(const string &); |
108 |
const string &getDataType() const; |
|
2010
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
109 |
|
1804 | 110 |
void setForce(bool); |
111 |
bool getForce() const; |
|
2010
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
112 |
|
1804 | 113 |
void setOutputFile(const string &); |
114 |
const string &getOutputFile() const; |
|
1142 | 115 |
|
2436
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
116 |
void setSkin(const string &); |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
117 |
const string &getSkin() const; |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
118 |
|
1142 | 119 |
bool matchesSubstr(const string &) const; |
120 |
bool matchesAbbrev(const string &) const; |
|
121 |
||
1968
4f682084c643
Implemented drive_no for command-line tool; binary base name is now a
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
122 |
virtual string helpString(const string &) const = 0; |
1142 | 123 |
|
124 |
typedef vector<string> StringVector; |
|
1826
ec6223c3b7ec
Multi-master support for command-line tool. The --master option supports
Florian Pose <fp@igh-essen.com>
parents:
1804
diff
changeset
|
125 |
virtual void execute(const StringVector &) = 0; |
1142 | 126 |
|
1144
7dbfdd61812c
Bugfixes and improvements.
Florian Pose <fp@igh-essen.com>
parents:
1142
diff
changeset
|
127 |
static string numericInfo(); |
7dbfdd61812c
Bugfixes and improvements.
Florian Pose <fp@igh-essen.com>
parents:
1142
diff
changeset
|
128 |
|
1142 | 129 |
protected: |
1804 | 130 |
enum {BreakAfterBytes = 16}; |
1151 | 131 |
|
1155
bd4e5b544473
Common message for single slave selections.
Florian Pose <fp@igh-essen.com>
parents:
1151
diff
changeset
|
132 |
void throwInvalidUsageException(const stringstream &) const; |
1834
67fc217d7341
Overloaded throwCommandException().
Florian Pose <fp@igh-essen.com>
parents:
1826
diff
changeset
|
133 |
void throwCommandException(const string &) const; |
1155
bd4e5b544473
Common message for single slave selections.
Florian Pose <fp@igh-essen.com>
parents:
1151
diff
changeset
|
134 |
void throwCommandException(const stringstream &) const; |
bd4e5b544473
Common message for single slave selections.
Florian Pose <fp@igh-essen.com>
parents:
1151
diff
changeset
|
135 |
void throwSingleSlaveRequired(unsigned int) const; |
1142 | 136 |
|
1151 | 137 |
typedef list<ec_ioctl_slave_t> SlaveList; |
138 |
SlaveList selectedSlaves(MasterDevice &); |
|
1156
ecaf2a896ea3
Implemented alias and position for configs.
Florian Pose <fp@igh-essen.com>
parents:
1155
diff
changeset
|
139 |
typedef list<ec_ioctl_config_t> ConfigList; |
ecaf2a896ea3
Implemented alias and position for configs.
Florian Pose <fp@igh-essen.com>
parents:
1155
diff
changeset
|
140 |
ConfigList selectedConfigs(MasterDevice &); |
1166 | 141 |
typedef list<ec_ioctl_domain_t> DomainList; |
2453
d461b1f07296
Added configure option for redundancy (--with-devices).
Florian Pose <fp@igh-essen.com>
parents:
2436
diff
changeset
|
142 |
DomainList selectedDomains(MasterDevice &, const ec_ioctl_master_t &); |
1151 | 143 |
|
1146
f18d124d7fbc
Moved slaveState() to Command::alStateString().
Florian Pose <fp@igh-essen.com>
parents:
1144
diff
changeset
|
144 |
static string alStateString(uint8_t); |
1142 | 145 |
|
146 |
private: |
|
1804 | 147 |
string name; |
1142 | 148 |
string briefDesc; |
1869
14f634f5b613
Open master device as late as possible.
Florian Pose <fp@igh-essen.com>
parents:
1834
diff
changeset
|
149 |
string masters; |
1142 | 150 |
Verbosity verbosity; |
2010
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
151 |
string aliases; |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
152 |
string positions; |
87de63b19e4c
Implemented ranges for slaves, configs and domains.
Florian Pose <fp@igh-essen.com>
parents:
1870
diff
changeset
|
153 |
string domains; |
1804 | 154 |
string dataType; |
155 |
bool force; |
|
156 |
string outputFile; |
|
2436
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
157 |
string skin; |
1142 | 158 |
|
159 |
Command(); |
|
160 |
}; |
|
161 |
||
162 |
/****************************************************************************/ |
|
163 |
||
164 |
inline const string &Command::getName() const |
|
165 |
{ |
|
166 |
return name; |
|
167 |
} |
|
168 |
||
169 |
/****************************************************************************/ |
|
170 |
||
171 |
inline const string &Command::getBriefDescription() const |
|
172 |
{ |
|
173 |
return briefDesc; |
|
174 |
} |
|
175 |
||
176 |
/****************************************************************************/ |
|
177 |
||
178 |
inline Command::Verbosity Command::getVerbosity() const |
|
179 |
{ |
|
180 |
return verbosity; |
|
181 |
} |
|
182 |
||
183 |
/****************************************************************************/ |
|
184 |
||
1166 | 185 |
inline const string &Command::getDataType() const |
186 |
{ |
|
187 |
return dataType; |
|
188 |
} |
|
189 |
||
190 |
/****************************************************************************/ |
|
191 |
||
192 |
inline bool Command::getForce() const |
|
193 |
{ |
|
194 |
return force; |
|
195 |
} |
|
196 |
||
197 |
/****************************************************************************/ |
|
198 |
||
1335
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
199 |
inline const string &Command::getOutputFile() const |
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
200 |
{ |
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
201 |
return outputFile; |
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
202 |
} |
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
203 |
|
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
204 |
/****************************************************************************/ |
09c6fce1ae45
merge -c1616 branches/1.4-foe: Included FoE patch from Olav Zarges.
Florian Pose <fp@igh-essen.com>
parents:
1166
diff
changeset
|
205 |
|
2436
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
206 |
inline const string &Command::getSkin() const |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
207 |
{ |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
208 |
return skin; |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
209 |
} |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
210 |
|
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
211 |
/****************************************************************************/ |
960cc1bb6b4a
EtherLab skin for 'ethercat pdos' command.
Florian Pose <fp@igh-essen.com>
parents:
2011
diff
changeset
|
212 |
|
1142 | 213 |
#endif |