BMetadataContainer Class Reference

#include <BMetadataContainer.h>

Inheritance diagram for BMetadataContainer:

[legend]

List of all members.

---

Detailed Description

Base class for objects that contain BMetadata objects.

Public Member Functions
	BMetadataContainer (const BMetadataContainer &mdc)
	Copy constructor.
	BMetadataContainer ()
	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.
BMetadata &	GetMetadata (void)
	Gets the BMetadata associated with this BMetadataContainer.
const BMetadata &	GetMetadata (void) const
	Gets the BMetadata associated with this BMetadataContainer.
BMetadata &	GetPrivateMetadata (void)
	Get the private BMetadata associated with this BMetadataContainer.
const BMetadata &	GetPrivateMetadata (void) const
	Get the private BMetadata associated with this BMetadataContainer.
void	SetMetadata (const BMetadata &props)
	Sets the BMetadata associated with this BMetadataContainer.
void	SetPrivateMetadata (const BMetadata &props)
	Sets the private BMetadata associated with this BMetadataContainer.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
virtual	~BMetadataContainer ()
	Destructor.

---

Constructor & Destructor Documentation

BMetadataContainer

(

)

[inline]

Default constructor.

BMetadataContainer

(

const BMetadataContainer &

mdc

)

[inline]

Copy constructor.

Parameters:

mdc

The BMetadataContainer object to copy.

virtual ~BMetadataContainer

(

)

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

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

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.

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

BMetadata& GetMetadata

(

void

)

[inline]

Gets the BMetadata associated with this BMetadataContainer.

Returns:

The BMetadata associated with this BMetadataContainer.

const BMetadata& GetMetadata

(

void

)

const [inline]

Gets the BMetadata associated with this BMetadataContainer.

Returns:

The BMetadata associated with this BMetadataContainer.

BMetadata& GetPrivateMetadata

(

void

)

[inline]

Get the private BMetadata associated with this BMetadataContainer.

This data is meant to be used internally by readers and writers. End-user applications that use these values should do so at their own risk.

Returns:

The private BMetadata associated with this BMetadataContainer.

const BMetadata& GetPrivateMetadata

(

void

)

const [inline]

Get the private BMetadata associated with this BMetadataContainer.

This data is meant to be used internally by readers and writers. End-user applications that use these values should do so at their own risk.

Returns:

The private BMetadata associated with this BMetadataContainer.

void SetMetadata

(

const BMetadata &

props

)

[inline]

Sets the BMetadata associated with this BMetadataContainer.

Parameters:

props

The BMetadata associated with this BMetadataContainer.

void SetPrivateMetadata

(

const BMetadata &

props

)

[inline]

Sets the private BMetadata associated with this BMetadataContainer.

This data is meant to be used internally by readers and writers. End-user applications that use these values should do so at their own risk.

Parameters:

props

The private BMetadata associated with this BMetadataContainer.

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.

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

---

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

• BMetadataContainer.h

---

GeoTranslate 5.0 From Blue Marble Geographics