fe::PeerBase Class Reference
[Ferry Core library]

RAII for FeHandle* value. More...

Inheritance diagram for fe::PeerBase:

fe::EditorFacadePeerBase< nothrow >

List of all members.

Public Member Functions

FeHandle * getHandle () const
PeerBaseoperator= (const PeerBase &hw)
 PeerBase (const PeerBase &hw)
 PeerBase (FeHandle *handle, bool own)
 PeerBase ()
virtual ~PeerBase ()


Detailed Description

RAII for FeHandle* value.

Manages encapsulated handle of type FeHandle*. Class performs automatic reference counting for the encapsulated handle through calls to Fe_AddRef() and Fe_Release().


Constructor & Destructor Documentation

fe::PeerBase::PeerBase (  )  [inline]

Init encapsulated handle value with 0.

fe::PeerBase::PeerBase ( FeHandle *  handle,
bool  own 
) [inline]

Init encapsulated handle with the passed in value.

Parameters:
handle initial handle value; can be 0;
own indicates if the fe::PeerBase should call Fe_Release() on the passed in handle from fe::PeerBase::~PeerBase();

fe::PeerBase::PeerBase ( const PeerBase hw  )  [inline]

Init encapsulated handle with the hw.getHandle() value. Fe_AddRef() is called for the copied handle and Fe_Release() will be called on the handle from fe::PeerBase::~PeerBase().

Parameters:
hw object to copy handle from;

virtual fe::PeerBase::~PeerBase (  )  [inline, virtual]


Member Function Documentation

PeerBase& fe::PeerBase::operator= ( const PeerBase hw  )  [inline]

Init encapsulated handle with the hw.getHandle() value. Fe_AddRef() is called for the copied handle and Fe_Release() will be called on the handle from fe::PeerBase::~PeerBase().

Parameters:
hw object to copy handle from;

FeHandle* fe::PeerBase::getHandle (  )  const [inline]

Returns encapsulated handle.


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

Generated on Tue Nov 18 21:08:23 2008 for Ferry by doxygen 1.5.7.1
http://sourceforge.net