SH::SamplePtr Class Reference

A smart pointer class that holds a single Sample object. More...

#include <SamplePtr.h>

Collaboration diagram for SH::SamplePtr:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	SamplePtr ()
	standard constructor
	SamplePtr (Sample *val_sample)
	initializing constructor
	SamplePtr (std::unique_ptr< Sample > val_sample)
	initializing constructor
	SamplePtr (const SamplePtr &that)
	standard copy constructor
	SamplePtr (SamplePtr &&that)
	standard move constructor
	~SamplePtr ()
	standard destructor
SamplePtr &	operator= (const SamplePtr &that)
	standard assignment operator
SamplePtr &	operator= (SamplePtr &&that)
	standard move operator
bool	empty () const
	get() == 0
Sample *	get ()
	the sample itself
const Sample *	get () const
	the sample itself
Sample *	operator-> ()
	the sample itself
const Sample *	operator-> () const
	the sample itself
Sample &	operator* ()
	the sample itself
const Sample &	operator* () const
	the sample itself

Private Attributes
Sample *	m_sample
	the sample contained

Detailed Description

A smart pointer class that holds a single Sample object.

To avoid various memory management issues, samples are usually held via such a smart pointer. Since the reference count is internal to the Sample object it is safe to assign the same Sample to multiple smart pointers.

Rationale

This class is mostly to make SampleHandler independent of boost, otherwise I could have used boost::intrusive_ptr.

Definition at line 34 of file SamplePtr.h.

Constructor & Destructor Documentation

SamplePtr() [1/5]

SH::SamplePtr::SamplePtr

(

)

standard constructor

Guarantee

no-fail

Definition at line 36 of file SamplePtr.cxx.

    : m_sample (0)
  {
    RCU_NEW_INVARIANT (this);
  }

SamplePtr() [2/5]

SH::SamplePtr::SamplePtr

(

Sample *

val_sample

)

initializing constructor

Guarantee

no-fail

Definition at line 45 of file SamplePtr.cxx.

    : m_sample (val_sample)
  {
    if (m_sample)
      m_sample->alloc ();
 
    RCU_NEW_INVARIANT (this);
  }

SamplePtr() [3/5]

SH::SamplePtr::SamplePtr ( std::unique_ptr< Sample > val_sample )

explicit

initializing constructor

Guarantee

no-fail

Definition at line 57 of file SamplePtr.cxx.

    : SamplePtr (val_sample.release())
  {
    // no invariant used
  }

SamplePtr() [4/5]

SH::SamplePtr::SamplePtr

(

const SamplePtr &

that

)

standard copy constructor

Guarantee

no-fail

Definition at line 66 of file SamplePtr.cxx.

    : m_sample (that.m_sample)
  {
    if (m_sample)
      m_sample->alloc ();
 
    RCU_NEW_INVARIANT (this);
  }

SamplePtr() [5/5]

SH::SamplePtr::SamplePtr

(

SamplePtr &&

that

)

standard move constructor

Guarantee

no-fail

Definition at line 78 of file SamplePtr.cxx.

    : m_sample (that.m_sample)
  {
    that.m_sample = nullptr;
 
    RCU_NEW_INVARIANT (this);
  }

~SamplePtr()

SH::SamplePtr::~SamplePtr

(

)

standard destructor

Guarantee

no-fail

Definition at line 89 of file SamplePtr.cxx.

  {
    RCU_DESTROY_INVARIANT (this);
 
    if (m_sample)
      m_sample->release ();
  }

Member Function Documentation

empty()

bool SH::SamplePtr::empty

(

)

const

get() == 0

Returns

get() == 0

Guarantee

no-fail

Definition at line 131 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_sample == 0;
  }

get() [1/2]

Sample * SH::SamplePtr::get

(

)

the sample itself

Returns

the sample itself

Guarantee

no-fail

Definition at line 140 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_sample;
  }

get() [2/2]

const Sample * SH::SamplePtr::get

(

)

const

the sample itself

Returns

the sample itself

Guarantee

no-fail

Definition at line 148 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_sample;
  }

operator*() [1/2]

Sample & SH::SamplePtr::operator*

(

)

the sample itself

Returns

the sample itself

Guarantee

no-fail

Precondition

!empty()

Definition at line 177 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (!empty());
    return *m_sample;
  }

operator*() [2/2]

const Sample & SH::SamplePtr::operator*

(

)

const

the sample itself

Returns

the sample itself

Guarantee

no-fail

Precondition

!empty()

Definition at line 187 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (!empty());
    return *m_sample;
  }

operator->() [1/2]

Sample * SH::SamplePtr::operator->

(

)

the sample itself

Returns

the sample itself

Guarantee

no-fail

Precondition

!empty()

Definition at line 157 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (!empty());
    return m_sample;
  }

operator->() [2/2]

const Sample * SH::SamplePtr::operator->

(

)

const

the sample itself

Returns

the sample itself

Guarantee

no-fail

Precondition

!empty()

Definition at line 167 of file SamplePtr.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (!empty());
    return m_sample;
  }

operator=() [1/2]

SamplePtr & SH::SamplePtr::operator=

(

const SamplePtr &

that

)

standard assignment operator

Guarantee

no-fail

Definition at line 100 of file SamplePtr.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    RCU_READ_INVARIANT (&that);
 
    if (that.m_sample)
      that.m_sample->alloc ();
    if (m_sample)
      m_sample->release ();
    m_sample = that.m_sample;
    return *this;
  }

operator=() [2/2]

SamplePtr & SH::SamplePtr::operator=

(

SamplePtr &&

that

)

standard move operator

Guarantee

no-fail

Definition at line 116 of file SamplePtr.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    RCU_READ_INVARIANT (&that);
 
    if (m_sample)
      m_sample->release ();
    m_sample = that.m_sample;
    that.m_sample = nullptr;
    return *this;
  }

testInvariant()

void SH::SamplePtr::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Definition at line 29 of file SamplePtr.cxx.

  {
  }

Member Data Documentation

m_sample

Sample* SH::SamplePtr::m_sample

private

the sample contained

Definition at line 186 of file SamplePtr.h.

---

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

• SamplePtr.h
• SamplePtr.cxx