JAUS::SetMicrocontrollerState Class Reference

This message allows a component to set the state of any digital or analog devices attached to a microcontroller. More...

#include <setmicrocontrollerstate.h>

Inheritance diagram for JAUS::SetMicrocontrollerState:

List of all members.

Public Member Functions
	SetMicrocontrollerState (const Address &dest=Address(), const Address &src=Address())
	SetMicrocontrollerState (const SetMicrocontrollerState &message)
	~SetMicrocontrollerState ()
Microcontroller::DigitalStates *	GetDigitalStates ()
const Microcontroller::DigitalStates *	GetDigitalStates () const
Microcontroller::AnalogStates *	GetAnalogStates ()
const Microcontroller::AnalogStates *	GetAnalogStates () const
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize) const
SetMicrocontrollerState &	operator= (const SetMicrocontrollerState &message)
Protected Attributes
Microcontroller::DigitalStates	mDigitalStates
	Digital states to set.
Microcontroller::AnalogStates	mAnalogStates
	Analog states to set.

---

Detailed Description

This message allows a component to set the state of any digital or analog devices attached to a microcontroller.

Definition at line 56 of file setmicrocontrollerstate.h.

---

Constructor & Destructor Documentation

JAUS::SetMicrocontrollerState::SetMicrocontrollerState	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)		[inline]

Definition at line 59 of file setmicrocontrollerstate.h.

JAUS::SetMicrocontrollerState::SetMicrocontrollerState

(

const SetMicrocontrollerState &

message )

[inline]

Definition at line 63 of file setmicrocontrollerstate.h.

JAUS::SetMicrocontrollerState::~SetMicrocontrollerState

(

)

[inline]

Definition at line 67 of file setmicrocontrollerstate.h.

---

Member Function Documentation

virtual void JAUS::SetMicrocontrollerState::ClearMessageBody

(

)

[inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file setmicrocontrollerstate.h.

virtual Message* JAUS::SetMicrocontrollerState::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file setmicrocontrollerstate.h.

Microcontroller::AnalogStates* JAUS::SetMicrocontrollerState::GetAnalogStates

(

)

[inline]

Definition at line 70 of file setmicrocontrollerstate.h.

const Microcontroller::AnalogStates* JAUS::SetMicrocontrollerState::GetAnalogStates

(

)

const [inline]

Definition at line 71 of file setmicrocontrollerstate.h.

const Microcontroller::DigitalStates* JAUS::SetMicrocontrollerState::GetDigitalStates

(

)

const [inline]

Definition at line 69 of file setmicrocontrollerstate.h.

Microcontroller::DigitalStates* JAUS::SetMicrocontrollerState::GetDigitalStates

(

)

[inline]

Definition at line 68 of file setmicrocontrollerstate.h.

virtual UShort JAUS::SetMicrocontrollerState::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file setmicrocontrollerstate.h.

virtual std::string JAUS::SetMicrocontrollerState::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file setmicrocontrollerstate.h.

virtual UInt JAUS::SetMicrocontrollerState::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file setmicrocontrollerstate.h.

virtual UInt JAUS::SetMicrocontrollerState::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file setmicrocontrollerstate.h.

virtual UInt JAUS::SetMicrocontrollerState::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file setmicrocontrollerstate.h.

virtual bool JAUS::SetMicrocontrollerState::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file setmicrocontrollerstate.h.

bool SetMicrocontrollerState::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [virtual]

Returns:

True if the contents of the message will be larger than maximum payload size, otherwise false.

Implements JAUS::Message.

Definition at line 153 of file setmicrocontrollerstate.cpp.

SetMicrocontrollerState& JAUS::SetMicrocontrollerState::operator=

(

const SetMicrocontrollerState &

message )

[inline]

Definition at line 83 of file setmicrocontrollerstate.h.

int SetMicrocontrollerState::ReadMessageBody

(

const Packet &

packet )

[virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in]

packet

Packet containing message payload data to read.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 106 of file setmicrocontrollerstate.cpp.

int SetMicrocontrollerState::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 57 of file setmicrocontrollerstate.cpp.

---

Member Data Documentation

Microcontroller::AnalogStates JAUS::SetMicrocontrollerState::mAnalogStates [protected]

Analog states to set.

Definition at line 92 of file setmicrocontrollerstate.h.

Microcontroller::DigitalStates JAUS::SetMicrocontrollerState::mDigitalStates [protected]

Digital states to set.

Definition at line 91 of file setmicrocontrollerstate.h.

---

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

• jaus++/2.0/include/jaus/extras/mcu/setmicrocontrollerstate.h
• jaus++/2.0/src/jaus/extras/mcu/setmicrocontrollerstate.cpp