XPMP2
X-Plane multiplayer library 2 - using instancing
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
XPMP2::RemoteAcDetailTy Struct Reference

A/C details, packed into an array message. More...

#include <XPMPRemote.h>

Public Member Functions

 RemoteAcDetailTy ()
 Default Constructor sets all to zero. More...
 
 RemoteAcDetailTy (const Aircraft &_ac, double _lat, double _lon, float _alt_ft, std::uint16_t _dTime)
 A/c copy constructor fills from passed-in XPMP2::Aircraft object. More...
 
void CopyFrom (const Aircraft &_ac, double _lat, double _lon, float _alt_ft, std::uint16_t _dTime)
 Copies values from passed-in XPMP2::Aircraft object. More...
 
void SetLabelCol (const float _col[4])
 set the label color from a float array (4th number, alpha, is always considered 1.0) More...
 
void GetLabelCol (float _col[4]) const
 writes color out into a float array More...
 
void SetPitch (float _p)
 sets pitch from float More...
 
float GetPitch () const
 returns float pitch More...
 
void SetHeading (float _h)
 Sets heading from float. More...
 
float GetHeading () const
 returns float heading More...
 
void SetRoll (float _r)
 sets pitch from float More...
 
float GetRoll () const
 returns float pitch More...
 

Static Public Member Functions

static constexpr size_t msgSize ()
 message size More...
 

Public Attributes

std::uint32_t modeS_id
 plane's unique id at the sender side (might differ remotely in case of duplicates) More...
 
char icaoType [4]
 icao a/c type More...
 
char icaoOp [4]
 icao airline code More...
 
char sShortId [20]
 CSL model's short id. More...
 
std::uint16_t pkgHash
 hash value of package name More...
 
char label [23]
 label More...
 
std::uint8_t labelCol [3]
 label color (RGB) More...
 
float alt_ft
 [ft] current altitude More...
 
double lat
 latitude More...
 
double lon
 longitude More...
 
std::int16_t pitch
 [0.01°] pitch/100 More...
 
std::uint16_t heading
 [0.01°] heading/100 More...
 
std::int16_t roll
 [0.01°] roll/100 More...
 
std::int16_t aiPrio
 priority for display in limited TCAS target slots, -1 indicates "no TCAS display" More...
 
std::uint16_t dTime
 [0.0001s] time difference to previous position in 1/10000s More...
 
bool bValid: 1
 is this object valid? (Will be reset in case of exceptions) More...
 
bool bVisible: 1
 Shall this plane be drawn at the moment? More...
 
bool bRender: 1
 Shall the CSL model be drawn in 3D world? More...
 
bool bDrawLabel: 1
 Draw the label of the aircraft? (new with v2) More...
 
bool bOnGrnd: 1
 Is the aircraft on the ground? More...
 
std::uint8_t contrailNum: 3
 number of contrails requested More...
 
char tailNum [10]
 registration, tail number More...
 
char manufacturer [40]
 a/c manufacturer, human readable More...
 
char model [40]
 a/c model, human readable More...
 
char airline [40]
 airline, human readable More...
 
char flightNum [10]
 flight number More...
 
char aptFrom [5]
 Origin airport (ICAO) More...
 
char aptTo [5]
 Destination airport (ICAO) More...
 
std::uint8_t contrailDist_m
 distance between several contrails and to the aircraft's centerline, in meter More...
 
std::uint8_t contrailLifeTime
 this aircraft's contrail's life time More...
 
std::uint8_t filler [3]
 yet unused More...
 
std::uint8_t v [XPMP2::V_COUNT]
 

Detailed Description

A/C details, packed into an array message.

Constructor & Destructor Documentation

◆ RemoteAcDetailTy() [1/2]

XPMP2::RemoteAcDetailTy::RemoteAcDetailTy ( )

Default Constructor sets all to zero.

◆ RemoteAcDetailTy() [2/2]

XPMP2::RemoteAcDetailTy::RemoteAcDetailTy ( const Aircraft _ac,
double  _lat,
double  _lon,
float  _alt_ft,
std::uint16_t  _dTime 
)

A/c copy constructor fills from passed-in XPMP2::Aircraft object.

Member Function Documentation

◆ CopyFrom()

void XPMP2::RemoteAcDetailTy::CopyFrom ( const Aircraft _ac,
double  _lat,
double  _lon,
float  _alt_ft,
std::uint16_t  _dTime 
)

Copies values from passed-in XPMP2::Aircraft object.

◆ GetHeading()

float XPMP2::RemoteAcDetailTy::GetHeading ( ) const
inline

returns float heading

◆ GetLabelCol()

void XPMP2::RemoteAcDetailTy::GetLabelCol ( float  _col[4]) const

writes color out into a float array

◆ GetPitch()

float XPMP2::RemoteAcDetailTy::GetPitch ( ) const
inline

returns float pitch

◆ GetRoll()

float XPMP2::RemoteAcDetailTy::GetRoll ( ) const
inline

returns float pitch

◆ msgSize()

static constexpr size_t XPMP2::RemoteAcDetailTy::msgSize ( )
inlinestaticconstexpr

message size

◆ SetHeading()

void XPMP2::RemoteAcDetailTy::SetHeading ( float  _h)

Sets heading from float.

Note
Only works well for 0 <= _h < 360

◆ SetLabelCol()

void XPMP2::RemoteAcDetailTy::SetLabelCol ( const float  _col[4])

set the label color from a float array (4th number, alpha, is always considered 1.0)

◆ SetPitch()

void XPMP2::RemoteAcDetailTy::SetPitch ( float  _p)
inline

sets pitch from float

◆ SetRoll()

void XPMP2::RemoteAcDetailTy::SetRoll ( float  _r)
inline

sets pitch from float

Member Data Documentation

◆ aiPrio

std::int16_t XPMP2::RemoteAcDetailTy::aiPrio

priority for display in limited TCAS target slots, -1 indicates "no TCAS display"

◆ airline

char XPMP2::RemoteAcDetailTy::airline[40]

airline, human readable

◆ alt_ft

float XPMP2::RemoteAcDetailTy::alt_ft

[ft] current altitude

◆ aptFrom

char XPMP2::RemoteAcDetailTy::aptFrom[5]

Origin airport (ICAO)

◆ aptTo

char XPMP2::RemoteAcDetailTy::aptTo[5]

Destination airport (ICAO)

◆ bDrawLabel

bool XPMP2::RemoteAcDetailTy::bDrawLabel

Draw the label of the aircraft? (new with v2)

◆ bOnGrnd

bool XPMP2::RemoteAcDetailTy::bOnGrnd

Is the aircraft on the ground?

◆ bRender

bool XPMP2::RemoteAcDetailTy::bRender

Shall the CSL model be drawn in 3D world?

◆ bValid

bool XPMP2::RemoteAcDetailTy::bValid

is this object valid? (Will be reset in case of exceptions)

◆ bVisible

bool XPMP2::RemoteAcDetailTy::bVisible

Shall this plane be drawn at the moment?

◆ contrailDist_m

std::uint8_t XPMP2::RemoteAcDetailTy::contrailDist_m

distance between several contrails and to the aircraft's centerline, in meter

◆ contrailLifeTime

std::uint8_t XPMP2::RemoteAcDetailTy::contrailLifeTime

this aircraft's contrail's life time

◆ contrailNum

std::uint8_t XPMP2::RemoteAcDetailTy::contrailNum

number of contrails requested

◆ dTime

std::uint16_t XPMP2::RemoteAcDetailTy::dTime

[0.0001s] time difference to previous position in 1/10000s

◆ filler

std::uint8_t XPMP2::RemoteAcDetailTy::filler[3]

yet unused

Array of packed dataRef values for CSL model animation

◆ flightNum

char XPMP2::RemoteAcDetailTy::flightNum[10]

flight number

◆ heading

std::uint16_t XPMP2::RemoteAcDetailTy::heading

[0.01°] heading/100

◆ icaoOp

char XPMP2::RemoteAcDetailTy::icaoOp[4]

icao airline code

◆ icaoType

char XPMP2::RemoteAcDetailTy::icaoType[4]

icao a/c type

◆ label

char XPMP2::RemoteAcDetailTy::label[23]

label

◆ labelCol

std::uint8_t XPMP2::RemoteAcDetailTy::labelCol[3]

label color (RGB)

◆ lat

double XPMP2::RemoteAcDetailTy::lat

latitude

◆ lon

double XPMP2::RemoteAcDetailTy::lon

longitude

◆ manufacturer

char XPMP2::RemoteAcDetailTy::manufacturer[40]

a/c manufacturer, human readable

◆ model

char XPMP2::RemoteAcDetailTy::model[40]

a/c model, human readable

◆ modeS_id

std::uint32_t XPMP2::RemoteAcDetailTy::modeS_id

plane's unique id at the sender side (might differ remotely in case of duplicates)

◆ pitch

std::int16_t XPMP2::RemoteAcDetailTy::pitch

[0.01°] pitch/100

◆ pkgHash

std::uint16_t XPMP2::RemoteAcDetailTy::pkgHash

hash value of package name

◆ roll

std::int16_t XPMP2::RemoteAcDetailTy::roll

[0.01°] roll/100

◆ sShortId

char XPMP2::RemoteAcDetailTy::sShortId[20]

CSL model's short id.

◆ tailNum

char XPMP2::RemoteAcDetailTy::tailNum[10]

registration, tail number

◆ v

std::uint8_t XPMP2::RemoteAcDetailTy::v[XPMP2::V_COUNT]

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