LibCarna::base::Aggregation< AssociatedObjectType > Class Template Reference

Represents an aggregation, i.e. a weak reference. More...

#include <Aggregation.hpp>

Inheritance diagram for LibCarna::base::Aggregation< AssociatedObjectType >:

Collaboration diagram for LibCarna::base::Aggregation< AssociatedObjectType >:

Public Member Functions
	Aggregation (AssociatedObjectType &associatedObject)
	Instantiates.
	Aggregation (const Aggregation< AssociatedObjectType > &other)
	Copies reference from other.
Public Member Functions inherited from LibCarna::base::Association< AssociatedObjectType >
virtual	~Association ()
	Does nothing.
AssociatedObjectType *	get () const
	Returns raw pointer to the referenced object.
AssociatedObjectType *	operator-> () const
AssociatedObjectType &	operator* () const
	Returns raw reference to the referenced object.
	operator bool () const
	Tells whether any object is referenced by this association.
void	forget ()
	Makes this association forget it's referenced object.

Static Public Member Functions
static Aggregation< AssociatedObjectType >	createNullPtr ()
	Creates instance of this class template that behaves like a nullptr pointer. For internal usage only. Use NULL_PTR instead.

Static Public Attributes
static const Aggregation< AssociatedObjectType >	NULL_PTR
	Holds instance of this class template that behaves like a nullptr pointer.

Additional Inherited Members
Protected Member Functions inherited from LibCarna::base::Association< AssociatedObjectType >
	Association (AssociatedObjectType *associatedObject=nullptr)
	Instantiates.
Related Symbols inherited from LibCarna::base::Association< AssociatedObjectType >
template<typename AssociatedObjectType >
bool	operator== (const LibCarna::base::Association< AssociatedObjectType > &l, const LibCarna::base::Association< AssociatedObjectType > &r)
	Tells whether l and r do reference the same object, that may be nullptr.

Detailed Description

template<typename AssociatedObjectType>
class LibCarna::base::Aggregation< AssociatedObjectType >

Represents an aggregation, i.e. a weak reference.

Author

Leonid Kostrykin

Definition at line 43 of file Aggregation.hpp.

Constructor & Destructor Documentation

Aggregation() [1/2]

template<typename AssociatedObjectType >

LibCarna::base::Aggregation< AssociatedObjectType >::Aggregation ( AssociatedObjectType &  associatedObject )

inlineexplicit

Instantiates.

Definition at line 70 of file Aggregation.hpp.

Aggregation() [2/2]

template<typename AssociatedObjectType >

LibCarna::base::Aggregation< AssociatedObjectType >::Aggregation ( const Aggregation< AssociatedObjectType > &  other )

inline

Copies reference from other.

Definition at line 78 of file Aggregation.hpp.

Member Function Documentation

createNullPtr()

template<typename AssociatedObjectType >

static Aggregation< AssociatedObjectType > LibCarna::base::Aggregation< AssociatedObjectType >::createNullPtr ( )

inlinestatic

Creates instance of this class template that behaves like a nullptr pointer. For internal usage only. Use NULL_PTR instead.

Definition at line 62 of file Aggregation.hpp.

Member Data Documentation

NULL_PTR

template<typename AssociatedObjectType >

const Aggregation< AssociatedObjectType > LibCarna::base::Aggregation< AssociatedObjectType >::NULL_PTR

static

Holds instance of this class template that behaves like a nullptr pointer.

Definition at line 56 of file Aggregation.hpp.

---

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

• include/LibCarna/base/Aggregation.hpp