CEPS: ceps::HoldsAttributes Class Reference

Detailed Description

An abstract class from which all objects that contain region attributes should derive.

Definition at line 41 of file HoldsAttributes.hpp.

#include <HoldsAttributes.hpp>

Inheritance diagram for ceps::HoldsAttributes:

Public Member Functions
	HoldsAttributes (const CepsSet< CepsAttribute > &attributes)
	Constructor with any number of attributes. More...

	HoldsAttributes (const CepsVector< CepsAttribute > &attributes)
	Constructor with any number of attributes. More...

	HoldsAttributes (CepsAttribute *attributes, const CepsUInt &n)
	Constructor with any number of attributes. More...

	HoldsAttributes ()=default
	Default constructor. More...

	HoldsAttributes (const HoldsAttributes &)=default
	Assignement operator. More...

	HoldsAttributes (HoldsAttributes &&) noexcept=default
	Copy constructor. More...

virtual	~HoldsAttributes ()=default
	Destructor. More...

HoldsAttributes &	operator= (const HoldsAttributes &)=default
	Assignment operator. More...

HoldsAttributes &	operator= (HoldsAttributes &&) noexcept=default
	Assignment operator. More...

CepsUInt	getNumberOfAttributes () const
	Returns number of attributes of the entity. More...

CepsSet< CepsAttribute > &	getAttributes ()
	Returns the attributes of the entity. More...

const CepsSet< CepsAttribute > &	getAttributes () const
	Returns the attributes of the entity, const version. More...

void	setAttributes (const CepsVector< CepsAttribute > &attributes)
	Sets the attributes of the entity. More...

void	setAttributes (const CepsSet< CepsAttribute > &attributes)
	Sets the attributes of the entity. More...

void	setAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Sets the attributes of the entity. More...

template<class _It >
void	setAttributes (_It first, _It last)
	Sets the attributes of the entity. More...

void	addAttribute (const CepsAttribute &name)
	Adds an attribute to the entity. More...

void	addAttributes (const CepsVector< CepsAttribute > &attributes)
	Adds several attributes to the entity. More...

void	addAttributes (const CepsSet< CepsAttribute > &attributes)
	Adds several attributes to the entity. More...

void	addAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Adds several attributes to the entity. More...

template<class _It >
void	addAttributes (_It first, _It last)
	Adds several attributes to the entity. More...

void	removeAttribute (const CepsAttribute &name)
	Removes an attribute from the entity. More...

void	removeAttributes (const CepsSet< CepsAttribute > &attributes)
	Removes several attributes from the entity. More...

void	removeAttributes (const CepsVector< CepsAttribute > &attributes)
	Removes several attributes from the entity. More...

void	removeAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Removes several attributes from the entity. More...

template<class _It >
void	removeAttributes (_It first, _It last)
	Removes several attributes from the entity. More...

void	clearAttributes ()
	Removes all attributes from the entity. More...

CepsBool	hasAttribute (const CepsAttribute &name) const
	Tells if the entity has the attribute in argument. More...

CepsBool	hasAllAttributes (const CepsVector< CepsAttribute > &attributes) const
	Tells if the entity has all the attributes in argument. More...

CepsBool	hasAllAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
	Tells if the entity has all the attributes in argument. More...

template<class _It >
CepsBool	hasAllAttributes (_It first, _It last) const
	Tells if the entity has all the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsSet< CepsAttribute > &attributes) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsVector< CepsAttribute > &attributes) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
	Tells if the entity has one of the attributes in argument. More...

template<class _It >
CepsBool	hasOneOfAttributes (_It first, _It last) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasUniversalAttribute () const
	Detect if the current entity has the attribute universal. More...

void	reset ()
	Equivalent to HoldsAttributes::clear() More...

Protected Attributes
CepsSet< CepsAttribute >	m_attributes
	The attributes held by the entity. More...

Constructor & Destructor Documentation

◆ HoldsAttributes() [1/6]

ceps::HoldsAttributes::HoldsAttributes ( const CepsSet< CepsAttribute > & attributes )

explicit

Constructor with any number of attributes.

Definition at line 33 of file HoldsAttributes.cpp.

◆ HoldsAttributes() [2/6]

ceps::HoldsAttributes::HoldsAttributes ( const CepsVector< CepsAttribute > & attributes )

explicit

Constructor with any number of attributes.

Definition at line 37 of file HoldsAttributes.cpp.

◆ HoldsAttributes() [3/6]

ceps::HoldsAttributes::HoldsAttributes	(	CepsAttribute *	attributes,
		const CepsUInt &	n
	)

Constructor with any number of attributes.

Definition at line 43 of file HoldsAttributes.cpp.

◆ HoldsAttributes() [4/6]

ceps::HoldsAttributes::HoldsAttributes ( )

default

Default constructor.

◆ HoldsAttributes() [5/6]

ceps::HoldsAttributes::HoldsAttributes ( const HoldsAttributes & )

default

Assignement operator.

◆ HoldsAttributes() [6/6]

ceps::HoldsAttributes::HoldsAttributes ( HoldsAttributes && )

defaultnoexcept

Copy constructor.

◆ ~HoldsAttributes()

virtual ceps::HoldsAttributes::~HoldsAttributes ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addAttribute()

void ceps::HoldsAttributes::addAttribute ( const CepsAttribute & name )

Adds an attribute to the entity.

Definition at line 86 of file HoldsAttributes.cpp.

◆ addAttributes() [1/4]

template<class _It >

void ceps::HoldsAttributes::addAttributes	(	_It	first,
		_It	last
	)

inline

Adds several attributes to the entity.

Definition at line 127 of file HoldsAttributes.hpp.

◆ addAttributes() [2/4]

void ceps::HoldsAttributes::addAttributes	(	const CepsAttribute *	attributes,
		const CepsUInt &	n
	)

Adds several attributes to the entity.

Definition at line 105 of file HoldsAttributes.cpp.

◆ addAttributes() [3/4]

void ceps::HoldsAttributes::addAttributes ( const CepsSet< CepsAttribute > & attributes )

Adds several attributes to the entity.

Definition at line 99 of file HoldsAttributes.cpp.

◆ addAttributes() [4/4]

void ceps::HoldsAttributes::addAttributes ( const CepsVector< CepsAttribute > & attributes )

Adds several attributes to the entity.

Definition at line 93 of file HoldsAttributes.cpp.

◆ clearAttributes()

void ceps::HoldsAttributes::clearAttributes ( )

Removes all attributes from the entity.

Definition at line 136 of file HoldsAttributes.cpp.

◆ getAttributes() [1/2]

CepsSet< CepsAttribute > & ceps::HoldsAttributes::getAttributes ( )

Returns the attributes of the entity.

Definition at line 56 of file HoldsAttributes.cpp.

◆ getAttributes() [2/2]

const CepsSet< CepsAttribute > & ceps::HoldsAttributes::getAttributes ( ) const

Returns the attributes of the entity, const version.

Definition at line 62 of file HoldsAttributes.cpp.

◆ getNumberOfAttributes()

CepsUInt ceps::HoldsAttributes::getNumberOfAttributes ( ) const

Returns number of attributes of the entity.

Definition at line 50 of file HoldsAttributes.cpp.

◆ hasAllAttributes() [1/3]

template<class _It >

CepsBool ceps::HoldsAttributes::hasAllAttributes	(	_It	first,
		_It	last
	)		const

inline

Tells if the entity has all the attributes in argument.

Definition at line 185 of file HoldsAttributes.hpp.

◆ hasAllAttributes() [2/3]

CepsBool ceps::HoldsAttributes::hasAllAttributes	(	const CepsAttribute *	attributes,
		const CepsUInt &	n
	)		const

Tells if the entity has all the attributes in argument.

Definition at line 155 of file HoldsAttributes.cpp.

◆ hasAllAttributes() [3/3]

CepsBool ceps::HoldsAttributes::hasAllAttributes ( const CepsVector< CepsAttribute > & attributes ) const

Tells if the entity has all the attributes in argument.

Definition at line 149 of file HoldsAttributes.cpp.

◆ hasAttribute()

CepsBool ceps::HoldsAttributes::hasAttribute ( const CepsAttribute & name ) const

Tells if the entity has the attribute in argument.

Definition at line 143 of file HoldsAttributes.cpp.

◆ hasOneOfAttributes() [1/4]

template<class _It >

CepsBool ceps::HoldsAttributes::hasOneOfAttributes	(	_It	first,
		_It	last
	)		const

inline

Tells if the entity has one of the attributes in argument.

Definition at line 211 of file HoldsAttributes.hpp.

◆ hasOneOfAttributes() [2/4]

CepsBool ceps::HoldsAttributes::hasOneOfAttributes	(	const CepsAttribute *	attributes,
		const CepsUInt &	n
	)		const

Tells if the entity has one of the attributes in argument.

Definition at line 173 of file HoldsAttributes.cpp.

◆ hasOneOfAttributes() [3/4]

CepsBool ceps::HoldsAttributes::hasOneOfAttributes ( const CepsSet< CepsAttribute > & attributes ) const

Tells if the entity has one of the attributes in argument.

Definition at line 161 of file HoldsAttributes.cpp.

◆ hasOneOfAttributes() [4/4]

CepsBool ceps::HoldsAttributes::hasOneOfAttributes ( const CepsVector< CepsAttribute > & attributes ) const

Tells if the entity has one of the attributes in argument.

Definition at line 167 of file HoldsAttributes.cpp.

◆ hasUniversalAttribute()

CepsBool ceps::HoldsAttributes::hasUniversalAttribute ( ) const

Detect if the current entity has the attribute universal.

Definition at line 179 of file HoldsAttributes.cpp.

◆ operator=() [1/2]

HoldsAttributes& ceps::HoldsAttributes::operator= ( const HoldsAttributes & )

default

Assignment operator.

◆ operator=() [2/2]

HoldsAttributes& ceps::HoldsAttributes::operator= ( HoldsAttributes && )

defaultnoexcept

Assignment operator.

◆ removeAttribute()

void ceps::HoldsAttributes::removeAttribute ( const CepsAttribute & name )

Removes an attribute from the entity.

Definition at line 111 of file HoldsAttributes.cpp.

◆ removeAttributes() [1/4]

template<class _It >

void ceps::HoldsAttributes::removeAttributes	(	_It	first,
		_It	last
	)

inline

Removes several attributes from the entity.

Definition at line 156 of file HoldsAttributes.hpp.

◆ removeAttributes() [2/4]

void ceps::HoldsAttributes::removeAttributes	(	const CepsAttribute *	attributes,
		const CepsUInt &	n
	)

Removes several attributes from the entity.

Definition at line 130 of file HoldsAttributes.cpp.

◆ removeAttributes() [3/4]

void ceps::HoldsAttributes::removeAttributes ( const CepsSet< CepsAttribute > & attributes )

Removes several attributes from the entity.

Definition at line 118 of file HoldsAttributes.cpp.

◆ removeAttributes() [4/4]

void ceps::HoldsAttributes::removeAttributes ( const CepsVector< CepsAttribute > & attributes )

Removes several attributes from the entity.

Definition at line 124 of file HoldsAttributes.cpp.

◆ reset()

void ceps::HoldsAttributes::reset ( )

Equivalent to HoldsAttributes::clear()

Definition at line 185 of file HoldsAttributes.cpp.

◆ setAttributes() [1/4]

template<class _It >

void ceps::HoldsAttributes::setAttributes	(	_It	first,
		_It	last
	)

inline

Sets the attributes of the entity.

Definition at line 102 of file HoldsAttributes.hpp.

◆ setAttributes() [2/4]

void ceps::HoldsAttributes::setAttributes	(	const CepsAttribute *	attributes,
		const CepsUInt &	n
	)

Sets the attributes of the entity.

Definition at line 80 of file HoldsAttributes.cpp.

◆ setAttributes() [3/4]

void ceps::HoldsAttributes::setAttributes ( const CepsSet< CepsAttribute > & attributes )

Sets the attributes of the entity.

Definition at line 74 of file HoldsAttributes.cpp.

◆ setAttributes() [4/4]

void ceps::HoldsAttributes::setAttributes ( const CepsVector< CepsAttribute > & attributes )

Sets the attributes of the entity.

Definition at line 68 of file HoldsAttributes.cpp.

Field Documentation

◆ m_attributes

CepsSet<CepsAttribute> ceps::HoldsAttributes::m_attributes

protected

The attributes held by the entity.

Definition at line 234 of file HoldsAttributes.hpp.

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

/builds/xxjFYZX3/0/carmen/ceps/src/common/abstract/HoldsAttributes.hpp
/builds/xxjFYZX3/0/carmen/ceps/src/common/abstract/HoldsAttributes.cpp

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ HoldsAttributes() [1/6]

◆ HoldsAttributes() [2/6]

◆ HoldsAttributes() [3/6]

◆ HoldsAttributes() [4/6]

◆ HoldsAttributes() [5/6]

◆ HoldsAttributes() [6/6]

◆ ~HoldsAttributes()

Member Function Documentation

◆ addAttribute()

◆ addAttributes() [1/4]

◆ addAttributes() [2/4]

◆ addAttributes() [3/4]

◆ addAttributes() [4/4]

◆ clearAttributes()

◆ getAttributes() [1/2]

◆ getAttributes() [2/2]

◆ getNumberOfAttributes()

◆ hasAllAttributes() [1/3]

◆ hasAllAttributes() [2/3]

◆ hasAllAttributes() [3/3]

◆ hasAttribute()

◆ hasOneOfAttributes() [1/4]

◆ hasOneOfAttributes() [2/4]

◆ hasOneOfAttributes() [3/4]

◆ hasOneOfAttributes() [4/4]

◆ hasUniversalAttribute()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeAttribute()

◆ removeAttributes() [1/4]

◆ removeAttributes() [2/4]

◆ removeAttributes() [3/4]

◆ removeAttributes() [4/4]

◆ reset()

◆ setAttributes() [1/4]

◆ setAttributes() [2/4]

◆ setAttributes() [3/4]

◆ setAttributes() [4/4]

Field Documentation

◆ m_attributes