PlugIn_AIS_Target Class Reference

AIS target information accessible to plugins. More...

#include <ocpn_plugin.h>

Public Attributes
int	MMSI
	Maritime Mobile Service Identity number.
int	Class
	AIS class (Class A: 0, Class B: 1)
int	NavStatus
	Navigational status (0-15 as per ITU-R M.1371)
double	SOG
	Speed over ground in knots.
double	COG
	Course over ground in degrees.
double	HDG
	Heading in degrees true.
double	Lon
	Longitude in decimal degrees.
double	Lat
	Latitude in decimal degrees.
int	ROTAIS
	Rate of turn as indicated in AIS message.
char	CallSign [8]
	Call sign, includes NULL terminator.
char	ShipName [21]
	Ship name, includes NULL terminator.
unsigned char	ShipType
	Ship type as per ITU-R M.1371.
int	IMO
	IMO ship identification number.
double	Range_NM
	Range to target in nautical miles.
double	Brg
	Bearing to target in degrees true.
bool	bCPA_Valid
	True if CPA calculation is valid.
double	TCPA
	Time to Closest Point of Approach in minutes.
double	CPA
	Closest Point of Approach in nautical miles.
plugin_ais_alarm_type	alarm_state
	Current alarm state for this target.

Detailed Description

AIS target information accessible to plugins.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 386 of file ocpn_plugin.h.

Member Data Documentation

alarm_state

plugin_ais_alarm_type PlugIn_AIS_Target::alarm_state

Current alarm state for this target.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 410 of file ocpn_plugin.h.

bCPA_Valid

bool PlugIn_AIS_Target::bCPA_Valid

True if CPA calculation is valid.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 406 of file ocpn_plugin.h.

Brg

double PlugIn_AIS_Target::Brg

Bearing to target in degrees true.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 403 of file ocpn_plugin.h.

CallSign

char PlugIn_AIS_Target::CallSign[8]

Call sign, includes NULL terminator.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 397 of file ocpn_plugin.h.

Class

int PlugIn_AIS_Target::Class

AIS class (Class A: 0, Class B: 1)

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 389 of file ocpn_plugin.h.

COG

double PlugIn_AIS_Target::COG

Course over ground in degrees.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 392 of file ocpn_plugin.h.

CPA

double PlugIn_AIS_Target::CPA

Closest Point of Approach in nautical miles.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 408 of file ocpn_plugin.h.

HDG

double PlugIn_AIS_Target::HDG

Heading in degrees true.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 393 of file ocpn_plugin.h.

IMO

int PlugIn_AIS_Target::IMO

IMO ship identification number.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 400 of file ocpn_plugin.h.

Lat

double PlugIn_AIS_Target::Lat

Latitude in decimal degrees.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 395 of file ocpn_plugin.h.

Lon

double PlugIn_AIS_Target::Lon

Longitude in decimal degrees.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 394 of file ocpn_plugin.h.

MMSI

int PlugIn_AIS_Target::MMSI

Maritime Mobile Service Identity number.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 388 of file ocpn_plugin.h.

NavStatus

int PlugIn_AIS_Target::NavStatus

Navigational status (0-15 as per ITU-R M.1371)

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 390 of file ocpn_plugin.h.

Range_NM

double PlugIn_AIS_Target::Range_NM

Range to target in nautical miles.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 402 of file ocpn_plugin.h.

ROTAIS

int PlugIn_AIS_Target::ROTAIS

Rate of turn as indicated in AIS message.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 396 of file ocpn_plugin.h.

ShipName

char PlugIn_AIS_Target::ShipName[21]

Ship name, includes NULL terminator.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 398 of file ocpn_plugin.h.

ShipType

unsigned char PlugIn_AIS_Target::ShipType

Ship type as per ITU-R M.1371.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 399 of file ocpn_plugin.h.

SOG

double PlugIn_AIS_Target::SOG

Speed over ground in knots.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 391 of file ocpn_plugin.h.

TCPA

double PlugIn_AIS_Target::TCPA

Time to Closest Point of Approach in minutes.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 407 of file ocpn_plugin.h.

---

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

• /home/runner/work/main/main/opencpn/include/ocpn_plugin.h