Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

PHObjectHandle< BASE > Class Template Reference

A wrapper for a PHObject pointer. More...

#include <PHObjectHandle.h>

Inheritance diagram for PHObjectHandle< BASE >:

Inheritance graph
[legend]
Collaboration diagram for PHObjectHandle< BASE >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef BASE * pointer
typedef BASE & reference

Public Member Functions

 PHObjectHandle ()
 Default ctor. Internal pointer set to 0.

 PHObjectHandle (pointer ptr)
 Ctor specifying the underlying pointer.

 PHObjectHandle (const PHObjectHandle< BASE > &)
 Copy ctor.

PHObjectHandle< BASE > & operator= (const PHObjectHandle< BASE > &other)
 Assignement operator.

virtual ~PHObjectHandle ()
 Dtor.

bool operator! () const
 Returns true if pointer is 0.

bool operator() () const
 Returns true if pointer is non zero.

pointer operator-> () const
 Dereference operator.

reference operator * () const
 Dereference operator.

PHObjectHandle< BASE > * clone () const
 Virtual copy constructor.

PHObjectHandle< BASE > * create () const
 Virtual constructor.

pointer get () const
 Get the internal pointer.

virtual void identify (std::ostream &os=std::cout) const
 identify Function from PHObject

virtual int isValid () const
 isValid returns non zero if object contains vailid data

virtual void Reset ()
 Clear Event.

Detailed Description

template<typename BASE>
class PHObjectHandle< BASE >

A wrapper for a PHObject pointer.

So this object is a plain object, not a pointer, though it behaves like a pointer ;-)

Definition at line 16 of file PHObjectHandle.h.

Member Typedef Documentation

template<typename BASE>
typedef BASE* PHObjectHandle< BASE >::pointer
 

Definition at line 19 of file PHObjectHandle.h.

Referenced by PHObjectHandle< BASE >::PHObjectHandle().

template<typename BASE>
typedef BASE& PHObjectHandle< BASE >::reference
 

Definition at line 20 of file PHObjectHandle.h.

Constructor & Destructor Documentation

template<typename BASE>
PHObjectHandle< BASE >::PHObjectHandle (   ) 
 

Default ctor. Internal pointer set to 0.

Definition at line 87 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE >::PHObjectHandle (  pointer  ptr  ) 
 

Ctor specifying the underlying pointer.

Definition at line 93 of file PHObjectHandle.h.

References PHObjectHandle< BASE >::pointer.

template<typename BASE>
PHObjectHandle< BASE >::PHObjectHandle (  const PHObjectHandle< BASE > &   ) 
 

Copy ctor.

Definition at line 100 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE >::~PHObjectHandle (   )  [virtual]
 

Dtor.

Definition at line 130 of file PHObjectHandle.h.

Member Function Documentation

template<typename BASE>
PHObjectHandle<BASE>* PHObjectHandle< BASE >::clone (   )  const [inline, virtual]
 

Virtual copy constructor.

Reimplemented from PHObject.

Definition at line 50 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle<BASE>* PHObjectHandle< BASE >::create (   )  const [inline, virtual]
 

Virtual constructor.

Reimplemented from PHObject.

Definition at line 53 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE >::pointer PHObjectHandle< BASE >::get (   )  const
 

Get the internal pointer.

Definition at line 155 of file PHObjectHandle.h.

Referenced by PHObjectHandleVectorv2< BASE, DERIVED >::add(), and PHObjectHandleVectorv1< BASE, DERIVED >::add().

template<typename BASE>
void PHObjectHandle< BASE >::identify (  std::ostream &  os = std::cout  )  const [virtual]
 

identify Function from PHObject

Parameters:
os Output Stream

Reimplemented from PHObject.

Definition at line 163 of file PHObjectHandle.h.

template<typename BASE>
virtual int PHObjectHandle< BASE >::isValid (   )  const [inline, virtual]
 

isValid returns non zero if object contains vailid data

Reimplemented from PHObject.

Definition at line 60 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE >::reference PHObjectHandle< BASE >::operator * (   )  const
 

Dereference operator.

Definition at line 146 of file PHObjectHandle.h.

template<typename BASE>
bool PHObjectHandle< BASE >::operator! (   )  const [inline]
 

Returns true if pointer is 0.

Definition at line 38 of file PHObjectHandle.h.

template<typename BASE>
bool PHObjectHandle< BASE >::operator() (   )  const [inline]
 

Returns true if pointer is non zero.

Definition at line 41 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE >::pointer PHObjectHandle< BASE >::operator-> (   )  const
 

Dereference operator.

Definition at line 138 of file PHObjectHandle.h.

template<typename BASE>
PHObjectHandle< BASE > & PHObjectHandle< BASE >::operator= (  const PHObjectHandle< BASE > &  other  ) 
 

Assignement operator.

Definition at line 110 of file PHObjectHandle.h.

References PHObjectHandle< BASE >::copyTo().

template<typename BASE>
void PHObjectHandle< BASE >::Reset (   )  [virtual]
 

Clear Event.

Reimplemented from PHObject.

Definition at line 175 of file PHObjectHandle.h.

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