JAUS::Vehicle Class Reference

Describes a Vehicle Subsystem. A Vehicle has position and orientation information. More...

#include <vehicle.h>

Inheritance diagram for JAUS::Vehicle:

List of all members.

Classes
class	Info
	Abstract class for setting additional information you want to assign to a vehicle. More...
Public Types
typedef Mutex::ScopedPtr< Vehicle >	Ptr
typedef std::map< UShort, Vehicle * >	Map
Public Member Functions
	Vehicle ()
	Constructor.
	Vehicle (const Vehicle &vehicle)
	Copy constructor.
	~Vehicle ()
	Destructor.
void	Update (const Wgs &position, const Attitude &attitude, const Time &time)
	Method to set position, attitude, and time on one line.
void	Update (const Point3D &velocity, const Time &time)
	Method to set velocity info with a single line.
virtual Subsystem *	Clone () const
	Clones the data.
void	SetAdditionalInfo (const Info *info)
	Method to set additional 3rd party data into the data structure. This can be any type of data you want to add based on a derived class called Info.
void	DeleteAdditionalInfo ()
	Deletes additinal 3rd party data.
Info *	GetAdditionalInfo ()
const Info *	GetAdditionalInfo () const
Vehicle &	operator= (const Vehicle &vehicle)
	Sets equal to.
Static Public Member Functions
static void	DeleteVehicleMap (Vehicle::Map &list)
	Deletes all data in the list.
static void	CopyVehicleMap (const Vehicle::Map &src, Vehicle::Map &dest)
	Copies the data.
Public Attributes
Wgs	mPosition
	Position of Vehicle.
Attitude	mAttitude
	Attitude of Vehicle.
Point3D	mLinearVelocity
	Linear velocity of vehicles.
int	mAuthority
	Authority level needed for control of the Vehicle (-1 is not set).

---

Detailed Description

Describes a Vehicle Subsystem. A Vehicle has position and orientation information.

Within the Core library, vehicle positions and orientations are not set. They are only updated when the Discovery Service is used in conjunction with the Mobility Service Set library.

Definition at line 65 of file vehicle.h.

---

Member Typedef Documentation

typedef std::map<UShort, Vehicle *> JAUS::Vehicle::Map

Reimplemented from JAUS::Subsystem.

Definition at line 94 of file vehicle.h.

typedef Mutex::ScopedPtr<Vehicle> JAUS::Vehicle::Ptr

Reimplemented from JAUS::Subsystem.

Definition at line 93 of file vehicle.h.

---

Constructor & Destructor Documentation

Vehicle::Vehicle

(

)

Constructor.

Definition at line 50 of file vehicle.cpp.

Vehicle::Vehicle

(

const Vehicle &

vehicle )

Copy constructor.

Definition at line 57 of file vehicle.cpp.

Vehicle::~Vehicle

(

)

Destructor.

Definition at line 68 of file vehicle.cpp.

---

Member Function Documentation

Subsystem * Vehicle::Clone

(

)

const [virtual]

Clones the data.

Reimplemented from JAUS::Subsystem.

Definition at line 106 of file vehicle.cpp.

void Vehicle::CopyVehicleMap	(	const Vehicle::Map &	src,
		Vehicle::Map &	dest
	)		[static]

Copies the data.

Definition at line 217 of file vehicle.cpp.

void Vehicle::DeleteAdditionalInfo

(

)

Deletes additinal 3rd party data.

Definition at line 134 of file vehicle.cpp.

void Vehicle::DeleteVehicleMap

(

Vehicle::Map &

list )

[static]

Deletes all data in the list.

Definition at line 199 of file vehicle.cpp.

const Vehicle::Info * Vehicle::GetAdditionalInfo

(

)

const

Returns:

Pointer to custom data.

Definition at line 156 of file vehicle.cpp.

Vehicle::Info * Vehicle::GetAdditionalInfo

(

)

Returns:

Pointer to custom data.

Definition at line 148 of file vehicle.cpp.

Vehicle & Vehicle::operator=

(

const Vehicle &

vehicle )

Sets equal to.

Definition at line 164 of file vehicle.cpp.

void Vehicle::SetAdditionalInfo

(

const Info *

info )

Method to set additional 3rd party data into the data structure. This can be any type of data you want to add based on a derived class called Info.

Definition at line 116 of file vehicle.cpp.

void Vehicle::Update	(	const Wgs &	position,
		const Attitude &	attitude,
		const Time &	time
	)

Method to set position, attitude, and time on one line.

Definition at line 78 of file vehicle.cpp.

void Vehicle::Update	(	const Point3D &	velocity,
		const Time &	time
	)

Method to set velocity info with a single line.

Definition at line 93 of file vehicle.cpp.

---

Member Data Documentation

Attitude JAUS::Vehicle::mAttitude

Attitude of Vehicle.

Definition at line 112 of file vehicle.h.

int JAUS::Vehicle::mAuthority

Authority level needed for control of the Vehicle (-1 is not set).

Definition at line 114 of file vehicle.h.

Point3D JAUS::Vehicle::mLinearVelocity

Linear velocity of vehicles.

Definition at line 113 of file vehicle.h.

Wgs JAUS::Vehicle::mPosition

Position of Vehicle.

Definition at line 111 of file vehicle.h.

---

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

• jaus++/2.0/include/jaus/core/discovery/vehicle.h
• jaus++/2.0/src/jaus/core/discovery/vehicle.cpp