neuray API Programmer's Manual

mi::base::Interface_implement< I> Template Class Reference

[Interface Framework Technology]

template< class I>

class mi::base::Interface_implement< I>

Description

Mixin class template for deriving interface implementations. mi::base::Interface_implement is a mixin class template that allows you to derive interface class implementations easily. It provides you with the full implementation of reference counting and the mi::base::IInterface::get_interface( const Uuid&) method. It requires that you used interfaces derived from the corresponding mixin class template mi::base::Interface_declare.

mi::base::Interface_implement is derived from the interface I.

Include File:

#include <mi/base/interface_implement.h>

Public Constructors

 Interface_implement( Uint32 initial = 1)
Constructor. More...
 Interface_implement( const Interface_implement < I >& other)
Copy constructor. More...

Public Member Functions

Uuid get_iid() const
Returns the interface ID of the most derived interface.
virtual const IInterfaceget_interface( const Uuid& interface_id) const
Acquires a const interface. More...
virtual IInterfaceget_interface( const Uuid& interface_id)
Acquires a mutable interface. More...
Interface_implement < I >& operator=( const Interface_implement < I >& other)
Assignment operator. More...
virtual Uint32 release() const
Decrements the reference count. More...
virtual Uint32 retain() const
Increments the reference count. More...

Constructors

mi::base::Interface_implement< I>::Interface_implement( Uint32 initial = 1) [inline]

Constructor.

Parameters

initial
The initial reference count (defaults to 1).
mi::base::Interface_implement< I>::Interface_implement( const Interface_implement < I >& other) [inline]

Copy constructor. Initializes the reference count to 1.

Member Functions

Uuid mi::base::Interface_implement< I>::get_iid() const [inline]

Returns the interface ID of the most derived interface.

virtual const IInterface* mi::base::Interface_implement< I>::get_interface( const Uuid& interface_id) const [inline, virtual]

Acquires a const interface. If this interface is derived from or is the interface with the passed interface_id, then return a non-NULL const mi::base::IInterface* that can be casted via static_cast to an interface pointer of the interface type corresponding to the passed interface_id. Otherwise return NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

virtual IInterface* mi::base::Interface_implement< I>::get_interface( const Uuid& interface_id) [inline, virtual]

Acquires a mutable interface. If this interface is derived from or is the interface with the passed interface_id, then return a non-NULL mi::base::IInterface* that can be casted via static_cast to an interface pointer of the interface type corresponding to the passed interface_id. Otherwise return NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

Interface_implement < I >& mi::base::Interface_implement< I>::operator=( const Interface_implement < I >& other) [inline]

Assignment operator. The reference count of *this and other remain unchanged.

virtual Uint32 mi::base::Interface_implement< I>::release() const [inline, virtual]

Decrements the reference count. Decrements the reference count of the object referenced through this interface and returns the new reference count. If the reference count dropped to zero, the object will be deleted. The operation is thread-safe.

virtual Uint32 mi::base::Interface_implement< I>::retain() const [inline, virtual]

Increments the reference count. Increments the reference count of the object referenced through this interface and returns the new reference count. The operation is thread-safe.