fsrobo_r_driver::simple_message::sys_stat::SysStat Class Reference

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

#include <sys_stat.h>

Inheritance diagram for fsrobo_r_driver::simple_message::sys_stat::SysStat:

Public Member Functions
unsigned int	byteLength ()
void	copyFrom (SysStat &src)
	Copies the passed in value. More...
industrial::shared_types::shared_int	getResult ()
	Returns the value of the SysStat element. More...
industrial::shared_types::shared_int	getStatType ()
	Returns the value of the SysStat element. More...
void	init ()
	Initializes a empty write single io command. More...
void	init (industrial::shared_types::shared_int stat_type, industrial::shared_types::shared_int result)
	Initializes a complete SysStat command. More...
bool	load (industrial::byte_array::ByteArray *buffer)
bool	operator== (SysStat &rhs)
	== operator implementation More...
void	setResult (industrial::shared_types::shared_int result)
	Sets result. More...
void	setStatType (industrial::shared_types::shared_int stat_type)
	Sets stat type. More...
	SysStat (void)
	Default constructor. More...
bool	unload (industrial::byte_array::ByteArray *buffer)
	~SysStat (void)
	Destructor. More...

Private Attributes
industrial::shared_types::shared_int	result_
	Address of SysStat element. More...
industrial::shared_types::shared_int	stat_type_
	Value of SysStat element. 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 stat_type (industrial::shared_types::shared_int) 4 bytes result (industrial::shared_types::shared_int) 4 bytes

THIS CLASS IS NOT THREAD-SAFE

Definition at line 81 of file sys_stat.h.

Constructor & Destructor Documentation

fsrobo_r_driver::simple_message::sys_stat::SysStat::SysStat

(

void

)

Default constructor.

This method creates empty data.

Definition at line 44 of file sys_stat.cpp.

fsrobo_r_driver::simple_message::sys_stat::SysStat::~SysStat

(

void

)

Destructor.

Definition at line 49 of file sys_stat.cpp.

Member Function Documentation

unsigned int fsrobo_r_driver::simple_message::sys_stat::SysStat::byteLength ( )

inlinevirtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 166 of file sys_stat.h.

void fsrobo_r_driver::simple_message::sys_stat::SysStat::copyFrom

(

SysStat &

src

)

Copies the passed in value.

Parameters

src	(value to copy)

Definition at line 65 of file sys_stat.cpp.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat::SysStat::getResult ( )

inline

Returns the value of the SysStat element.

Returns

result value

Definition at line 144 of file sys_stat.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat::SysStat::getStatType ( )

inline

Returns the value of the SysStat element.

Returns

stat type value

Definition at line 134 of file sys_stat.h.

void fsrobo_r_driver::simple_message::sys_stat::SysStat::init

(

)

Initializes a empty write single io command.

Definition at line 53 of file sys_stat.cpp.

void fsrobo_r_driver::simple_message::sys_stat::SysStat::init	(	industrial::shared_types::shared_int	stat_type,
		industrial::shared_types::shared_int	result
	)

Initializes a complete SysStat command.

Definition at line 59 of file sys_stat.cpp.

bool fsrobo_r_driver::simple_message::sys_stat::SysStat::load ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 79 of file sys_stat.cpp.

bool fsrobo_r_driver::simple_message::sys_stat::SysStat::operator==

(

SysStat &

rhs

)

== operator implementation

Returns

true if equal

Definition at line 71 of file sys_stat.cpp.

void fsrobo_r_driver::simple_message::sys_stat::SysStat::setResult ( industrial::shared_types::shared_int  result )

inline

Sets result.

Parameters

result

result value of SysStat element.

Definition at line 124 of file sys_stat.h.

void fsrobo_r_driver::simple_message::sys_stat::SysStat::setStatType ( industrial::shared_types::shared_int  stat_type )

inline

Sets stat type.

Parameters

stat_type

Status type value of SysStat element.

Definition at line 114 of file sys_stat.h.

bool fsrobo_r_driver::simple_message::sys_stat::SysStat::unload ( industrial::byte_array::ByteArray *  buffer )

virtual

Implements industrial::simple_serialize::SimpleSerialize.

Definition at line 99 of file sys_stat.cpp.

Member Data Documentation

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat::SysStat::result_

private

Address of SysStat element.

Definition at line 180 of file sys_stat.h.

industrial::shared_types::shared_int fsrobo_r_driver::simple_message::sys_stat::SysStat::stat_type_

private

Value of SysStat element.

Definition at line 175 of file sys_stat.h.

---

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

• sys_stat.h
• sys_stat.cpp