BLinearGeo Class Reference

#include <BLinearGeo.h>

Inheritance diagram for BLinearGeo:

Inheritance graph
[legend]

List of all members.


Detailed Description

Abstract base class for line-type geometries, such as lines, polylines, and arcs.

Public Member Functions

virtual size_t ComputeSize (void) const
 Computes the size of the BByteArray required to store this object.
virtual bool Contains (const BPoint &point) const
 Determines whether or not the specified BPoint is contained within this BLinearGeo.
virtual void FromByteArray (const BByteArray &bytes, size_t &startPos)
 Initializes an instance of this object from a BByteArray.
virtual double GetLength (void) const
 Gets the length of this BLinearGeo.
virtual BByteArray ToByteArray (void) const
 Stores this object in a BByteArray.

Protected Member Functions

 BLinearGeo (const BLinearGeo &lgeo)
 Copy constructor.
 BLinearGeo (EGeometryType type)
 Constructs a BLinearGeo with the specified geometry type.
 BLinearGeo ()
 Default constructor.
virtual void ComputeStats (void) const =0
 Calculates the length and MBR of this BLinearGeo.

Protected Attributes

double m_length
 The length of this BLinearGeo.

Constructor & Destructor Documentation

BLinearGeo (  )  [inline, protected]

Default constructor.

This constructor is hidden because this is an abstract class.

BLinearGeo ( EGeometryType  type  )  [inline, protected]

Constructs a BLinearGeo with the specified geometry type.

This constructor is hidden because this is an abstract base class.

Parameters:
type The type of BLinearGeo to create.

BLinearGeo ( const BLinearGeo lgeo  )  [inline, protected]

Copy constructor.

This constructor is hidden because this is an abstract class.

Parameters:
lgeo The BLinearGeo object to copy.


Member Function Documentation

virtual size_t ComputeSize ( void   )  const [inline, virtual]

Computes the size of the BByteArray required to store this object.

Returns:
The size of the BByteArray.

Reimplemented from BGeometry.

Reimplemented in BAggregateLinear, BArc, BLine, BPath, BPolyline, and BSegment.

virtual void ComputeStats ( void   )  const [protected, pure virtual]

Calculates the length and MBR of this BLinearGeo.

Implemented in BAggregateLinear, BArc, BLine, BPath, and BPolyline.

virtual bool Contains ( const BPoint point  )  const [inline, virtual]

Determines whether or not the specified BPoint is contained within this BLinearGeo.

Parameters:
point The point to test for containment.
Returns:
True if the point is contained within this BLinearGeo and false otherwise.

virtual void FromByteArray ( const BByteArray bytes,
size_t &  startPos 
) [virtual]

Initializes an instance of this object from a BByteArray.

Parameters:
bytes The BByteArray containing the byte representation of the object.
startPos The position in the BByteArray where the byte representation begins. This value will be updated to point to the byte past the end of this object in the byte array.

Reimplemented from BGeometry.

Reimplemented in BAggregateLinear, BArc, BLine, BPath, BPolyline, and BSegment.

virtual double GetLength ( void   )  const [virtual]

Gets the length of this BLinearGeo.

Returns:
The length of this BLinearGeo. The units used to express this length are the same as the units used to express the location of this BLinearGeo.

virtual BByteArray ToByteArray ( void   )  const [virtual]

Stores this object in a BByteArray.

Returns:
A BByteArray that stores the contents of this object.

Reimplemented from BGeometry.

Reimplemented in BAggregateLinear, BArc, BLine, BPath, BPolyline, and BSegment.


Member Data Documentation

double m_length [mutable, protected]

The length of this BLinearGeo.


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

GeoTranslate 5.0 From Blue Marble Geographics