Public Member Functions

JAUS::SetGlobalWaypoint Class Reference

This message is used to set waypoint data based on the global coordinate system. A global waypoint can have up to six fields to describe it completely. The waypoint is defined in the global coordinate system using the latitude, longitude, and altitude fields. The desired orientation of the platform at the waypoint is defined using the roll, pitch, and yaw fields. Only fields 1-3 (presence vector, latitude, and longitude are required for each waypoint. Field #4 sets the desired Altitude in accordance with the WGS 84 standard. The presence vector is used to specify if the remaining fields, i.e., altitude, roll, pitch, and yaw, are used to further describe orientation at that point. More...

#include <setglobalwaypoint.h>

Inheritance diagram for JAUS::SetGlobalWaypoint:
JAUS::Message JAUS::GlobalWaypoint JAUS::Waypoint

List of all members.

Public Member Functions

 SetGlobalWaypoint (const Address &dest=Address(), const Address &src=Address())
 Constructor, initializes default values.
 SetGlobalWaypoint (const SetGlobalWaypoint &message)
 Copy constructor.
 ~SetGlobalWaypoint ()
 Destructor.
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 MessageClone () 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 void PrintMessageBody () const
 Prints data to console.
virtual bool IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int RunTestCase () const
 Runs a test case to validate the message class.
SetGlobalWaypointoperator= (const SetGlobalWaypoint &message)
 Sets equal to.
SetGlobalWaypointoperator= (const GlobalWaypoint &waypoint)
 Sets equal to.

Detailed Description

This message is used to set waypoint data based on the global coordinate system. A global waypoint can have up to six fields to describe it completely. The waypoint is defined in the global coordinate system using the latitude, longitude, and altitude fields. The desired orientation of the platform at the waypoint is defined using the roll, pitch, and yaw fields. Only fields 1-3 (presence vector, latitude, and longitude are required for each waypoint. Field #4 sets the desired Altitude in accordance with the WGS 84 standard. The presence vector is used to specify if the remaining fields, i.e., altitude, roll, pitch, and yaw, are used to further describe orientation at that point.

Definition at line 66 of file setglobalwaypoint.h.


Constructor & Destructor Documentation

SetGlobalWaypoint::SetGlobalWaypoint ( const Address dest = Address(),
const Address src = Address() 
)

Constructor, initializes default values.

Parameters:
[in]srcSource ID of message sender.
[in]destDestination ID of message.

Definition at line 57 of file setglobalwaypoint.cpp.

SetGlobalWaypoint::SetGlobalWaypoint ( const SetGlobalWaypoint message )

Copy constructor.

Definition at line 76 of file setglobalwaypoint.cpp.

SetGlobalWaypoint::~SetGlobalWaypoint (  )

Destructor.

Definition at line 87 of file setglobalwaypoint.cpp.


Member Function Documentation

void SetGlobalWaypoint::ClearMessageBody (  ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 215 of file setglobalwaypoint.cpp.

virtual Message* JAUS::SetGlobalWaypoint::Clone (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file setglobalwaypoint.h.

virtual UShort JAUS::SetGlobalWaypoint::GetMessageCodeOfResponse (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file setglobalwaypoint.h.

virtual std::string JAUS::SetGlobalWaypoint::GetMessageName (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file setglobalwaypoint.h.

virtual UInt JAUS::SetGlobalWaypoint::GetPresenceVector (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file setglobalwaypoint.h.

virtual UInt JAUS::SetGlobalWaypoint::GetPresenceVectorMask (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file setglobalwaypoint.h.

virtual UInt JAUS::SetGlobalWaypoint::GetPresenceVectorSize (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file setglobalwaypoint.h.

virtual bool JAUS::SetGlobalWaypoint::IsCommand (  ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file setglobalwaypoint.h.

virtual bool JAUS::SetGlobalWaypoint::IsLargeDataSet ( const unsigned int  maxPayloadSize = 1437 ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 83 of file setglobalwaypoint.h.

SetGlobalWaypoint & SetGlobalWaypoint::operator= ( const SetGlobalWaypoint message )

Sets equal to.

Reimplemented from JAUS::GlobalWaypoint.

Definition at line 288 of file setglobalwaypoint.cpp.

SetGlobalWaypoint & SetGlobalWaypoint::operator= ( const GlobalWaypoint waypoint )

Sets equal to.

Reimplemented from JAUS::GlobalWaypoint.

Definition at line 313 of file setglobalwaypoint.cpp.

void SetGlobalWaypoint::PrintMessageBody (  ) const [virtual]

Prints data to console.

Reimplemented from JAUS::Message.

Definition at line 234 of file setglobalwaypoint.cpp.

int SetGlobalWaypoint::ReadMessageBody ( const Packet packet ) [virtual]

Reads message payload from the packet.

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

Parameters:
[in]packetPacket containing message payload data to read.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 162 of file setglobalwaypoint.cpp.

int SetGlobalWaypoint::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 259 of file setglobalwaypoint.cpp.

int SetGlobalWaypoint::WriteMessageBody ( Packet packet ) const [virtual]

Writes message payload to the packet.

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

Parameters:
[out]packetPacket to write payload to.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 103 of file setglobalwaypoint.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines