fsrobo_r_driver::simple_message::execute_program::ExecuteProgram Class Reference

Class encapsulated write single io data. FSRobo-R specific interface to set IO element on the controller. More...

#include <execute_program.h>

Inheritance diagram for fsrobo_r_driver::simple_message::execute_program::ExecuteProgram:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (ExecuteProgram &src)
	Copies the passed in value. More...
	ExecuteProgram (void)
	Default constructor. More...
void	getName (SimpleString &dest)
	Returns a copy of the name data. More...
void	getParam (SimpleString &dest)
	Returns a copy of the name data. More...
void	init ()
	Initializes a empty execute program command. More...
void	init (SimpleString &name, SimpleString &param)
	Initializes a complete execute program command. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (ExecuteProgram &rhs)
	== operator implementation More...
void	setName (SimpleString &name)
	Sets name data. More...
void	setParam (SimpleString &param)
	Sets param data. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	~ExecuteProgram (void)
	Destructor. More...

Private Attributes
SimpleString	name_
	Value of program name. More...
SimpleString	param_
	Value of program param. More...

Detailed Description

Class encapsulated write single io data. FSRobo-R specific interface to set 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 62 of file execute_program.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::ExecuteProgram

(

void

)

Default constructor.

This method creates empty data.

Definition at line 45 of file execute_program.cpp.

fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::~ExecuteProgram

(

void

)

Destructor.

Definition at line 46 of file execute_program.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 147 of file execute_program.h.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::copyFrom

(

ExecuteProgram &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 56 of file execute_program.cpp.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::getName ( SimpleString &  dest )

inline

Returns a copy of the name data.

Parameters

dest

name

Definition at line 106 of file execute_program.h.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::getParam ( SimpleString &  dest )

inline

Returns a copy of the name data.

Parameters

dest

name

Definition at line 126 of file execute_program.h.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::init

(

)

Initializes a empty execute program command.

Definition at line 46 of file execute_program.cpp.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::init	(	SimpleString &	name,
		SimpleString &	param
	)

Initializes a complete execute program command.

Definition at line 50 of file execute_program.cpp.

bool fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 69 of file execute_program.cpp.

bool fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::operator==

(

ExecuteProgram &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 62 of file execute_program.cpp.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::setName ( SimpleString &  name )

inline

Sets name data.

Parameters

name

Definition at line 96 of file execute_program.h.

void fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::setParam ( SimpleString &  param )

inline

Sets param data.

Parameters

param

Definition at line 116 of file execute_program.h.

bool fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 90 of file execute_program.cpp.

Member Data Documentation

SimpleString fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::name_

private

Value of program name.

Definition at line 156 of file execute_program.h.

SimpleString fsrobo_r_driver::simple_message::execute_program::ExecuteProgram::param_

private

Value of program param.

Definition at line 161 of file execute_program.h.

---

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

• execute_program.h
• execute_program.cpp