ot_interface Class Reference

OT_LIB interface class. More...

#include <ot_interface.h>

List of all members.

Public Member Functions
void	add (ot_interfaceElement *element)
void	remove (const string &elementName)
ot_interfaceElement *	get (const string &name)
void	callFuction (const string &functionName, const ot_obj &input, auto_ptr< ot_obj > &output)
void	addInterface (const string &interfaceName, OT_IE_ACCESS access)
void	removeInterface (const string &interfaceName)
ot_interface *	findInterface (const string &iPath)
const ot_map	dumpInterface (void)
void	setAccessMode (OT_IE_ACCESS access)
OT_IE_ACCESS	getAccessMode (void) const
const string	getInterfaceName (void) const
const string	getInterfacePath (void) const
void	clear (void)
	Clear interface, delete all attribures and sub-interfaces.
Private Member Functions
	ot_interface (const string &interfacePath, const string &interfaceName, OT_IE_ACCESS access=IE_PRIVATE)
	~ot_interface (void)
	Destructor.
Private Attributes
string	m_interfacePath
	The interface path.
string	m_interfaceName
	The interface name.
interfaceRepository	m_intRep
	Interface repository.
map< string, ot_interface * >	m_interfaceList
	Map of child interfaces.
OT_IE_ACCESS	m_access
	Access mode.
Friends
class	ot_functionManager

---

Detailed Description

OT_LIB interface class.

Interface class

---

Constructor & Destructor Documentation

ot_interface::ot_interface	(	const string &	interfacePath,
		const string &	interfaceName,
		OT_IE_ACCESS	access = IE_PRIVATE
	)			[private]

Contructor

Parameters:

	interfacePath	The interface path
	interfaceName	The interface name
	access	Interface access mode

ot_interface::~ot_interface

(

void

)

[private]

Destructor.

---

Member Function Documentation

void ot_interface::add

(

ot_interfaceElement *

element

)

Add a new element to the interface

Parameters:

ie

The new element

Returns:

True on success otherwise false

void ot_interface::remove

(

const string &

elementName

)

Remove an element from the interface

Parameters:

elementName

The element name

Returns:

True on success otherwise false

ot_interfaceElement* ot_interface::get

(

const string &

name

)

Get an elemento from interface

Parameters:

name

The element name

Returns:

The element or 0 if no element is found

void ot_interface::callFuction	(	const string &	functionName,
		const ot_obj &	input,
		auto_ptr< ot_obj > &	output
	)

Call a function registered in this interface

Parameters:

	functionName	The function name
	input	Input data
	output	Function output

Returns:

True on success otherwise false

void ot_interface::addInterface	(	const string &	interfaceName,
		OT_IE_ACCESS	access
	)

Add a new child interface

Parameters:

	interfaceName	The interface name
	access	Interface access mode

void ot_interface::removeInterface

(

const string &

interfaceName

)

Remove a registered interface

Parameters:

interfaceName

The interface name

Returns:

True pointer of a new interface or 0 on error

ot_interface* ot_interface::findInterface

(

const string &

iPath

)

Search a registered interface (from here including the child interfaces)

Parameters:

iPath

The interface Path

Returns:

True pointer of a find interface or 0 if no interface is found

const ot_map ot_interface::dumpInterface

(

void

)

Dump interface/function into a ot_seq (from this iterface)

Returns:

True interface/function data

void ot_interface::setAccessMode

(

OT_IE_ACCESS

access

)

Set the interface access mode

Parameters:

access

The new access mode

OT_IE_ACCESS ot_interface::getAccessMode

(

void

)

const

Get the interface access mode

Returns:

The access mode

const string ot_interface::getInterfaceName

(

void

)

const [inline]

Get the interface name

Returns:

The interface name

References m_interfaceName.

const string ot_interface::getInterfacePath

(

void

)

const [inline]

Get the interface path

Returns:

The interface path

References m_interfacePath.

void ot_interface::clear

(

void

)

Clear interface, delete all attribures and sub-interfaces.

---

Friends And Related Function Documentation

friend class ot_functionManager [friend]

---

Member Data Documentation

string ot_interface::m_interfacePath [private]

The interface path.

Referenced by getInterfacePath().

string ot_interface::m_interfaceName [private]

The interface name.

Referenced by getInterfaceName().

interfaceRepository ot_interface::m_intRep [private]

Interface repository.

map<string,ot_interface *> ot_interface::m_interfaceList [private]

Map of child interfaces.

OT_IE_ACCESS ot_interface::m_access [private]

Access mode.

---

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

• /mnt/USB_DISK/BUILD/prj_sf/otlib/trunk/include/interface/ot_interface.h