JAUS::QueryMicrocontrollerState Class Reference

This message allows a component to query the state of digital and analogue pins on a microcontroller. More...

#include <querymicrocontrollerstate.h>

Inheritance diagram for JAUS::QueryMicrocontrollerState:

List of all members.

Public Member Functions
	QueryMicrocontrollerState (const Address &dest=Address(), const Address &src=Address())
	QueryMicrocontrollerState (const QueryMicrocontrollerState &message)
	~QueryMicrocontrollerState ()
void	SetDigitalStates (const std::set< std::string > &digital)
void	SetAnalogStates (const std::set< std::string > &analog)
std::set< std::string > *	GetDigitalStates ()
const std::set< std::string > *	GetDigitalStates () const
std::set< std::string > *	GetAnalogStates ()
const std::set< std::string > *	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
QueryMicrocontrollerState &	operator= (const QueryMicrocontrollerState &message)
Protected Attributes
std::set< std::string >	mDigitalDevices
	The digital devices to query state for (if empty, all are returned).
std::set< std::string >	mAnalogDevices
	The analog devices to query state for (if empty, all are returned).

---

Detailed Description

This message allows a component to query the state of digital and analogue pins on a microcontroller.

If no digital or analog states are set in the query (e.g. 0 digital or 0 analog) then all digital or all analog or all of both are reported back.

Definition at line 58 of file querymicrocontrollerstate.h.

---

Constructor & Destructor Documentation

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

Definition at line 61 of file querymicrocontrollerstate.h.

JAUS::QueryMicrocontrollerState::QueryMicrocontrollerState

(

const QueryMicrocontrollerState &

message )

[inline]

Definition at line 65 of file querymicrocontrollerstate.h.

JAUS::QueryMicrocontrollerState::~QueryMicrocontrollerState

(

)

[inline]

Definition at line 69 of file querymicrocontrollerstate.h.

---

Member Function Documentation

virtual void JAUS::QueryMicrocontrollerState::ClearMessageBody

(

)

[inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file querymicrocontrollerstate.h.

virtual Message* JAUS::QueryMicrocontrollerState::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file querymicrocontrollerstate.h.

std::set<std::string>* JAUS::QueryMicrocontrollerState::GetAnalogStates

(

)

[inline]

Definition at line 74 of file querymicrocontrollerstate.h.

const std::set<std::string>* JAUS::QueryMicrocontrollerState::GetAnalogStates

(

)

const [inline]

Definition at line 75 of file querymicrocontrollerstate.h.

std::set<std::string>* JAUS::QueryMicrocontrollerState::GetDigitalStates

(

)

[inline]

Definition at line 72 of file querymicrocontrollerstate.h.

const std::set<std::string>* JAUS::QueryMicrocontrollerState::GetDigitalStates

(

)

const [inline]

Definition at line 73 of file querymicrocontrollerstate.h.

virtual UShort JAUS::QueryMicrocontrollerState::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file querymicrocontrollerstate.h.

virtual std::string JAUS::QueryMicrocontrollerState::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 84 of file querymicrocontrollerstate.h.

virtual UInt JAUS::QueryMicrocontrollerState::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file querymicrocontrollerstate.h.

virtual UInt JAUS::QueryMicrocontrollerState::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file querymicrocontrollerstate.h.

virtual UInt JAUS::QueryMicrocontrollerState::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file querymicrocontrollerstate.h.

virtual bool JAUS::QueryMicrocontrollerState::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file querymicrocontrollerstate.h.

bool QueryMicrocontrollerState::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 143 of file querymicrocontrollerstate.cpp.

QueryMicrocontrollerState& JAUS::QueryMicrocontrollerState::operator=

(

const QueryMicrocontrollerState &

message )

[inline]

Definition at line 87 of file querymicrocontrollerstate.h.

int QueryMicrocontrollerState::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 100 of file querymicrocontrollerstate.cpp.

void JAUS::QueryMicrocontrollerState::SetAnalogStates

(

const std::set< std::string > &

analog )

[inline]

Definition at line 71 of file querymicrocontrollerstate.h.

void JAUS::QueryMicrocontrollerState::SetDigitalStates

(

const std::set< std::string > &

digital )

[inline]

Definition at line 70 of file querymicrocontrollerstate.h.

int QueryMicrocontrollerState::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 56 of file querymicrocontrollerstate.cpp.

---

Member Data Documentation

std::set<std::string> JAUS::QueryMicrocontrollerState::mAnalogDevices [protected]

The analog devices to query state for (if empty, all are returned).

Definition at line 96 of file querymicrocontrollerstate.h.

std::set<std::string> JAUS::QueryMicrocontrollerState::mDigitalDevices [protected]

The digital devices to query state for (if empty, all are returned).

Definition at line 95 of file querymicrocontrollerstate.h.

---

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

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