smash::ParticleTypePtr Class Reference

#include <particletype.h>

A pointer-like interface to global references to ParticleType objects.

See also

ParticleType::operator&

Definition at line 679 of file particletype.h.

Public Member Functions
const ParticleType &	operator* () const
const ParticleType *	operator-> () const
	ParticleTypePtr ()=default
	Default construction initializes with an invalid index. More...
bool	operator== (const ParticleTypePtr &rhs) const
bool	operator!= (const ParticleTypePtr &rhs) const
bool	operator< (const ParticleTypePtr &rhs) const
	"Less than" operator More...
	operator bool () const

Private Member Functions
	ParticleTypePtr (std::uint16_t i)
	Constructs a pointer to the ParticleType object at offset i. More...
const ParticleType &	lookup () const
	Helper function that does the ParticleType lookup from the stored index. More...

Private Attributes
std::uint16_t	index_ = 0xffff
	Stores the index of the references ParticleType object in the global vector. More...

Friends
ParticleTypePtr	ParticleType::operator& () const
	ParticleType::operator& is a friend in order to call the constructor. More...

Constructor & Destructor Documentation

ParticleTypePtr() [1/2]

smash::ParticleTypePtr::ParticleTypePtr ( )

default

Default construction initializes with an invalid index.

ParticleTypePtr() [2/2]

smash::ParticleTypePtr::ParticleTypePtr ( std::uint16_t  i )

inlineexplicitprivate

Constructs a pointer to the ParticleType object at offset i.

Parameters

[in]

i

the offset where to create.

Definition at line 734 of file particletype.h.

: index_(i) {}

Member Function Documentation

operator*()

const ParticleType& smash::ParticleTypePtr::operator* ( ) const

inline

Returns

Dereferences the pointer and returns the ParticleType object.

Definition at line 682 of file particletype.h.

{ return lookup(); }

operator->()

const ParticleType* smash::ParticleTypePtr::operator-> ( ) const

inline

Returns

Dereferences the pointer and returns the ParticleType object.

Definition at line 685 of file particletype.h.

                                         {
    // this requires std::addressof because &lookup() would call
    // ParticleType::operator& and return ParticleTypePtr again
    return std::addressof(lookup());
  }

operator==()

bool smash::ParticleTypePtr::operator== ( const ParticleTypePtr &  rhs ) const

inline

Parameters

[in]

rhs

the ParticleTypePtr to compare to

Returns

whether the two objects reference the same ParticleType object.

Definition at line 698 of file particletype.h.

                                                    {
    return index_ == rhs.index_;
  }

operator!=()

bool smash::ParticleTypePtr::operator!= ( const ParticleTypePtr &  rhs ) const

inline

Parameters

[in]

rhs

the ParticleTypePtr to compare to

Returns

whether the two objects reference different ParticleType objects.

Definition at line 706 of file particletype.h.

                                                    {
    return index_ != rhs.index_;
  }

operator<()

bool smash::ParticleTypePtr::operator< ( const ParticleTypePtr &  rhs ) const

inline

"Less than" operator

Parameters

[in]

rhs

the ParticleTypePtr to compare to

Returns

whether the index is smaller than rhs' index.

Definition at line 715 of file particletype.h.

                                                   {
    return index_ < rhs.index_;
  }

operator bool()

smash::ParticleTypePtr::operator bool ( ) const

inline

Returns

whether the objects stores a valid ParticleType reference.

Definition at line 720 of file particletype.h.

{ return index_ != 0xffff; }

lookup()

const ParticleType& smash::ParticleTypePtr::lookup ( ) const

inlineprivate

Helper function that does the ParticleType lookup from the stored index.

Implementation:

In debug builds this function asserts that the index is valid. It then asks for the vector of all ParticleType objects (ParticleType::list_all) and uses vector::operator[] to return an lvalue reference to the ParticleType object at the offset index_.

Returns

a reference to the ParticleType object at offset index_.

Definition at line 747 of file particletype.h.

                                     {
    assert(index_ != 0xffff);
    return ParticleType::list_all()[index_];
  }

Friends And Related Function Documentation

ParticleType::operator&

ParticleTypePtr ParticleType::operator& ( ) const

friend

ParticleType::operator& is a friend in order to call the constructor.

Returns

the pointer to a ParticleType

Member Data Documentation

index_

std::uint16_t smash::ParticleTypePtr::index_ = 0xffff

private

Stores the index of the references ParticleType object in the global vector.

The value 0xffff is used to denote an invalid index (similar to a null pointer).

Definition at line 757 of file particletype.h.

---

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

• src/include/smash/particletype.h