From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_radio_message.html | 1036 +++++++++++++++++++++++++++++ 1 file changed, 1036 insertions(+) create mode 100644 Doc/doxygen/html/class_radio_message.html (limited to 'Doc/doxygen/html/class_radio_message.html') diff --git a/Doc/doxygen/html/class_radio_message.html b/Doc/doxygen/html/class_radio_message.html new file mode 100644 index 0000000..faaebe0 --- /dev/null +++ b/Doc/doxygen/html/class_radio_message.html @@ -0,0 +1,1036 @@ + + + + + +Starshatter_Open: RadioMessage Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
RadioMessage Class Reference
+
+
+ +

#include <RadioMessage.h>

+ +

List of all members.

+ + + +

+Public Types

enum  ACTION {
+  NONE = 0, +DOCK_WITH = Instruction::DOCK, +RTB = Instruction::RTB, +QUANTUM_TO = Instruction::NUM_ACTIONS, +
+  FARCAST_TO, +ACK, +NACK, +ATTACK, +
+  ESCORT, +BRACKET, +IDENTIFY, +COVER_ME, +
+  WEP_FREE, +WEP_HOLD, +FORM_UP, +SAY_POSITION, +
+  LAUNCH_PROBE, +GO_EMCON1, +GO_EMCON2, +GO_EMCON3, +
+  GO_DIAMOND, +GO_SPREAD, +GO_BOX, +GO_TRAIL, +
+  MOVE_PATROL, +SKIP_NAVPOINT, +RESUME_MISSION, +CALL_ENGAGING, +
+  FOX_1, +FOX_2, +FOX_3, +SPLASH_1, +
+  SPLASH_2, +SPLASH_3, +SPLASH_4, +SPLASH_5, +
+  SPLASH_6, +SPLASH_7, +DISTRESS, +BREAK_ORBIT, +
+  MAKE_ORBIT, +QUANTUM_JUMP, +WARN_ACCIDENT, +WARN_TARGETED, +
+  DECLARE_ROGUE, +PICTURE, +REQUEST_PICTURE, +REQUEST_SUPPORT, +
+  CALL_INBOUND, +CALL_APPROACH, +CALL_CLEARANCE, +CALL_FINALS, +
+  CALL_WAVE_OFF, +NUM_ACTIONS +
+ }
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 RadioMessage (Ship *dst, const Ship *sender, int action)
 RadioMessage (Element *dst, const Ship *sender, int action)
 RadioMessage (const RadioMessage &rm)
virtual ~RadioMessage ()
const Ship * Sender () const
Ship * DestinationShip () const
Element * DestinationElem () const
int Action () const
List< SimObject > & TargetList ()
const Point & Location () const
const Text & Info () const
int Channel () const
void SetDestinationShip (Ship *s)
void SetDestinationElem (Element *e)
void AddTarget (SimObject *s)
void SetLocation (const Point &l)
void SetInfo (Text msg)
void SetChannel (int c)
+ + +

+Static Public Member Functions

static const char * ActionName (int a)
+ + + + + + + + + +

+Protected Attributes

const Ship * sender
Ship * dst_ship
Element * dst_elem
int action
List< SimObject > target_list
Point location
Text info
int channel
+

Detailed Description

+
+

Definition at line 33 of file RadioMessage.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum RadioMessage::ACTION
+
+
Enumerator:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NONE  +
DOCK_WITH  +
RTB  +
QUANTUM_TO  +
FARCAST_TO  +
ACK  +
NACK  +
ATTACK  +
ESCORT  +
BRACKET  +
IDENTIFY  +
COVER_ME  +
WEP_FREE  +
WEP_HOLD  +
FORM_UP  +
SAY_POSITION  +
LAUNCH_PROBE  +
GO_EMCON1  +
GO_EMCON2  +
GO_EMCON3  +
GO_DIAMOND  +
GO_SPREAD  +
GO_BOX  +
GO_TRAIL  +
MOVE_PATROL  +
SKIP_NAVPOINT  +
RESUME_MISSION  +
CALL_ENGAGING  +
FOX_1  +
FOX_2  +
FOX_3  +
SPLASH_1  +
SPLASH_2  +
SPLASH_3  +
SPLASH_4  +
SPLASH_5  +
SPLASH_6  +
SPLASH_7  +
DISTRESS  +
BREAK_ORBIT  +
MAKE_ORBIT  +
QUANTUM_JUMP  +
WARN_ACCIDENT  +
WARN_TARGETED  +
DECLARE_ROGUE  +
PICTURE  +
REQUEST_PICTURE  +
REQUEST_SUPPORT  +
CALL_INBOUND  +
CALL_APPROACH  +
CALL_CLEARANCE  +
CALL_FINALS  +
CALL_WAVE_OFF  +
NUM_ACTIONS  +
+
+
+ +

Definition at line 36 of file RadioMessage.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
RadioMessage::RadioMessage (Ship * dst,
const Ship * sender,
int action 
)
+
+ +

Definition at line 22 of file RadioMessage.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
RadioMessage::RadioMessage (Element * dst,
const Ship * sender,
int action 
)
+
+ +

Definition at line 29 of file RadioMessage.cpp.

+ +
+
+ +
+
+ + + + + + + + +
RadioMessage::RadioMessage (const RadioMessage & rm)
+
+ +

Definition at line 36 of file RadioMessage.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
RadioMessage::~RadioMessage ()
+ 		+virtual
+
+ +

Definition at line 49 of file RadioMessage.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
int RadioMessage::Action () const
+ 		+inline
+
+ +

Definition at line 127 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * RadioMessage::ActionName (int a)
+ 		+static
+
+ +

Definition at line 55 of file RadioMessage.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void RadioMessage::AddTarget (SimObject * s)
+
+ +

Definition at line 157 of file RadioMessage.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int RadioMessage::Channel () const
+ 		+inline
+
+ +

Definition at line 131 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Element* RadioMessage::DestinationElem () const
+ 		+inline
+
+ +

Definition at line 126 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Ship* RadioMessage::DestinationShip () const
+ 		+inline
+
+ +

Definition at line 125 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Text& RadioMessage::Info () const
+ 		+inline
+
+ +

Definition at line 130 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Point& RadioMessage::Location () const
+ 		+inline
+
+ +

Definition at line 129 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Ship* RadioMessage::Sender () const
+ 		+inline
+
+ +

Definition at line 124 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void RadioMessage::SetChannel (int c)
+ 		+inline
+
+ +

Definition at line 139 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void RadioMessage::SetDestinationElem (Element * e)
+ 		+inline
+
+ +

Definition at line 135 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void RadioMessage::SetDestinationShip (Ship * s)
+ 		+inline
+
+ +

Definition at line 134 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void RadioMessage::SetInfo (Text msg)
+ 		+inline
+
+ +

Definition at line 138 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void RadioMessage::SetLocation (const Point & l)
+ 		+inline
+
+ +

Definition at line 137 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<SimObject>& RadioMessage::TargetList ()
+ 		+inline
+
+ +

Definition at line 128 of file RadioMessage.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
int RadioMessage::action
+ 		+protected
+
+ +

Definition at line 145 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int RadioMessage::channel
+ 		+protected
+
+ +

Definition at line 149 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Element* RadioMessage::dst_elem
+ 		+protected
+
+ +

Definition at line 144 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Ship* RadioMessage::dst_ship
+ 		+protected
+
+ +

Definition at line 143 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text RadioMessage::info
+ 		+protected
+
+ +

Definition at line 148 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point RadioMessage::location
+ 		+protected
+
+ +

Definition at line 147 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
const Ship* RadioMessage::sender
+ 		+protected
+
+ +

Definition at line 142 of file RadioMessage.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<SimObject> RadioMessage::target_list
+ 		+protected
+
+ +

Definition at line 146 of file RadioMessage.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1