JAUS::SetEmergency Class Reference

This message is used to alert the component to a safety critical situation. The component that sends the emergency command shall set the message priority to safety critical priority range as defined by the Transport. Receiving of an emergency command shall result in the component transitioning into the emergency state. More...

#include <setemergency.h>

Inheritance diagram for JAUS::SetEmergency:

List of all members.

Public Member Functions
	SetEmergency (const Address &dest=Address(), const Address &src=Address())
	SetEmergency (const SetEmergency &message)
	~SetEmergency ()
void	SetEmergencyCode (const UShort code)
UShort	GetEmergencyCode () const
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
virtual int	ReadMessageBody (const Packet &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
SetEmergency &	operator= (const SetEmergency &message)
Protected Attributes
UShort	mEmergencyCode
	1 = Stop.

---

Detailed Description

This message is used to alert the component to a safety critical situation. The component that sends the emergency command shall set the message priority to safety critical priority range as defined by the Transport. Receiving of an emergency command shall result in the component transitioning into the emergency state.

Definition at line 58 of file setemergency.h.

---

Constructor & Destructor Documentation

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

Definition at line 61 of file setemergency.h.

JAUS::SetEmergency::SetEmergency

(

const SetEmergency &

message )

[inline]

Definition at line 66 of file setemergency.h.

JAUS::SetEmergency::~SetEmergency

(

)

[inline]

Definition at line 71 of file setemergency.h.

---

Member Function Documentation

virtual void JAUS::SetEmergency::ClearMessageBody

(

)

[inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file setemergency.h.

virtual Message* JAUS::SetEmergency::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file setemergency.h.

UShort JAUS::SetEmergency::GetEmergencyCode

(

)

const [inline]

Definition at line 75 of file setemergency.h.

virtual UShort JAUS::SetEmergency::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file setemergency.h.

virtual std::string JAUS::SetEmergency::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 84 of file setemergency.h.

virtual UInt JAUS::SetEmergency::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file setemergency.h.

virtual UInt JAUS::SetEmergency::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file setemergency.h.

virtual UInt JAUS::SetEmergency::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file setemergency.h.

virtual bool JAUS::SetEmergency::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file setemergency.h.

virtual bool JAUS::SetEmergency::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file setemergency.h.

SetEmergency& JAUS::SetEmergency::operator=

(

const SetEmergency &

message )

[inline]

Definition at line 87 of file setemergency.h.

virtual int JAUS::SetEmergency::ReadMessageBody

(

const Packet &

packet )

[inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file setemergency.h.

void JAUS::SetEmergency::SetEmergencyCode

(

const UShort

code )

[inline]

Definition at line 74 of file setemergency.h.

virtual int JAUS::SetEmergency::WriteMessageBody

(

Packet &

packet )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file setemergency.h.

---

Member Data Documentation

UShort JAUS::SetEmergency::mEmergencyCode [protected]

1 = Stop.

Definition at line 94 of file setemergency.h.

---

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

• jaus++/2.0/include/jaus/core/management/setemergency.h