Manages an attribute attached to a set of object. More...

#include <geogram/basic/attributes.h>

Inheritance diagram for GEO::Attribute< T >:

Public Types
typedef AttributeBase< T >	superclass

Public Member Functions
	Attribute ()
	Creates an uninitialized (unbound) Attribute.

	Attribute (AttributesManager &manager, const std::string &name)
	Creates or retrieves a persistent attribute attached to a given AttributesManager. More...

T &	operator[] (index_t i)
	Gets a modifiable element by index. More...

const T &	operator[] (index_t i) const
	Gets an element by index. More...

void	fill (const T &val)
	Sets all the elements in this attribute to a specified value. More...

void	copy (const Attribute< T > &rhs)
	Copies all the values from another attribute. More...

T *	data ()
	Gets the pointer to the data. More...

const T *	data () const
	Gets the pointer to the data. More...

Public Member Functions inherited from GEO::AttributeBase< T >
	AttributeBase ()
	Creates an uninitialized (unbound) Attribute.

	AttributeBase (AttributesManager &manager, const std::string &name)
	Creates or retrieves a persistent attribute attached to a given AttributesManager. More...

bool	is_bound () const
	Tests whether an Attribute is bound. More...

void	unbind ()
	Unbinds this Attribute. More...

void	bind (AttributesManager &manager, const std::string &name)
	Binds this Attribute to an AttributesManager. More...

bool	bind_if_is_defined (AttributesManager &manager, const std::string &name)
	Binds this Attribute to an AttributesManager if it already exists in the AttributesManager. More...

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 tyopes are compatible. More...

void	create_vector_attribute (AttributesManager &manager, const std::string &name, index_t dimension)
	Creates and binds a new vector attribute. More...

void	destroy ()
	Destroys this attribute in the AttributesManager. More...

void	redim (index_t new_dim)
	Sets the dimension. More...

	~AttributeBase ()
	Attribute destructor. More...

index_t	size () const
	Gets the size. More...

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. More...

vector< T > &	get_vector ()
	Gets a reference to the internal vector<T> used to store the attribute. More...

const vector< T > &	get_vector () const
	Gets a const reference to the internal vector<T> used to store the attribute. More...

AttributesManager *	manager () const
	Gets the AttributesManager this Attribute is bound to. More...

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. More...

index_t	size () const
	Gets the size. More...

index_t	dimension () const
	Gets the dimension. More...

index_t	nb_elements () const
	Gets the total number of elements. More...

void	register_me (AttributeStore *store)
	Registers this observer to an AttributeStore. More...

void	unregister_me (AttributeStore *store)
	Unregisters this observer from an AttributeStore. More...

void	disconnect ()
	Disconnects this AttributeStoreObserver from its AttributeStore. More...

Static Public Member Functions
static void	static_test_type ()
	Tests at compile time whether type can be used in an Attribute. If not the case generates a compile-time error.

Static Public Member Functions inherited from GEO::AttributeBase< T >
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. More...

Additional Inherited Members
Protected Attributes inherited from GEO::AttributeBase< T >
AttributesManager *	manager_

AttributeStore *	store_

Protected Attributes inherited from GEO::AttributeStoreObserver
Memory::pointer	base_addr_

index_t	size_

index_t	dimension_

bool	disconnected_

Detailed Description

template<class T>
class GEO::Attribute< T >

Manages an attribute attached to a set of object.

Template Parameters

T	type of the attributes. Needs to be a basic type or a plain ordinary datatype (classes that do dynamic memory allocation are not allowed here).

Definition at line 1394 of file attributes.h.

Constructor & Destructor Documentation

◆ Attribute()

template<class T >

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

inline

Creates or retrieves a persistent attribute attached to a given AttributesManager.

If the attribute already exists with the specified name in the AttributesManager then it is retrieved, else it is created and bound to the name.

Parameters

[in]	manager	a reference to the AttributesManager
[in]	name	name of the attribute

Definition at line 1436 of file attributes.h.

Member Function Documentation

◆ copy()

template<class T >

void GEO::Attribute< T >::copy ( const Attribute< T > & 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 1478 of file attributes.h.

◆ data() [1/2]

template<class T >

T* GEO::Attribute< T >::data ( )

inline

Gets the pointer to the data.

Returns: a pointer to the stored array.

Definition at line 1490 of file attributes.h.

◆ data() [2/2]

template<class T >

const T* GEO::Attribute< T >::data ( ) const

inline

Gets the pointer to the data.

Returns: a const pointer to the stored array.

Definition at line 1498 of file attributes.h.

◆ fill()

template<class T >

void GEO::Attribute< T >::fill ( const T & val )

inline

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

Parameters

[in] val the value

Definition at line 1466 of file attributes.h.

◆ operator[]() [1/2]

template<class T >

T& GEO::Attribute< T >::operator[] ( index_t i )

inline

Gets a modifiable element by index.

Parameters

[in] i index of the element

Returns: a modifiable reference to the ith element

Definition at line 1446 of file attributes.h.

◆ operator[]() [2/2]

template<class T >

const T& GEO::Attribute< T >::operator[] ( index_t i ) const

inline

Gets an element by index.

Parameters

[in] i index of the element

Returns: a const reference to the ith element

Definition at line 1456 of file attributes.h.

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

geogram/basic/attributes.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class GEO::Attribute< T >

Constructor & Destructor Documentation

◆ Attribute()

Member Function Documentation

◆ copy()

◆ data() [1/2]

◆ data() [2/2]

◆ fill()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

template<class T>
class GEO::Attribute< T >