motoman::simple_message::io_ctrl::WriteSingleIO Class Reference

Class encapsulated write single io data. Motoman specific interface to write a single IO element on the controller. More...

#include <motoman_write_single_io.h>

Inheritance diagram for motoman::simple_message::io_ctrl::WriteSingleIO:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (WriteSingleIO &src)
	Copies the passed in value. More...
industrial::shared_types::shared_int	getAddress ()
	Returns the address of the IO element. More...
industrial::shared_types::shared_int	getValue ()
	Returns the value of the IO element. More...
void	init ()
	Initializes a empty write single io command. More...
void	init (industrial::shared_types::shared_int address, industrial::shared_types::shared_int value)
	Initializes a complete write single io command. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (WriteSingleIO &rhs)
	== operator implementation More...
void	setAddress (industrial::shared_types::shared_int address)
	Sets address. More...
void	setValue (industrial::shared_types::shared_int value)
	Sets value. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	WriteSingleIO (void)
	Default constructor. More...
	~WriteSingleIO (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_int	address_
	Address of IO element. More...
industrial::shared_types::shared_int	value_
	Value of IO element. More...

Detailed Description

Class encapsulated write single io data. Motoman specific interface to write a single IO element on the controller.

The byte representation of a write 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 value (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 73 of file motoman_write_single_io.h.

Constructor & Destructor Documentation

motoman::simple_message::io_ctrl::WriteSingleIO::WriteSingleIO

(

void

)

Default constructor.

This method creates empty data.

Definition at line 54 of file motoman_write_single_io.cpp.

motoman::simple_message::io_ctrl::WriteSingleIO::~WriteSingleIO

(

void

)

Destructor.

Definition at line 58 of file motoman_write_single_io.cpp.

Member Function Documentation

unsigned int motoman::simple_message::io_ctrl::WriteSingleIO::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 159 of file motoman_write_single_io.h.

void motoman::simple_message::io_ctrl::WriteSingleIO::copyFrom

(

WriteSingleIO &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 74 of file motoman_write_single_io.cpp.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl::WriteSingleIO::getAddress ( )

inline

Returns the address of the IO element.

Returns

address

Definition at line 127 of file motoman_write_single_io.h.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl::WriteSingleIO::getValue ( )

inline

Returns the value of the IO element.

Returns

value

Definition at line 137 of file motoman_write_single_io.h.

void motoman::simple_message::io_ctrl::WriteSingleIO::init

(

)

Initializes a empty write single io command.

Definition at line 62 of file motoman_write_single_io.cpp.

void motoman::simple_message::io_ctrl::WriteSingleIO::init	(	industrial::shared_types::shared_int	address,
		industrial::shared_types::shared_int	value
	)

Initializes a complete write single io command.

Definition at line 68 of file motoman_write_single_io.cpp.

bool motoman::simple_message::io_ctrl::WriteSingleIO::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 88 of file motoman_write_single_io.cpp.

bool motoman::simple_message::io_ctrl::WriteSingleIO::operator==

(

WriteSingleIO &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 80 of file motoman_write_single_io.cpp.

void motoman::simple_message::io_ctrl::WriteSingleIO::setAddress ( industrial::shared_types::shared_int  address )

inline

Sets address.

Parameters

address

Controller address of the targeted IO element.

Definition at line 107 of file motoman_write_single_io.h.

void motoman::simple_message::io_ctrl::WriteSingleIO::setValue ( industrial::shared_types::shared_int  value )

inline

Sets value.

Parameters

value

Controller value of the targeted IO element.

Definition at line 117 of file motoman_write_single_io.h.

bool motoman::simple_message::io_ctrl::WriteSingleIO::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 108 of file motoman_write_single_io.cpp.

Member Data Documentation

industrial::shared_types::shared_int motoman::simple_message::io_ctrl::WriteSingleIO::address_

private

Address of IO element.

Definition at line 168 of file motoman_write_single_io.h.

industrial::shared_types::shared_int motoman::simple_message::io_ctrl::WriteSingleIO::value_

private

Value of IO element.

Definition at line 173 of file motoman_write_single_io.h.

---

The documentation for this class was generated from the following files:

• motoman_write_single_io.h
• motoman_write_single_io.cpp