execute_program.h
Go to the documentation of this file.
1 /*********************************************************************
2 * FSRobo-R Package BSDL
3 * ---------
4 * Copyright (C) 2019 FUJISOFT. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without modification,
7 * are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation and/or
12 * other materials provided with the distribution.
13 * 3. Neither the name of the copyright holder nor the names of its contributors
14 * may be used to endorse or promote products derived from this software without
15 * specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *********************************************************************/
28 
29 #ifndef FSROBO_R_DRIVER_SIMPLE_MESSAGE_EXECUTE_PROGRAM_H
30 #define FSROBO_R_DRIVER_SIMPLE_MESSAGE_EXECUTE_PROGRAM_H
31 
36 #include <vector>
37 
38 namespace fsrobo_r_driver
39 {
40 namespace simple_message
41 {
42 namespace execute_program
43 {
45 
63 {
64 public:
71  ExecuteProgram(void);
72 
77  ~ExecuteProgram(void);
78 
83  void init();
84 
89  void init(SimpleString &name, SimpleString &param);
90 
96  void setName(SimpleString &name)
97  {
98  this->name_.copyFrom(name);
99  }
100 
106  void getName(SimpleString &dest)
107  {
108  dest.copyFrom(this->name_);
109  }
110 
116  void setParam(SimpleString &param)
117  {
118  this->param_.copyFrom(param);
119  }
120 
126  void getParam(SimpleString &dest)
127  {
128  dest.copyFrom(this->param_);
129  }
135  void copyFrom(ExecuteProgram &src);
136 
142  bool operator==(ExecuteProgram &rhs);
143 
144  // Overrides - SimpleSerialize
147  unsigned int byteLength()
148  {
149  return name_.byteLength() + param_.byteLength();
150  }
151 
152 private:
157 
162 };
163 }
164 }
165 }
166 
167 #endif // FSROBO_R_DRIVER_SIMPLE_MESSAGE_EXECUTE_PROGRAM_H
void init()
Initializes a empty execute program command.
bool param(const std::string &param_name, T &param_val, const T &default_val)
void copyFrom(ExecuteProgram &src)
Copies the passed in value.
bool unload(industrial::byte_array::ByteArray *buffer)
void copyFrom(SimpleString &src)
Copies the passed in value.
bool operator==(ExecuteProgram &rhs)
== operator implementation
bool load(industrial::byte_array::ByteArray *buffer)
Class encapsulated set io reply data. These messages are sent by the FSRobo-R controller in response ...
Definition: simple_string.h:61
void getName(SimpleString &dest)
Returns a copy of the name data.
Class encapsulated write single io data. FSRobo-R specific interface to set IO element on the control...
void getParam(SimpleString &dest)
Returns a copy of the name data.


fsrobo_r_driver
Author(s): F-ROSROBO
autogenerated on Sun Feb 9 2020 03:58:29