GEO::Attribute< bool > Class Reference

Specialization of Attribute for booleans. More...

#include <geogram/basic/attributes.h>

Inheritance diagram for GEO::Attribute< bool >:

Classes
class	BoolAttributeAccessor
	Accessor class for adapting Attribute<bool> indexing. More...
class	ConstBoolAttributeAccessor
	Accessor class for adapting Attribute<bool> indexing. More...

Public Types
typedef AttributeBase< Numeric::uint8 >	superclass

Public Member Functions
	Attribute (AttributesManager &manager, const std::string &name)
BoolAttributeAccessor	operator[] (index_t i)
ConstBoolAttributeAccessor	operator[] (index_t i) const
void	fill (bool val)
	Sets all the elements in this attribute to a specified value.
void	copy (const Attribute< bool > &rhs)
	Copies all the values from another attribute.
Public Member Functions inherited from GEO::AttributeBase< Numeric::uint8 >
	AttributeBase ()
	Creates an uninitialized (unbound) Attribute.
	AttributeBase (AttributesManager &manager, const std::string &name)
	Creates or retrieves a persistent attribute attached to a given AttributesManager.
bool	is_bound () const
	Tests whether an Attribute is bound.
void	unbind ()
	Unbinds this Attribute.
void	bind (AttributesManager &manager, const std::string &name)
	Binds this Attribute to an AttributesManager.
bool	bind_if_is_defined (AttributesManager &manager, const std::string &name)
	Binds this Attribute to an AttributesManager if it already exists in the AttributesManager.
bool	bind_if_is_compatible (AttributesManager &manager, const std::string &name)
	Binds this Attribute to an AttributesManager if it already exists in the AttributesManager and types are compatible.
void	create_vector_attribute (AttributesManager &manager, const std::string &name, index_t dimension)
	Creates and binds a new vector attribute.
void	destroy ()
	Destroys this attribute in the AttributesManager.
void	redim (index_t new_dim)
	Sets the dimension.
	~AttributeBase ()
	Attribute destructor.
index_t	size () const
	Gets the size.
void	zero ()
	Sets all the elements of this Attribute to zero.
bool	can_get_vector ()
	Tests whether get_vector() can be called on this Attribute.
vector< Numeric::uint8 > &	get_vector ()
	Gets a reference to the internal vector<T> used to store the attribute.
const vector< Numeric::uint8 > &	get_vector () const
	Gets a const reference to the internal vector<T> used to store the attribute.
AttributesManager *	manager () const
	Gets the AttributesManager this Attribute is bound to.
Public Member Functions inherited from GEO::AttributeStoreObserver
	AttributeStoreObserver ()
	Creates a new uninitialied AttributeStore.
void	notify (Memory::pointer base_addr, index_t size, index_t dim)
	Callback function, called by the AttributeStore whenever it is modified.
index_t	size () const
	Gets the size.
index_t	dimension () const
	Gets the dimension.
index_t	nb_elements () const
	Gets the total number of elements.
Memory::pointer	base_addr () const
	Gets a pointer to the storage.
void	register_me (AttributeStore *store)
	Registers this observer to an AttributeStore.
void	unregister_me (AttributeStore *store)
	Unregisters this observer from an AttributeStore.
void	disconnect ()
	Disconnects this AttributeStoreObserver from its AttributeStore.
bool	disconnected () const
	Tests whether this AttributeStoreObserver was disconnected.

Protected Member Functions
Numeric::uint8 &	element (index_t i)
	Gets a modifiable element by index.
const Numeric::uint8 &	element (index_t i) const
	Gets an element by index.

Friends
class	BoolAttributeAccessor
class	ConstBoolAttributeAccessor

Additional Inherited Members
Static Public Member Functions inherited from GEO::AttributeBase< Numeric::uint8 >
static bool	is_defined (AttributesManager &manager, const std::string &name, index_t dim=0)
	Tests whether an attribute with the specified name and with corresponding type exists in an AttributesManager.
Protected Attributes inherited from GEO::AttributeBase< Numeric::uint8 >
AttributesManager *	manager_
AttributeStore *	store_
Protected Attributes inherited from GEO::AttributeStoreObserver
Memory::pointer	base_addr_
index_t	size_
index_t	dimension_
bool	disconnected_

Detailed Description

Specialization of Attribute for booleans.

Attribute needs a specialization for bool, since vector<bool> uses compressed storage (1 bit per boolean), that is not compatible with the attribute management mechanism. This wrapper class uses an Attribute<Numeric::uint8> and does the appropriate conversions, using an accessor class.

Definition at line 1586 of file attributes.h.

Member Typedef Documentation

superclass

typedef AttributeBase<Numeric::uint8> GEO::Attribute< bool >::superclass

Definition at line 1588 of file attributes.h.

Constructor & Destructor Documentation

Attribute() [1/2]

GEO::Attribute< bool >::Attribute ( )

inline

Definition at line 1590 of file attributes.h.

Attribute() [2/2]

GEO::Attribute< bool >::Attribute ( AttributesManager &  manager, const std::string &  name  )

inline

Definition at line 1593 of file attributes.h.

Member Function Documentation

copy()

void GEO::Attribute< bool >::copy ( const Attribute< bool > &  rhs )

inline

Copies all the values from another attribute.

Parameters

[in]

rhs

the attribute to be copied.

rhs needs to have the same size and dimension as this Attribute.

Definition at line 1735 of file attributes.h.

element() [1/2]

Numeric::uint8 & GEO::Attribute< bool >::element ( index_t  i )

inlineprotected

Gets a modifiable element by index.

Parameters

[in]

i

index of the element

Returns

a modifiable reference to the ith element

Definition at line 1753 of file attributes.h.

element() [2/2]

const Numeric::uint8 & GEO::Attribute< bool >::element ( index_t  i ) const

inlineprotected

Gets an element by index.

Parameters

[in]

i

index of the element

Returns

a const reference to the ith element

Definition at line 1763 of file attributes.h.

fill()

void GEO::Attribute< bool >::fill ( bool  val )

inline

Sets all the elements in this attribute to a specified value.

Parameters

[in]

val

the value

Definition at line 1723 of file attributes.h.

operator[]() [1/2]

BoolAttributeAccessor GEO::Attribute< bool >::operator[] ( index_t  i )

inline

Definition at line 1710 of file attributes.h.

operator[]() [2/2]

ConstBoolAttributeAccessor GEO::Attribute< bool >::operator[] ( index_t  i ) const

inline

Definition at line 1714 of file attributes.h.

Friends And Related Symbol Documentation

BoolAttributeAccessor

friend class BoolAttributeAccessor

friend

Definition at line 1745 of file attributes.h.

ConstBoolAttributeAccessor

friend class ConstBoolAttributeAccessor

friend

Definition at line 1746 of file attributes.h.

---

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

• geogram/basic/attributes.h