yarp::os::SharedLibraryClass< T > Class Template Reference

Container for an object created using a factory provided by a shared library. More...

#include <yarp/os/SharedLibraryClass.h>

Inheritance diagram for yarp::os::SharedLibraryClass< T >:

Public Member Functions
	SharedLibraryClass ()=default
	Constructor for empty instance.
	SharedLibraryClass (SharedLibraryClassFactory< T > &factory)
	Constructor for valid instance of a class from a shared library.
bool	open (SharedLibraryClassFactory< T > &factory)
	Construct an instance using the specified factory.
virtual bool	close ()
	Destroy an instance if one has been created.
virtual	~SharedLibraryClass ()
	Destructor.
T &	getContent ()
	Gives access to the created instance.
const T &	getContent () const
	Gives access to the created instance (const version).
bool	isValid () const
	Check whether a valid instance has been created.
T &	operator* ()
	Shorthand for SharedLibraryClass::getContent.
const T &	operator* () const
	Shorthand for SharedLibraryClass::getContent (const version)
T *	operator-> ()
	A pointer version of SharedLibraryClass::getContent.
const T *	operator-> () const
	A pointer version of SharedLibraryClass::getContent (const version)

Detailed Description

template<class T>
class yarp::os::SharedLibraryClass< T >

Container for an object created using a factory provided by a shared library.

Used to ensure the object is destroyed by a method also provided by the shared library. Mixing creation and destruction methods could be very bad.

Definition at line 20 of file SharedLibraryClass.h.

Constructor & Destructor Documentation

SharedLibraryClass() [1/2]

template<class T >

yarp::os::SharedLibraryClass< T >::SharedLibraryClass ( )

default

Constructor for empty instance.

SharedLibraryClass() [2/2]

template<class T >

yarp::os::SharedLibraryClass< T >::SharedLibraryClass ( SharedLibraryClassFactory< T > &  factory )

inline

Constructor for valid instance of a class from a shared library.

Parameters

factory

the factory to use to construct (and eventually destroy) the instance.

Definition at line 38 of file SharedLibraryClass.h.

~SharedLibraryClass()

template<class T >

virtual yarp::os::SharedLibraryClass< T >::~SharedLibraryClass ( )

inlinevirtual

Destructor.

Definition at line 86 of file SharedLibraryClass.h.

Member Function Documentation

close()

template<class T >

virtual bool yarp::os::SharedLibraryClass< T >::close ( )

inlinevirtual

Destroy an instance if one has been created.

Returns

true on success

Definition at line 66 of file SharedLibraryClass.h.

getContent() [1/2]

template<class T >

T & yarp::os::SharedLibraryClass< T >::getContent ( )

inline

Gives access to the created instance.

No check made to ensure an instance is in fact present. Call SharedLibraryClass::isValid first if unsure.

Returns

the created instance

Definition at line 99 of file SharedLibraryClass.h.

getContent() [2/2]

template<class T >

const T & yarp::os::SharedLibraryClass< T >::getContent ( ) const

inline

Gives access to the created instance (const version).

No check made to ensure an instance is in fact present. Call SharedLibraryClass::isValid first if unsure.

Returns

the created instance

Definition at line 112 of file SharedLibraryClass.h.

isValid()

template<class T >

bool yarp::os::SharedLibraryClass< T >::isValid ( ) const

inline

Check whether a valid instance has been created.

Returns

true iff a valid instance has been created

Definition at line 122 of file SharedLibraryClass.h.

open()

template<class T >

bool yarp::os::SharedLibraryClass< T >::open ( SharedLibraryClassFactory< T > &  factory )

inline

Construct an instance using the specified factory.

If an instance has already been made, it is destroyed.

Parameters

factory

the factory to use to construct (and eventually destroy) the instance.

Returns

true on success

Definition at line 51 of file SharedLibraryClass.h.

operator*() [1/2]

template<class T >

T & yarp::os::SharedLibraryClass< T >::operator* ( )

inline

Shorthand for SharedLibraryClass::getContent.

Returns

the created instance

Definition at line 132 of file SharedLibraryClass.h.

operator*() [2/2]

template<class T >

const T & yarp::os::SharedLibraryClass< T >::operator* ( ) const

inline

Shorthand for SharedLibraryClass::getContent (const version)

Returns

the created instance

Definition at line 142 of file SharedLibraryClass.h.

operator->() [1/2]

template<class T >

T * yarp::os::SharedLibraryClass< T >::operator-> ( )

inline

A pointer version of SharedLibraryClass::getContent.

Returns

a pointer to the created instance, or nullptr if there is none

Definition at line 153 of file SharedLibraryClass.h.

operator->() [2/2]

template<class T >

const T * yarp::os::SharedLibraryClass< T >::operator-> ( ) const

inline

A pointer version of SharedLibraryClass::getContent (const version)

Returns

a pointer to the created instance, or nullptr if there is none

Definition at line 164 of file SharedLibraryClass.h.

---

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

• src/libYARP_os/src/yarp/os/SharedLibraryClass.h