DFLib  Release 1.0.0
Public Member Functions | Private Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for DFLib::XY::Report:
Collaboration graph
[legend]

Public Member Functions

 Report (const std::vector< double > &theLocation, const double &bearing, const double &std_dev, const std::string &theName)
 XYDF report constructor. More...
 
 ~Report ()
 virtual destructor because base classes need one More...
 
virtual const std::vector< double > & getReceiverLocation ()
 return receiver location in double vector of XY coords More...
 
virtual double getReportBearingRadians () const
 return reported bearing to target More...
 
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 More...
 
virtual void setSigma (double Sigma)
 set standard deviation in degrees More...
 
- Public Member Functions inherited from DFLib::Abstract::Report
 Report (std::string n, bool v)
 constructor for base Report class More...
 
 Report (const Report &right)
 copy constructor for base Report class More...
 
virtual const std::string & getReportName () const
 Return the name of this report. More...
 
virtual void setReportName (const std::string &theName)
 set the name of this report More...
 
virtual void setValid ()
 Set this report as valid. More...
 
virtual void setInvalid ()
 Set this report as invalid. More...
 
virtual void toggleValidity ()
 
virtual bool isValid () const
 check this report's validity More...
 
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 More...
 
double computeBearingToPoint (std::vector< double > &aPoint)
 compute bearing from this reporting location to some other point More...
 
double computeDistanceToPoint (std::vector< double > &aPoint)
 compute distance from this reporting location to some other point. More...
 

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

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
theLocationposition vector of this report.
Bearingbearing IN DEGREES
std_devstandard deviation in degrees
DFLib::XY::Report::~Report ( )
inlinevirtual

virtual destructor because base classes need one

Reimplemented from DFLib::Abstract::Report.

Member Function Documentation

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

Implements DFLib::Abstract::Report.

Here is the caller graph for this function:

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

return receiver location in double vector of XY coords

Implements DFLib::Abstract::Report.

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 $0<\theta<2\pi$.

Returns
bearing in radians, always in the range $0<\theta<2\pi$.

Implements DFLib::Abstract::Report.

Here is the caller graph for this function:

double DFLib::XY::Report::getSigma ( ) const
inlinevirtual
void DFLib::XY::Report::setBearing ( double  Bearing)
inlinevirtual

set bearing in degrees

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

set standard deviation in degrees

Member Data Documentation

double DFLib::XY::Report::bearing
private
Point DFLib::XY::Report::receiverLocation
private
double DFLib::XY::Report::sigma
private

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