GeoCore::BBlockDefs

BBlockDefs Class Reference

#include <BBlockDefs.h>

List of all members.

Detailed Description

A collection of BBlockDef objects.

Public Member Functions

void Add (const BBlockDef &def)
 Adds a BBlockDef to this BBlockDefs.
 BBlockDefs ()
 Default constructor, which constructs an empty collection.
void Clear (void)
 Removes all BBlockDef objects from this BBlockDefs.
BBlockDef & GetAt (size_t index)
 Gets the BBlockDef at the specified index in this BBlockDefs.
const BBlockDef & GetAt (size_t index) const
 Gets the BBlockDef at the specified index in this BBlockDefs.
const BBlockDef & GetByBlockName (const BString &blockName) const
 Gets the BBlockDef with the specified name in this BBlockDefs.
BBlockDef & GetByBlockName (const BString &blockName)
 Gets the BBlockDef with the specified name in this BBlockDefs.
size_t GetCount (void) const
 Gets the number of BBlockDef objects in this BBlockDefs.
void Remove (const BBlockDef &def)
 Removes a BBlockDef from this BBlockDefs.
void Reserve (size_t size)
 Reserves space in the collection for the specified number of objects.
virtual ~BBlockDefs ()
 Destructor.

Constructor & Destructor Documentation

BBlockDefs (  )  [inline]

Default constructor, which constructs an empty collection.

virtual ~BBlockDefs (  )  [inline, virtual]

Destructor.

Member Function Documentation

void Add ( const BBlockDef &  def  )  [inline]

Adds a BBlockDef to this BBlockDefs.

Parameters:
def The BBlockDef to be added.

void Clear ( void   )  [inline]

Removes all BBlockDef objects from this BBlockDefs.

BBlockDef& GetAt ( size_t  index  )  [inline]

Gets the BBlockDef at the specified index in this BBlockDefs.

Parameters:
index The zero-based index of the desired BBlockDef.
Returns:
The BBlockDef at the specified index in this BBlockDefs.

const BBlockDef& GetAt ( size_t  index  )  const [inline]

Gets the BBlockDef at the specified index in this BBlockDefs.

Parameters:
index The zero-based index of the desired BBlockDef.
Returns:
The BBlockDef at the specified index in this BBlockDefs.

const BBlockDef& GetByBlockName ( const BString &  blockName  )  const

Gets the BBlockDef with the specified name in this BBlockDefs.

Parameters:
blockName The name of the desired BBlockDef.
Returns:
The BBlockDef with the specified name.
Exceptions:
BKeyNotFoundException This exception will be thrown if there does not exist a BBlockDef with the specified name in this BBlockDefs.

BBlockDef& GetByBlockName ( const BString &  blockName  ) 

Gets the BBlockDef with the specified name in this BBlockDefs.

Parameters:
blockName The name of the desired BBlockDef.
Returns:
The BBlockDef with the specified name.
Exceptions:
BKeyNotFoundException This exception will be thrown if there does not exist a BBlockDef with the specified name in this BBlockDefs.

size_t GetCount ( void   )  const [inline]

Gets the number of BBlockDef objects in this BBlockDefs.

Returns:
The number of BBlockDef objects in this collection.

void Remove ( const BBlockDef &  def  ) 

Removes a BBlockDef from this BBlockDefs.

If the specified BBlockDef is not contained in this BBlockDefs, then this collection will not be changed.

Parameters:
def The BBlockDef to be removed.

void Reserve ( size_t  size  )  [inline]

Reserves space in the collection for the specified number of objects.

Parameters:
size The number of objects to reserve space for.

The documentation for this class was generated from the following file:
GeoTranslate 5.0 From Blue Marble Geographics