Playa::Handle< PointerType > Class Template Reference

#include <PlayaHandle.hpp>

List of all members.

Public Member Functions

 Handle ()
 Handle (const RCP< PointerType > &_ptr)
 Handle (Handleable< PointerType > *rawPtr)
const RCP< PointerType > & ptr () const
RCP< PointerType > & ptr ()
void print (std::ostream &os) const
std::string description () const
std::string fallbackDescription () const
int verb () const
void setVerb (int v)

Detailed Description

template<class PointerType>
class Playa::Handle< PointerType >

Class Playa::Handle provides a general implementation of the common features of reference-counted handles.

Definition at line 72 of file PlayaHandle.hpp.

Constructor & Destructor Documentation

template<class PointerType>
Playa::Handle< PointerType >::Handle (  )  [inline]

Empty ctor

Definition at line 76 of file PlayaHandle.hpp.

template<class PointerType>
Playa::Handle< PointerType >::Handle ( const RCP< PointerType > &  _ptr  )  [inline]

Construct from a smart pointer

Definition at line 79 of file PlayaHandle.hpp.

template<class PointerType>
Playa::Handle< PointerType >::Handle ( Handleable< PointerType > *  rawPtr  )  [inline]

Construct from a raw pointer to a Handleable.

Definition at line 82 of file PlayaHandle.hpp.

Member Function Documentation

template<class PointerType>
const RCP<PointerType>& Playa::Handle< PointerType >::ptr (  )  const [inline]

Read-only access to the underlying smart pointer.

Definition at line 85 of file PlayaHandle.hpp.

template<class PointerType>
RCP<PointerType>& Playa::Handle< PointerType >::ptr (  )  [inline]

Read-write access to the underlying smart pointer.

Definition at line 88 of file PlayaHandle.hpp.

template<class PointerType >
void Playa::Handle< PointerType >::print ( std::ostream &  os  )  const [inline]

Print to a stream. This tries to use, in order, the Printable, Describable, and fallback forms of output.

Reimplemented in Playa::Vector< Scalar >, and Playa::Vector< double >.

Definition at line 121 of file PlayaHandle.hpp.

template<class PointerType >
std::string Playa::Handle< PointerType >::description (  )  const [inline]

Return a short descriptive std::string using the Describable interface. If the contents of the handle cannot be downcasted or crosscasted to a Describable*, an exception will be thrown.

Reimplemented in Playa::Vector< Scalar >, and Playa::Vector< double >.

Definition at line 133 of file PlayaHandle.hpp.

template<class PointerType >
std::string Playa::Handle< PointerType >::fallbackDescription (  )  const [inline]

Write a fallback description to be used in objects that are neither named, printable, or describable

Definition at line 145 of file PlayaHandle.hpp.

template<class PointerType >
int Playa::Handle< PointerType >::verb (  )  const [inline]

Return the verbosity

Definition at line 159 of file PlayaHandle.hpp.

template<class PointerType >
void Playa::Handle< PointerType >::setVerb ( int  v  )  [inline]

Set the verbosity

Definition at line 170 of file PlayaHandle.hpp.

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