BFeature Class Reference

#include <BFeature.h>

Inheritance diagram for BFeature:

Detailed Description

Represents a single feature in a layer.


Public Member Functions
	BFeature (const BFeature &feat)
	Copy constructor.
	BFeature (EFeatureType type)
	Constructor.
	BFeature ()
	Default constructor.
virtual BFeature *	Clone (void) const
	Creates a deep-copy of this object.
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 BAttributes &	GetAttributes (void) const
	Gets the BAttributes for this BFeature.
BAttributes &	GetAttributes (void)
	Gets the BAttributes for this BFeature.
BRendition &	GetDefaultRendition (void)
	Gets the default BRendition used when no other rendition has been specified.
const BRendition &	GetDefaultRendition (void) const
	Gets the default BRendition used when no other rendition has been specified.
BGeometryPtr &	GetGeometry (void)
	Gets the geometry for this BFeature.
const BGeometryPtr &	GetGeometry (void) const
	Gets the geometry for this BFeature.
virtual const BRect &	GetMBR (void) const
	Gets the minimum bounding rectangle for this BFeature.
const BString &	GetName (void) const
	Get the name for this BFeature.
EFeatureType	GetType (void) const
	Gets the feature type.
bool	HasGeometry (void) const
	Indicates whether or not this feature has a geometry object.
bool	Is3d (void) const
	Indicates whether or not this BFeature is three-dimensional.
bool	IsVisible (void) const
	Indicates whether or not the feature is visible.
void	SetAttributes (const BAttributes &attrs)
	Sets the attributes for the Bfeature.
void	SetDefaultRendition (const BRendition &rend)
	Sets the default BRendition to be used if no other rendition has been specified.
virtual void	SetGeometry (const BGeometryPtr &geo)
	Sets the BGeometry for this BFeature.
void	SetIsVisible (bool visible)
	Sets the visibility of this BFeature.
void	SetMBR (const BRect mbr)
	Sets the minimum bounding rectangle for this BFeature.
void	SetName (const BString &name)
	Sets the name for this BFeature.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
virtual void	Transform (const BTransform &cst)
	Transform this BFeature's geometry to a different coordinate system.
virtual void	TransformReverse (const BTransform &cst)
	Transform this BFeature's geometry to a different coordinate system using the "reverse" of the BTransform.
virtual	~BFeature ()
	Destructor.
Static Public Member Functions
static BFeature *	FromBinary (const BByteArray &bytes, size_t &startPos, bool inclAttrs)
	Initialize a BFeature from a BByteArray.
Protected Attributes
BAttributes	m_attributes
	The attribute data associated with this BFeature.
BRendition	m_defaultRendition
	The default rendition, used if no other rendition is specified.
BGeometryPtr	m_geometry
	The geometry associated with this BFeature.
bool	m_inclCachedAttrs
	Indicates whether or not to include attributes during FromByteArray().
bool	m_isVisible
	Indicates whether or not the feature is visible.
BString	m_name
	The name of this BFeature.
EFeatureType	m_type
	The type of this BFeature.

Constructor & Destructor Documentation

BFeature ( ) [inline]

Default constructor.

BFeature ( EFeatureType type ) [inline]

Constructor.

Parameters:

type

The feature type.

BFeature ( const BFeature & feat )

Copy constructor.

Parameters:

feat

The BFeature to copy.

virtual ~BFeature ( ) [inline, virtual]

Destructor.

Member Function Documentation

virtual BFeature* Clone ( void ) const [inline, virtual]

Creates a deep-copy of this object.

Returns:: A deep-copy of this object.

Reimplemented in BBlockRefFeature, BExternalRefFeature, BMultilineTextFeature, BSymbolFeature, and BTextFeature.

virtual size_t ComputeSize ( void ) const [virtual]

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

Returns:: The size of the BByteArray.

Reimplemented from BMetadataContainer.

Reimplemented in BBlockRefFeature, BExternalRefFeature, BMultilineTextFeature, BSymbolFeature, and BTextFeature.

static BFeature* FromBinary	(	const BByteArray &	bytes,
		size_t &	startPos,
		bool	inclAttrs
	)			`[static]`

Initialize a BFeature 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.
	inclAttrs	Indicates whether or not to include the attributes when making a feature from a BByteArray.

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 BMetadataContainer.

Reimplemented in BBlockRefFeature, BExternalRefFeature, BMultilineTextFeature, BSymbolFeature, and BTextFeature.

const BAttributes& GetAttributes ( void ) const [inline]

Gets the BAttributes for this BFeature.

Returns:: The attribute collection for this BFeature.

BAttributes& GetAttributes ( void ) [inline]

Gets the BAttributes for this BFeature.

Returns:: The attribute collection for this BFeature.

BRendition& GetDefaultRendition ( void ) [inline]

Gets the default BRendition used when no other rendition has been specified.

Returns:: The default rendition information.

const BRendition& GetDefaultRendition ( void ) const [inline]

Gets the default BRendition used when no other rendition has been specified.

Returns:: The default rendition information.

BGeometryPtr& GetGeometry ( void ) [inline]

Gets the geometry for this BFeature.

Returns:: The BGeometry for this BFeature.

const BGeometryPtr& GetGeometry ( void ) const [inline]

Gets the geometry for this BFeature.

Returns:: The BGeometry for this BFeature.

virtual const BRect& GetMBR ( void ) const [virtual]

Gets the minimum bounding rectangle for this BFeature.

Returns:: The minimum bounding rectangle.

Reimplemented in BSymbolFeature, and BTextFeature.

const BString& GetName ( void ) const [inline]

Get the name for this BFeature.

Returns:: The BFeature's name

EFeatureType GetType ( void ) const [inline]

Gets the feature type.

Returns:: The feature type.

bool HasGeometry ( void ) const [inline]

Indicates whether or not this feature has a geometry object.

Returns:: True if the feature has a geometry object and false otherwise.

bool Is3d ( void ) const

Indicates whether or not this BFeature is three-dimensional.

A feature is 3D if its geometry is 3D.

Returns:: True if this BFeature is three-dimensinoal and false otherwise.

bool IsVisible ( void ) const [inline]

Indicates whether or not the feature is visible.

Returns:: True if the feature is visible and false otherwise.

void SetAttributes ( const BAttributes & attrs ) [inline]

Sets the attributes for the Bfeature.

Parameters:

attrs

An attribute collection.

void SetDefaultRendition ( const BRendition & rend ) [inline]

Sets the default BRendition to be used if no other rendition has been specified.

Parameters:

rend

The default rendition.

virtual void SetGeometry ( const BGeometryPtr & geo ) [virtual]

Sets the BGeometry for this BFeature.

Parameters:

geo

A BGeometry object.

Reimplemented in BBlockRefFeature, BExternalRefFeature, BSymbolFeature, and BTextFeature.

void SetIsVisible ( bool visible ) [inline]

Sets the visibility of this BFeature.

Parameters:

visible

Passing true will ensure that this BFeature is visible, and passing an argument of false will ensure that this BFeature is not visible.

void SetMBR ( const BRect mbr )

Sets the minimum bounding rectangle for this BFeature.

Parameters:

mbr

The minimum bounding rectangle.

void SetName ( const BString & name ) [inline]

Sets the name for this BFeature.

Parameters:

name

The desired name.

virtual BByteArray ToByteArray ( void ) const [virtual]

Stores this object in a BByteArray.

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

Reimplemented from BMetadataContainer.

Reimplemented in BBlockRefFeature, BExternalRefFeature, BMultilineTextFeature, BSymbolFeature, and BTextFeature.

virtual void Transform ( const BTransform & cst ) [virtual]

Transform this BFeature's geometry to a different coordinate system.

Parameters:

cst

The BTransform that defines the transformation.

Reimplemented in BMultilineTextFeature, BSymbolFeature, and BTextFeature.

virtual void TransformReverse ( const BTransform & cst ) [virtual]

Transform this BFeature's geometry to a different coordinate system using the "reverse" of the BTransform.

Parameters:

cst

The BTransform that defines the transformation.

Reimplemented in BMultilineTextFeature, BSymbolFeature, and BTextFeature.

Member Data Documentation

BAttributes m_attributes [protected]

The attribute data associated with this BFeature.

BRendition m_defaultRendition [protected]

The default rendition, used if no other rendition is specified.

BGeometryPtr m_geometry [protected]

The geometry associated with this BFeature.

bool m_inclCachedAttrs [protected]

Indicates whether or not to include attributes during FromByteArray().

bool m_isVisible [protected]

Indicates whether or not the feature is visible.

BString m_name [protected]

The name of this BFeature.

EFeatureType m_type [protected]

The type of this BFeature.

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

BFeature.h

GeoTranslate 5.0 From Blue Marble Geographics

BFeature Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation