Class encapsulated read single io data. Motoman specific interface to read a single IO element on the controller. More...
#include <motoman_read_single_io.h>
Public Member Functions | |
| unsigned int | byteLength () |
| void | copyFrom (ReadSingleIO &src) |
| Copies the passed in value. | |
| industrial::shared_types::shared_int | getAddress () |
| Returns the address of the IO element. | |
| void | init () |
| Initializes a empty motion control command. | |
| void | init (industrial::shared_types::shared_int address) |
| Initializes a complete motion control command. | |
| bool | load (industrial::byte_array::ByteArray *buffer) |
| bool | operator== (ReadSingleIO &rhs) |
| == operator implementation | |
| ReadSingleIO (void) | |
| Default constructor. | |
| void | setAddress (industrial::shared_types::shared_int address) |
| Sets address. | |
| bool | unload (industrial::byte_array::ByteArray *buffer) |
| ~ReadSingleIO (void) | |
| Destructor. | |
Private Attributes | |
| industrial::shared_types::shared_int | address_ |
| Address of IO element. | |
Detailed Description
Class encapsulated read single io data. Motoman specific interface to read a single IO element on the controller.
The byte representation of a read single IO command is as follows (in order lowest index to highest). The standard sizes are given, but can change based on type sizes:
member: type size address (industrial::shared_types::shared_int) 4 bytes
THIS CLASS IS NOT THREAD-SAFE
Definition at line 72 of file motoman_read_single_io.h.
Constructor & Destructor Documentation
Default constructor.
This method creates empty data.
Definition at line 54 of file motoman_read_single_io.cpp.
Destructor.
Definition at line 58 of file motoman_read_single_io.cpp.
Member Function Documentation
| unsigned int motoman::simple_message::io_ctrl::ReadSingleIO::byteLength | ( | ) | [inline, virtual] |
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 137 of file motoman_read_single_io.h.
Copies the passed in value.
- Parameters:
-
src (value to copy)
Definition at line 73 of file motoman_read_single_io.cpp.
| industrial::shared_types::shared_int motoman::simple_message::io_ctrl::ReadSingleIO::getAddress | ( | ) | [inline] |
Returns the address of the IO element.
- Returns:
- address
Definition at line 115 of file motoman_read_single_io.h.
Initializes a empty motion control command.
Definition at line 62 of file motoman_read_single_io.cpp.
| void motoman::simple_message::io_ctrl::ReadSingleIO::init | ( | industrial::shared_types::shared_int | address | ) |
Initializes a complete motion control command.
Definition at line 68 of file motoman_read_single_io.cpp.
| bool motoman::simple_message::io_ctrl::ReadSingleIO::load | ( | industrial::byte_array::ByteArray * | buffer | ) | [virtual] |
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 85 of file motoman_read_single_io.cpp.
| bool motoman::simple_message::io_ctrl::ReadSingleIO::operator== | ( | ReadSingleIO & | rhs | ) |
== operator implementation
- Returns:
- true if equal
Definition at line 78 of file motoman_read_single_io.cpp.
| void motoman::simple_message::io_ctrl::ReadSingleIO::setAddress | ( | industrial::shared_types::shared_int | address | ) | [inline] |
Sets address.
- Parameters:
-
address Controller address of the targeted IO element.
Definition at line 105 of file motoman_read_single_io.h.
| bool motoman::simple_message::io_ctrl::ReadSingleIO::unload | ( | industrial::byte_array::ByteArray * | buffer | ) | [virtual] |
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 99 of file motoman_read_single_io.cpp.
Member Data Documentation
industrial::shared_types::shared_int motoman::simple_message::io_ctrl::ReadSingleIO::address_ [private] |
Address of IO element.
Definition at line 146 of file motoman_read_single_io.h.
The documentation for this class was generated from the following files: