BTextLines Class Reference

#include <BTextLines.h>

Inheritance diagram for BTextLines:

[legend]

List of all members.

---

Detailed Description

A collection of BTextLine objects.

Public Member Functions
void	Add (const BTextLine &line)
	Adds a BTextLine to this collection.
	BTextLines ()
	Default constructor.
void	Clear (void)
	Removes all BTextLine objects from this collection.
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.
BTextLine &	GetAt (size_t index)
	Gets the requested BTextLine from this collection.
const BTextLine &	GetAt (size_t index) const
	Gets the requested BTextLine from this collection.
size_t	GetCount (void) const
	Gets the number of BTextLines in this collection.
void	Remove (const BTextLine &line)
	Removes a BTextLine from this collection.
void	Reserve (size_t size)
	Reserves space for the specified number of elements in this collection.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
virtual void	Transform (const BTransform &cst)
	Transforms each BTextLine in this collection to a different coordinate system.
virtual void	TransformReverse (const BTransform &cst)
	Transforms each BTextLine in this collection to a different coordinate system using the "reverse" of the BTransform.
virtual	~BTextLines ()
	Destructor.

---

Constructor & Destructor Documentation

BTextLines

(

)

[inline]

Default constructor.

virtual ~BTextLines

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

void Add

(

const BTextLine &

line

)

[inline]

Adds a BTextLine to this collection.

Parameters:

line

The BTextLine to be added.

void Clear

(

void

)

[inline]

Removes all BTextLine objects from this collection.

virtual size_t ComputeSize

(

void

)

const [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
	)			[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.

BTextLine& GetAt

(

size_t

index

)

[inline]

Gets the requested BTextLine from this collection.

Parameters:

index

The zero-based index of the desired BTextLine.

Returns:

The BTextLine at the specified index.

const BTextLine& GetAt

(

size_t

index

)

const [inline]

Gets the requested BTextLine from this collection.

Parameters:

index

The zero-based index of the desired BTextLine.

Returns:

The BTextLine at the specified index.

size_t GetCount

(

void

)

const [inline]

Gets the number of BTextLines in this collection.

Returns:

The number of BTextLines in this collection.

void Remove

(

const BTextLine &

line

)

Removes a BTextLine from this collection.

Parameters:

line

The BTextLine to be removed.

void Reserve

(

size_t

size

)

[inline]

Reserves space for the specified number of elements in this collection.

Parameters:

size

The number of elements for which space shall be reserved.

virtual BByteArray ToByteArray

(

void

)

const [virtual]

Stores this object in a BByteArray.

Returns:

A BByteArray that stores the contents of this object.

Implements BByteStreamable.

virtual void Transform

(

const BTransform &

cst

)

[virtual]

Transforms each BTextLine in this collection to a different coordinate system.

Parameters:

cst

The BTransform that defines the transformation.

virtual void TransformReverse

(

const BTransform &

cst

)

[virtual]

Transforms each BTextLine in this collection to a different coordinate system using the "reverse" of the BTransform.

Parameters:

cst

The BTransform that defines the transformation.

---

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

• BTextLines.h

---

GeoTranslate 5.0 From Blue Marble Geographics