larcfm::GeneralPlan Class Reference

#include <GeneralPlan.h>

Inheritance diagram for larcfm::GeneralPlan:

Public Member Functions
	GeneralPlan (const Plan &p)
	GeneralPlan (const PolyPath &p)
	GeneralPlan (const PolyPath &p, bool cont)
	GeneralPlan (const GeneralPlan &g)
GeneralState	state (double time)
double	getFirstTime () const
double	getLastTime () const
int	size () const
std::string	getID () const
bool	isLatLon () const
bool	hasPlan () const
bool	hasPolyPath () const
Plan	getPlan () const
PolyPath	getPolyPath () const
bool	isContainment () const
bool	isInvalid () const
GeneralState	point (int i)
int	getSegment (double t) const
bool	validate () const
std::string	toString ()
bool	hasError () const
bool	hasMessage () const
std::string	getMessage ()
std::string	getMessageNoClear () const

Static Public Attributes
static const GeneralPlan	INVALID = GeneralPlan()

Private Attributes
Plan	fp
PolyPath	pp
bool	plan
bool	poly
bool	containment

Detailed Description

A "general state" object that holds Euclidean or Lat/Lon information about position and velocity for an object. Currently this can either be a (point-mass) aircraft or a (possible morphing) polygon. This is intended to be traffic information that will be converted to a General3DState object to be sent to a GeneralDetector object.

Constructor & Destructor Documentation

GeneralPlan()

larcfm::GeneralPlan::GeneralPlan	(	const PolyPath &	p,
		bool	cont
	)

Allows for containment polygons

Parameters

p
cont	true = containment poly, false = avoidance poly
time

Member Function Documentation

getMessage()

std::string larcfm::GeneralPlan::getMessage ( )

inlinevirtual

Return a string representation of any errors or warnings. Calling this method will clear any messages and reset both the error and warning status to none.

Returns

error and warning messages. If there are no messages, an empty string is returned.

Implements larcfm::ErrorReporter.

getMessageNoClear()

std::string larcfm::GeneralPlan::getMessageNoClear ( ) const

inlinevirtual

Return a string representation of any errors or warnings. Calling this method will not clear the error or warning status (i.e., hasError() will return the same value before and after this call.)

Returns

error and warning messages. If there are no messages, an empty string is returned.

Implements larcfm::ErrorReporter.

hasError()

bool larcfm::GeneralPlan::hasError ( ) const

inlinevirtual

Does this object have an error?

Returns

true if there is an error.

Implements larcfm::ErrorReporter.

hasMessage()

bool larcfm::GeneralPlan::hasMessage ( ) const

inlinevirtual

Does this object have an error or a warning?

Returns

true if there is an error or warning.

Implements larcfm::ErrorReporter.

---

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

• Modules/ACCoRD/inc/GeneralPlan.h
• Modules/ACCoRD/src/GeneralPlan.cpp