BAttributeDef Class Reference

#include <BAttributeDef.h>

List of all members.

---

Detailed Description

Defines a data attribute associated with a BFeature.

This object defines the properties of a BAttribute, but it does not contain any data for the BAttribute.

Public Member Functions
	BAttributeDef (const BAttributeDef &attributeDef)
	Copy constructor.
	BAttributeDef (const BString &name, EVariantType type, int width=0, int precision=0)
	Constructor that specifies all properties for a BAttributeDef.
	BAttributeDef ()
	Default constructor.
virtual BAttributeDef *	Clone (void) const
	Creates a deep-copy of this object.
const BString &	GetName (void) const
	Gets the name of the BAttribute defined by this BAttributeDef.
int	GetPrecision (void) const
	Gets the precision of the BAttribute defined by this BAttributeDef.
EVariantType	GetType (void) const
	Gets the type of data that can be contained in the BAttribute defined by this BAttributeDef.
int	GetWidth (void) const
	Gets the width of the BAttribute defined by this BAttributeDef.
bool	operator!= (const BAttributeDef &rhs) const
	Inequality operator.
BAttributeDef &	operator= (const BAttributeDef &rhs)
	Assignment operator.
bool	operator== (const BAttributeDef &rhs) const
	Equality operator.
void	SetName (const BString &name)
	Sets the name for the BAttribute defined by this BAttributeDef.
void	SetPrecision (int precision)
	Sets the precision of the BAttribute defined by this BAttributeDef.
void	SetType (EVariantType type)
	Sets the type of data that can be contained in the BAttribute defined by this BAttributeDef.
void	SetWidth (int width)
	Sets the width of the BAttribute defined by this BAttributeDef.
virtual	~BAttributeDef ()
	Destructor.

---

Constructor & Destructor Documentation

BAttributeDef

(

)

[inline]

Default constructor.

This constructor will create an empty attribute definition.

BAttributeDef	(	const BString &	name,
		EVariantType	type,
		int	width = 0,
		int	precision = 0
	)			[inline]

Constructor that specifies all properties for a BAttributeDef.

Parameters:

	name	The BAttribute name.
	type	The type of data that can be stored in the BAttribute.
	width	The BAttribute data width.
	precision	The BAttribute data precision (for floating point data only).

BAttributeDef

(

const BAttributeDef &

attributeDef

)

Copy constructor.

Parameters:

attributeDef

The BAttributeDef to copy.

virtual ~BAttributeDef

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual BAttributeDef* Clone

(

void

)

const [inline, virtual]

Creates a deep-copy of this object.

Returns:

A deep-copy of this object.

const BString& GetName

(

void

)

const [inline]

Gets the name of the BAttribute defined by this BAttributeDef.

Returns:

The name for the BAttribute.

int GetPrecision

(

void

)

const [inline]

Gets the precision of the BAttribute defined by this BAttributeDef.

The precision is only used when the BAttribute will store floating point data.

Returns:

The data precision (for floating point attributes only).

EVariantType GetType

(

void

)

const [inline]

Gets the type of data that can be contained in the BAttribute defined by this BAttributeDef.

Returns:

The data type for the BAttribute.

int GetWidth

(

void

)

const [inline]

Gets the width of the BAttribute defined by this BAttributeDef.

Returns:

The width of the BAttribute.

bool operator!=

(

const BAttributeDef &

rhs

)

const [inline]

Inequality operator.

Parameters:

rhs

The BAttributeDef to compare to this one.

Returns:

True if the two BAttributeDef objects do not have the same value and false otherwise.

BAttributeDef& operator=

(

const BAttributeDef &

rhs

)

Assignment operator.

Parameters:

rhs

The AttributeDef whose value will be copied into this one.

Returns:

A reference to this BAttributeDef.

bool operator==

(

const BAttributeDef &

rhs

)

const

Equality operator.

Parameters:

rhs

The BAttributeDef to compare to this one.

Returns:

True if the two BAttributeDef objects have the same value and false otherwise.

void SetName

(

const BString &

name

)

[inline]

Sets the name for the BAttribute defined by this BAttributeDef.

Parameters:

name

The new name for the BAttribute.

void SetPrecision

(

int

precision

)

[inline]

Sets the precision of the BAttribute defined by this BAttributeDef.

The precision is only used when the BAttribute will store floating point data.

Parameters:

precision

The data precision (for floating point attributes only).

void SetType

(

EVariantType

type

)

Sets the type of data that can be contained in the BAttribute defined by this BAttributeDef.

Parameters:

type

The data type for the BAttribute.

void SetWidth

(

int

width

)

[inline]

Sets the width of the BAttribute defined by this BAttributeDef.

Parameters:

width

The width of the BAttribute.

---

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

• BAttributeDef.h

---

GeoTranslate 5.0 From Blue Marble Geographics