JAUS::SetGeomagneticProperty Class Reference

This message is used to set the location specific magnetic variation for adjusting the GPS heading. More...

#include <setgeomagneticproperty.h>

Inheritance diagram for JAUS::SetGeomagneticProperty:

List of all members.

Classes
class	Limits
	Contains constants for limit values of data members of class. More...
Public Member Functions
	SetGeomagneticProperty (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	SetGeomagneticProperty (const SetGeomagneticProperty &message)
	Copy constructor.
	~SetGeomagneticProperty ()
	Destructor.
bool	SetMagneticVariation (const double radians)
	Sets the magnetic variation and updates the presence vector for the message.
double	GetMagneticVariation () 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 ()
	Clears message payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
SetGeomagneticProperty &	operator= (const SetGeomagneticProperty &message)
	Sets equal to.
Protected Attributes
double	mMagneticVariation
	Magnetic Variation in Radians [-PI, PI].

---

Detailed Description

This message is used to set the location specific magnetic variation for adjusting the GPS heading.

Definition at line 55 of file setgeomagneticproperty.h.

---

Constructor & Destructor Documentation

SetGeomagneticProperty::SetGeomagneticProperty	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 58 of file setgeomagneticproperty.cpp.

SetGeomagneticProperty::SetGeomagneticProperty

(

const SetGeomagneticProperty &

message )

Copy constructor.

Definition at line 69 of file setgeomagneticproperty.cpp.

SetGeomagneticProperty::~SetGeomagneticProperty

(

)

Destructor.

Definition at line 80 of file setgeomagneticproperty.cpp.

---

Member Function Documentation

void SetGeomagneticProperty::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 155 of file setgeomagneticproperty.cpp.

virtual Message* JAUS::SetGeomagneticProperty::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file setgeomagneticproperty.h.

double JAUS::SetGeomagneticProperty::GetMagneticVariation

(

)

const [inline]

Definition at line 74 of file setgeomagneticproperty.h.

virtual UShort JAUS::SetGeomagneticProperty::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file setgeomagneticproperty.h.

virtual std::string JAUS::SetGeomagneticProperty::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file setgeomagneticproperty.h.

virtual UInt JAUS::SetGeomagneticProperty::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file setgeomagneticproperty.h.

virtual UInt JAUS::SetGeomagneticProperty::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file setgeomagneticproperty.h.

virtual UInt JAUS::SetGeomagneticProperty::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file setgeomagneticproperty.h.

virtual bool JAUS::SetGeomagneticProperty::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file setgeomagneticproperty.h.

virtual bool JAUS::SetGeomagneticProperty::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 85 of file setgeomagneticproperty.h.

SetGeomagneticProperty & SetGeomagneticProperty::operator=

(

const SetGeomagneticProperty &

message )

Sets equal to.

Definition at line 197 of file setgeomagneticproperty.cpp.

int SetGeomagneticProperty::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 139 of file setgeomagneticproperty.cpp.

int SetGeomagneticProperty::RunTestCase

(

)

const [virtual]

Runs a test case to validate the message class.

Returns:

1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 168 of file setgeomagneticproperty.cpp.

bool SetGeomagneticProperty::SetMagneticVariation

(

const double

radians )

Sets the magnetic variation and updates the presence vector for the message.

Parameters:

[in]

radians

Desired magnetic variation in meters per second [-PI, PI].

Returns:

JAUS_OK on success, otherwise false.

Definition at line 95 of file setgeomagneticproperty.cpp.

int SetGeomagneticProperty::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 117 of file setgeomagneticproperty.cpp.

---

Member Data Documentation

double JAUS::SetGeomagneticProperty::mMagneticVariation [protected]

Magnetic Variation in Radians [-PI, PI].

Definition at line 89 of file setgeomagneticproperty.h.

---

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

• jaus++/2.0/include/jaus/mobility/sensors/setgeomagneticproperty.h
• jaus++/2.0/src/jaus/mobility/sensors/setgeomagneticproperty.cpp