DFLib::Abstract::Report Class Reference

Abstract interface for DFReport. This is the base class for DF report classes.
More...

#include <DF_Abstract_Report.hpp>

Inheritance diagram for DFLib::Abstract::Report:

Collaboration diagram for DFLib::Abstract::Report:

Public Member Functions
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
std::string	ReportName_
bool	validReport_

Detailed Description

Abstract interface for DFReport. This is the base class for DF report classes.

Constructor & Destructor Documentation

~Report()

virtual DFLib::Abstract::Report::~Report ( )

inlinevirtual

virtual destructor because base classes need one

Reimplemented in DFLib::LatLon::Report, DFLib::Proj::Report, and DFLib::XY::Report.

Report() [1/2]

DFLib::Abstract::Report::Report	(	std::string	n,
		bool	v
	)

constructor for base Report class

This cannot be used to create an abstract report, because this is an abstract class.

Report() [2/2]

DFLib::Abstract::Report::Report

(

const Report &

right

)

copy constructor for base Report class

This cannot be used to create an abstract report, because this is an abstract class.

Member Function Documentation

computeBearingToPoint()

double DFLib::Abstract::Report::computeBearingToPoint

(

std::vector< double > &

aPoint

)

compute bearing from this reporting location to some other point

Parameters

aPoint

point to which bearing requested.

Returns

bearing in radians, in range

The base class computes the bearing in X-Y coordinates by taking the arctangent of "rise over run." This is certainly the appropriate thing to do when the X-Y coordinate system is a conformal projection. When working with non-conformal projections the computation could possibly be more involved.

Here is the caller graph for this function:

computeDistanceToPoint()

double DFLib::Abstract::Report::computeDistanceToPoint

(

std::vector< double > &

aPoint

)

compute distance from this reporting location to some other point.

Parameters

aPoint

point to which distance is requested

Returns

distance

The distance returned is the Cartesian distance in X-Y coordinates, . It is not the geodesic distance on the ellipsoid.

computeFixCut()

void DFLib::Abstract::Report::computeFixCut	(	DFLib::Abstract::Report *	Report2,
		Point &	returnPoint,
		double &	cutAngle,
		FixStatus &	fs
	)

compute point at which the line from this report intersects that from another

Parameters

Report2	pointer to the other report
returnPoint	reference to place to store solution point
cutAngle	on return, the angle in radians made by the two bearing lines
fs	fix status

Here is the call graph for this function:

getBearingStandardDeviationRadians()

virtual double DFLib::Abstract::Report::getBearingStandardDeviationRadians ( ) const

pure virtual

Implemented in DFLib::LatLon::Report, DFLib::Proj::Report, and DFLib::XY::Report.

Here is the caller graph for this function:

getReceiverLocation()

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

pure virtual

return receiver location in double vector of XY coords

Implemented in DFLib::LatLon::Report, DFLib::Proj::Report, and DFLib::XY::Report.

Here is the caller graph for this function:

getReportBearingRadians()

virtual double DFLib::Abstract::Report::getReportBearingRadians ( ) const

pure virtual

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 .

Implemented in DFLib::LatLon::Report, DFLib::Proj::Report, and DFLib::XY::Report.

Here is the caller graph for this function:

getReportName()

virtual const std::string & DFLib::Abstract::Report::getReportName ( ) const

inlinevirtual

Return the name of this report.

Here is the caller graph for this function:

isValid()

virtual bool DFLib::Abstract::Report::isValid ( ) const

inlinevirtual

check this report's validity

Here is the caller graph for this function:

setInvalid()

virtual void DFLib::Abstract::Report::setInvalid ( )

inlinevirtual

Set this report as invalid.

Here is the caller graph for this function:

setReportName()

virtual void DFLib::Abstract::Report::setReportName ( const std::string &  theName )

inlinevirtual

set the name of this report

Here is the caller graph for this function:

setValid()

virtual void DFLib::Abstract::Report::setValid ( )

inlinevirtual

Set this report as valid.

Here is the caller graph for this function:

toggleValidity()

virtual void DFLib::Abstract::Report::toggleValidity ( )

inlinevirtual

Member Data Documentation

ReportName_

std::string DFLib::Abstract::Report::ReportName_

private

validReport_

bool DFLib::Abstract::Report::validReport_

private

---

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

• /users/russo/DFLIB_Git/DFLib/DF_Abstract_Report.hpp
• /users/russo/DFLIB_Git/DFLib/DF_Abstract_Report.cpp