ComponentWrapper Class Reference

Wrapper class for components. More...

#include <ComponentWrapper.hpp>

Classes
struct	Implementation

Public Member Functions
	ComponentWrapper (const Handle< common::Component > &component)
	~ComponentWrapper ()
common::Component &	component ()
	Access to the wrapped component. More...
template<typename ComponentT >
ComponentT &	component ()
	Properly typed access to the wrapped component. More...
void	set_list_interface (PythonListInterface *interface)
PythonListInterface *	get_list_interface ()
	Get the curent list interface, or null if there is none. More...

Private Attributes
boost::shared_ptr< Implementation >	m_implementation

Friends
boost::python::object	wrap_component (const cf3::Handle< common::Component > &)
	Wrap the passed component in a python object. More...

Detailed Description

Wrapper class for components.

Definition at line 43 of file ComponentWrapper.hpp.

Constructor & Destructor Documentation

ComponentWrapper

(

const Handle< common::Component > &

component

)

Definition at line 207 of file ComponentWrapper.cpp.

~ComponentWrapper

(

)

Definition at line 218 of file ComponentWrapper.cpp.

Member Function Documentation

common::Component & component

(

)

Access to the wrapped component.

Definition at line 222 of file ComponentWrapper.cpp.

ComponentT& component ( )

inline

Properly typed access to the wrapped component.

Definition at line 54 of file ComponentWrapper.hpp.

PythonListInterface * get_list_interface

(

)

Get the curent list interface, or null if there is none.

Definition at line 238 of file ComponentWrapper.cpp.

void set_list_interface

(

PythonListInterface *

interface

)

Set the list interface to use. Takes ownership of the passed pointer. List interfaces are used to override the python [] operator for certain components, such as tables and lists

Definition at line 230 of file ComponentWrapper.cpp.

Friends And Related Function Documentation

boost::python::object wrap_component ( const cf3::Handle< common::Component > &  )

friend

Wrap the passed component in a python object.

Definition at line 243 of file ComponentWrapper.cpp.

Member Data Documentation

boost::shared_ptr<Implementation> m_implementation

private

Definition at line 73 of file ComponentWrapper.hpp.

---

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

• cf3/python/ComponentWrapper.hpp
• cf3/python/ComponentWrapper.cpp