DtRangeNetworkSegmentMetric Class Reference

DtRangeNetworkSegmentMetric is a metric for segments in an mx-cif quadtree. More...

Inheritance diagram for DtRangeNetworkSegmentMetric:

List of all members.

Public Member Functions
	DtRangeNetworkSegmentMetric ()
	Default constructor.
virtual	~DtRangeNetworkSegmentMetric ()
	Destructor.
	DtRangeNetworkSegmentMetric (const DtRangeNetworkSegmentMetric &orig)
	Vopy constructor.
DtRangeNetworkSegmentMetric &	operator= (const DtRangeNetworkSegmentMetric &orig)
	Assignment operator.
virtual double	measure (const DtNetworkSegment &seg) const
	Measure the seg by its distance from the center of interest.
virtual bool	circumscribedSquareTest (const DtNetworkSegment &seg) const
	quick check using the square circumscribing the circle around the center of interest.
virtual bool	inscribedSquareTest (const DtNetworkSegment &seg) const
	quick check using the square inscribing the circle around the center of interest.
virtual bool	valid (const DtNetworkSegment &seg) const
	validate the segment
virtual bool	validSW (double xx, double yy) const
	validate the southwest quadrant (closed on southwest side)
virtual bool	validSE (double xx, double yy) const
	validate the southeast quadrant (closed on southwest side)
virtual bool	validNE (double xx, double yy) const
	validate the northeast quadrant (closed on southwest side)
virtual bool	validNW (double xx, double yy) const
	validate the northwest quadrant (closed on southwest side)
virtual const DtPoint &	centerOfInterest () const
	get/set center of interest
virtual void	setCenterOfInterest (const DtPoint &val)
virtual DtVector	vectorCenterOfInterest () const
	get/set center of interest--DtVector form
virtual void	setCenterOfInterest (const DtVector &val)
virtual double	maxRange () const
	get/set range
virtual void	setMaxRange (double val)
virtual double	measureMultiplier () const
	get/set measure multiplier
virtual void	setMeasureMultiplier (double val)
virtual bool	evalInZ () const
	get/set evaluation in Z
virtual void	setEvalInZ (bool evalInZ)
virtual double	closestPointInXY (const DtNetworkSegment &seg, const DtPoint &pointFrom, DtPoint &closest)
	Finds the closest point on the segment projected and returns it in database coords along with distance to that point.
virtual void	initialize (Coordinate_System *cs)
	Initialize the metric.
Protected Member Functions
virtual double	closestPointInXY (const DtNetworkSegment &seg, const DtPoint &pointFrom) const
virtual double	distanceToPoint (const DtNetworkSegment &seg, const DtPoint &point) const
Protected Attributes
DtPoint	myCenterOfInterest
double	myMaxRange
double	myMeasureMultiplier
bool	myEvalInZ

---

Detailed Description

DtRangeNetworkSegmentMetric is a metric for segments in an mx-cif quadtree.

The metric is based on distance from a point.

---

Constructor & Destructor Documentation

DtRangeNetworkSegmentMetric::DtRangeNetworkSegmentMetric

(

)

Default constructor.

virtual DtRangeNetworkSegmentMetric::~DtRangeNetworkSegmentMetric

(

)

[virtual]

Destructor.

DtRangeNetworkSegmentMetric::DtRangeNetworkSegmentMetric

(

const DtRangeNetworkSegmentMetric &

orig

)

Vopy constructor.

---

Member Function Documentation

DtRangeNetworkSegmentMetric& DtRangeNetworkSegmentMetric::operator=

(

const DtRangeNetworkSegmentMetric &

orig

)

Assignment operator.

virtual double DtRangeNetworkSegmentMetric::measure

(

const DtNetworkSegment &

seg

)

const [virtual]

Measure the seg by its distance from the center of interest.

Implements DtNetworkSegmentMetric.

virtual bool DtRangeNetworkSegmentMetric::circumscribedSquareTest

(

const DtNetworkSegment &

seg

)

const [virtual]

quick check using the square circumscribing the circle around the center of interest.

Reimplemented in BHAVE::DtAllMetric.

virtual bool DtRangeNetworkSegmentMetric::inscribedSquareTest

(

const DtNetworkSegment &

seg

)

const [virtual]

quick check using the square inscribing the circle around the center of interest.

Reimplemented in BHAVE::DtAllMetric.

virtual bool DtRangeNetworkSegmentMetric::valid

(

const DtNetworkSegment &

seg

)

const [virtual]

validate the segment

Implements DtNetworkSegmentMetric.

Reimplemented in DtRangeAndDirectionNetworkSegmentMetric.

virtual bool DtRangeNetworkSegmentMetric::validSW	(	double	xx,
		double	yy
	)		const [virtual]

validate the southwest quadrant (closed on southwest side)

Implements DtNetworkSegmentMetric.

Reimplemented in BHAVE::DtAllMetric.

virtual bool DtRangeNetworkSegmentMetric::validSE	(	double	xx,
		double	yy
	)		const [virtual]

validate the southeast quadrant (closed on southwest side)

Implements DtNetworkSegmentMetric.

Reimplemented in BHAVE::DtAllMetric.

virtual bool DtRangeNetworkSegmentMetric::validNE	(	double	xx,
		double	yy
	)		const [virtual]

validate the northeast quadrant (closed on southwest side)

Implements DtNetworkSegmentMetric.

Reimplemented in BHAVE::DtAllMetric.

virtual bool DtRangeNetworkSegmentMetric::validNW	(	double	xx,
		double	yy
	)		const [virtual]

validate the northwest quadrant (closed on southwest side)

Implements DtNetworkSegmentMetric.

Reimplemented in BHAVE::DtAllMetric.

virtual const DtPoint& DtRangeNetworkSegmentMetric::centerOfInterest

(

)

const [virtual]

get/set center of interest

virtual void DtRangeNetworkSegmentMetric::setCenterOfInterest

(

const DtPoint &

val

)

[virtual]

virtual DtVector DtRangeNetworkSegmentMetric::vectorCenterOfInterest

(

)

const [virtual]

get/set center of interest--DtVector form

virtual void DtRangeNetworkSegmentMetric::setCenterOfInterest

(

const DtVector &

val

)

[virtual]

virtual double DtRangeNetworkSegmentMetric::maxRange

(

)

const [virtual]

get/set range

virtual void DtRangeNetworkSegmentMetric::setMaxRange

(

double

val

)

[virtual]

virtual double DtRangeNetworkSegmentMetric::measureMultiplier

(

)

const [virtual]

get/set measure multiplier

virtual void DtRangeNetworkSegmentMetric::setMeasureMultiplier

(

double

val

)

[virtual]

virtual bool DtRangeNetworkSegmentMetric::evalInZ

(

)

const [virtual]

get/set evaluation in Z

virtual void DtRangeNetworkSegmentMetric::setEvalInZ

(

bool

evalInZ

)

[virtual]

virtual double DtRangeNetworkSegmentMetric::closestPointInXY	(	const DtNetworkSegment &	seg,
		const DtPoint &	pointFrom,
		DtPoint &	closest
	)		[virtual]

Finds the closest point on the segment projected and returns it in database coords along with distance to that point.

virtual void DtRangeNetworkSegmentMetric::initialize

(

Coordinate_System *

cs

)

[virtual]

Initialize the metric.

Use this call to do any additional preparation/initialization before the metric can be used. The vector network calls this function every time a metric is about to be used.

Reimplemented from DtMetric.

virtual double DtRangeNetworkSegmentMetric::closestPointInXY	(	const DtNetworkSegment &	seg,
		const DtPoint &	pointFrom
	)		const [protected, virtual]

virtual double DtRangeNetworkSegmentMetric::distanceToPoint	(	const DtNetworkSegment &	seg,
		const DtPoint &	point
	)		const [protected, virtual]

---

Member Data Documentation

DtPoint DtRangeNetworkSegmentMetric::myCenterOfInterest [protected]

double DtRangeNetworkSegmentMetric::myMaxRange [protected]

double DtRangeNetworkSegmentMetric::myMeasureMultiplier [protected]

bool DtRangeNetworkSegmentMetric::myEvalInZ [protected]

---

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

• include/gdb/rangeNetSegMet.h