DFLib::XY::Report Class Reference

DF report in XY coordinates This class is meant for simplistic DF codes that work in X/Y coordinates already. Mostly intended for testing the interface. More...

#include <DF_XY_Report.hpp>

Inheritance diagram for DFLib::XY::Report:

Collaboration diagram for DFLib::XY::Report:

Public Member Functions
	Report (const std::vector< double > &theLocation, const double &bearing, const double &std_dev, const std::string &theName)
	XYDF report constructor.
	~Report ()
	virtual destructor because base classes need one
virtual const std::vector< double > &	getReceiverLocation ()
	return receiver location in double vector of XY coords
virtual double	getReportBearingRadians () const
	return reported bearing to target
virtual double	getBearing () const
virtual double	getBearingStandardDeviationRadians () const
virtual double	getSigma () const
virtual void	setReceiverLocation (std::vector< double > &theLocation)
virtual void	setBearing (double Bearing)
	set bearing in degrees
virtual void	setSigma (double Sigma)
	set standard deviation in degrees
Public Member Functions inherited from DFLib::Abstract::Report
virtual	~Report ()
	virtual destructor because base classes need one
	Report (std::string n, bool v)
	constructor for base Report class
	Report (const Report &right)
	copy constructor for base Report class
virtual const std::vector< double > &	getReceiverLocation ()=0
	return receiver location in double vector of XY coords
virtual double	getReportBearingRadians () const =0
	return reported bearing to target
virtual double	getBearingStandardDeviationRadians () const =0
virtual const std::string &	getReportName () const
	Return the name of this report.
virtual void	setReportName (const std::string &theName)
	set the name of this report
virtual void	setValid ()
	Set this report as valid.
virtual void	setInvalid ()
	Set this report as invalid.
virtual void	toggleValidity ()
virtual bool	isValid () const
	check this report's validity
void	computeFixCut (DFLib::Abstract::Report *Report2, Point &returnPoint, double &cutAngle, FixStatus &fs)
	compute point at which the line from this report intersects that from another
double	computeBearingToPoint (std::vector< double > &aPoint)
	compute bearing from this reporting location to some other point
double	computeDistanceToPoint (std::vector< double > &aPoint)
	compute distance from this reporting location to some other point.

Private Attributes
Point	receiverLocation
double	bearing
double	sigma

Detailed Description

DF report in XY coordinates This class is meant for simplistic DF codes that work in X/Y coordinates already. Mostly intended for testing the interface.

Constructor & Destructor Documentation

Report()

DFLib::XY::Report::Report ( const std::vector< double > &  theLocation, const double &  Bearing, const double &  std_dev, const std::string &  theName  )

inline

XYDF report constructor.

Parameters

theLocation	position vector of this report.
Bearing	bearing IN DEGREES
std_dev	standard deviation in degrees

~Report()

DFLib::XY::Report::~Report ( )

inlinevirtual

virtual destructor because base classes need one

Reimplemented from DFLib::Abstract::Report.

Member Function Documentation

getBearing()

double DFLib::XY::Report::getBearing ( ) const

inlinevirtual

getBearingStandardDeviationRadians()

double DFLib::XY::Report::getBearingStandardDeviationRadians ( ) const

inlinevirtual

Implements DFLib::Abstract::Report.

Here is the caller graph for this function:

getReceiverLocation()

const std::vector< double > & DFLib::XY::Report::getReceiverLocation ( )

inlinevirtual

return receiver location in double vector of XY coords

Implements DFLib::Abstract::Report.

getReportBearingRadians()

double DFLib::XY::Report::getReportBearingRadians ( ) const

inlinevirtual

return reported bearing to target

It is essential that getReportBearingRadians always return the bearing in the correct range .

Returns

bearing in radians, always in the range .

Implements DFLib::Abstract::Report.

Here is the caller graph for this function:

getSigma()

double DFLib::XY::Report::getSigma ( ) const

inlinevirtual

setBearing()

void DFLib::XY::Report::setBearing ( double  Bearing )

inlinevirtual

set bearing in degrees

setReceiverLocation()

void DFLib::XY::Report::setReceiverLocation ( std::vector< double > &  theLocation )

inlinevirtual

setSigma()

void DFLib::XY::Report::setSigma ( double  Sigma )

inlinevirtual

set standard deviation in degrees

Member Data Documentation

bearing

double DFLib::XY::Report::bearing

private

receiverLocation

Point DFLib::XY::Report::receiverLocation

private

sigma

double DFLib::XY::Report::sigma

private

---

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

• /users/russo/DFLIB_Git/DFLib/DF_XY_Report.hpp