BDynamicLib Class Reference

#include <BDynamicLib.h>

List of all members.

---

Detailed Description

An interface for managing a dynamic library (Windows DLL, Linux SO, etc).

Public Member Functions
	BDynamicLib (const BString path, EDynamicLibType type, const BString dataTypes)
	Constructor.
	BDynamicLib (const BString path, EDynamicLibType type)
	Constructor.
virtual BDataManagerProxy *	GetDataManagerProxy (void)
	Gets the BDataManagerProxy object for this dynamic library.
virtual BDirectTransformerProxy *	GetDirectTransformerProxy (void)
	Get the BDirectTransformerProxy object for this dynamic library.
const BString &	GetPath (void)
	Gets the path to the dynamic library.
EDynamicLibType	GetType (void)
	Gets the dynamic library type.
virtual bool	IsLoaded (void) const
	Indicates whether or not this dynamic library is currently loaded into memory.
virtual bool	Load (void)
	Loads the current dynamic library into memory.
bool	SupportsDataType (const BString &dataType) const
	Indicates whether or not the library supports the specified data type.
bool	SupportsNamedDataTypes (void) const
	Indicates whether or not the library supports any specific data types.
virtual void	Unload (void)
	Removes the current dynamic libarary from memory.
virtual	~BDynamicLib ()
	Destructor.
Protected Member Functions
	BDynamicLib ()
	Default constructor.
Protected Attributes
BDynamicLibCore *	m_pCore
	The core object containing the OS-specific implementation for this class.
BStringVector	m_supportedDataTypes
	The data types supported by this library.

---

Constructor & Destructor Documentation

BDynamicLib	(	const BString	path,
		EDynamicLibType	type
	)			[inline]

Constructor.

Parameters:

	path	The full path to the dynamic library.
	type	The type of library (reader, writer, etc).

BDynamicLib	(	const BString	path,
		EDynamicLibType	type,
		const BString	dataTypes
	)			[inline]

Constructor.

Parameters:

	path	The full path to the dynamic library.
	type	The type of library (reader, writer, etc).
	dataTypes	A formatted string containing the data type(s) supported by this dynamic library. Each data type must be separated by a slash, as in "DWG/DXF".

virtual ~BDynamicLib

(

)

[inline, virtual]

Destructor.

BDynamicLib

(

)

[inline, protected]

Default constructor.

This constructor is hidden to prevent its use.

---

Member Function Documentation

virtual BDataManagerProxy* GetDataManagerProxy

(

void

)

[inline, virtual]

Gets the BDataManagerProxy object for this dynamic library.

Returns:

The BDataManagerProxy object for this dynamic library.

virtual BDirectTransformerProxy* GetDirectTransformerProxy

(

void

)

[inline, virtual]

Get the BDirectTransformerProxy object for this dynamic library.

Returns:

The BDirectTransformerProxy object for this dynamic library.

const BString& GetPath

(

void

)

[inline]

Gets the path to the dynamic library.

Returns:

The path to the dynamic library.

EDynamicLibType GetType

(

void

)

[inline]

Gets the dynamic library type.

Returns:

The dynamic library type.

virtual bool IsLoaded

(

void

)

const [inline, virtual]

Indicates whether or not this dynamic library is currently loaded into memory.

Returns:

True if the library is loaded and false otherwise.

virtual bool Load

(

void

)

[inline, virtual]

Loads the current dynamic library into memory.

Returns:

True if the load succeeds and false otherwise.

bool SupportsDataType

(

const BString &

dataType

)

const [inline]

Indicates whether or not the library supports the specified data type.

Parameters:

dataType

The data type.

Returns:

True if the library supports the data type and false otherwise.

bool SupportsNamedDataTypes

(

void

)

const [inline]

Indicates whether or not the library supports any specific data types.

Returns:

True if the library supports one or more specific data types and false otherwise.

virtual void Unload

(

void

)

[inline, virtual]

Removes the current dynamic libarary from memory.

Returns:

True if the unload succeeds and false otherwise.

---

Member Data Documentation

BDynamicLibCore* m_pCore [protected]

The core object containing the OS-specific implementation for this class.

BStringVector m_supportedDataTypes [protected]

The data types supported by this library.

---

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

• BDynamicLib.h

---

GeoTranslate 5.0 From Blue Marble Geographics