BSegLink Class Reference

#include <BSegLink.h>

Inheritance diagram for BSegLink:

[legend]

List of all members.

---

Detailed Description

Represents a link between two points in a BPath.

This may represent a BSegment that has been added to the BPath, or it may represent a link between two non-connected BSegments that have been added to the path.

Public Member Functions
	BSegLink (const BSegLink &link)
	Copy constructor.
	BSegLink (ESegmentType segType, const BSegmentPtr &pSeg)
	Constructs a BSegLink with the specified geometry.
	BSegLink (const BSegmentPtr &pSeg)
	Constructs a BSegLink from an existing BSegment.
	BSegLink ()
	Default constructor.
virtual size_t	ComputeSize (void) const
	Computes the size of the BByteArray required to store this object.
virtual void	FromByteArray (const BByteArray &bytes, size_t &startPos)
	Initializes an instance of this object from a BByteArray.
const BSegmentPtr	GetSegmentPtr (void) const
	Gets the pointer to the BSegment that defines the curvature for this BSegLink.
BSegmentPtr	GetSegmentPtr (void)
	Gets the pointer to the BSegment that defines the curvature for this BSegLink.
ESegmentType	GetSegmentType (void) const
	Gets the segment type.
BSegLink &	operator= (const BSegLink &rhs)
	Assignment operator.
void	SetSegmentPtr (const BSegmentPtr pSeg)
	Sets the pointer to the BSegment that defines the curvature for this BSegLink.
void	SetSegmentType (ESegmentType type)
	Sets the segment type.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
virtual	~BSegLink ()
	Destructor.

---

Constructor & Destructor Documentation

BSegLink

(

)

[inline]

Default constructor.

The resulting BSegLink represents the end of a BPath.

BSegLink

(

const BSegmentPtr &

pSeg

)

[inline]

Constructs a BSegLink from an existing BSegment.

Parameters:

pSeg

The BSegment used to define this link.

BSegLink	(	ESegmentType	segType,
		const BSegmentPtr &	pSeg
	)			[inline]

Constructs a BSegLink with the specified geometry.

Parameters:

	segType	The type of segment represented by this BSegLink.
	pSeg	The segment's curve definition.

BSegLink

(

const BSegLink &

link

)

[inline]

Copy constructor.

Parameters:

link

The BSegLink to copy.

virtual ~BSegLink

(

)

[inline, virtual]

Destructor.

---

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.

Implements BByteStreamable.

virtual void FromByteArray	(	const BByteArray &	bytes,
		size_t &	startPos
	)			[inline, 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.

Implements BByteStreamable.

const BSegmentPtr GetSegmentPtr

(

void

)

const [inline]

Gets the pointer to the BSegment that defines the curvature for this BSegLink.

Returns:

The BSegment that defines the curvature for this BSegLink.

BSegmentPtr GetSegmentPtr

(

void

)

[inline]

Gets the pointer to the BSegment that defines the curvature for this BSegLink.

Returns:

The BSegment that defines the curvature for this BSegLink.

ESegmentType GetSegmentType

(

void

)

const [inline]

Gets the segment type.

Returns:

The segment type.

BSegLink& operator=

(

const BSegLink &

rhs

)

[inline]

Assignment operator.

Parameters:

rhs

The BSegLink whose value will be copied into this one.

Returns:

A reference to this BSegLink.

void SetSegmentPtr

(

const BSegmentPtr

pSeg

)

[inline]

Sets the pointer to the BSegment that defines the curvature for this BSegLink.

Parameters:

pSeg

The BSegment that defines the curvature for this BSegLink.

void SetSegmentType

(

ESegmentType

type

)

[inline]

Sets the segment type.

Parameters:

type

The segment type.

virtual BByteArray ToByteArray

(

void

)

const [inline, virtual]

Stores this object in a BByteArray.

Returns:

A BByteArray that stores the contents of this object.

Implements BByteStreamable.

---

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

• BSegLink.h

---

GeoTranslate 5.0 From Blue Marble Geographics