OpenVolumeMesh
Loading...
Searching...
No Matches
OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string > Class Reference

#include <OpenVolumeMesh/Core/OpenVolumeMeshProperty.hh>

Inheritance diagram for OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >:
OpenVolumeMesh::OpenVolumeMeshBaseProperty OpenVolumeMesh::OpenVolumeMeshBaseProperty

Public Types

typedef std::string Value
 
typedef std::vector< std::string > vector_type
 
typedef std::string value_type
 
typedef vector_type::reference reference
 
typedef vector_type::const_reference const_reference
 
typedef std::string Value
 
typedef std::vector< std::string > vector_type
 
typedef std::string value_type
 
typedef vector_type::reference reference
 
typedef vector_type::const_reference const_reference
 

Public Member Functions

 OpenVolumeMeshPropertyT (const std::string &_name="<unknown>", const std::string &_def="")
 
virtual void reserve (size_t _n)
 Reserve memory for n elements.
 
virtual void resize (size_t _n)
 Resize storage to hold n elements.
 
virtual void clear ()
 Clear all elements and free memory.
 
virtual void push_back ()
 Extend the number of elements by one.
 
virtual void swap (size_t _i0, size_t _i1)
 Let two elements swap their storage place.
 
virtual void delete_element (size_t _idx)
 Erase an element of the vector.
 
virtual size_t n_elements () const
 Number of elements in property.
 
virtual size_t element_size () const
 Size of one element in bytes or UnknownSize if not known.
 
virtual size_t size_of () const
 Return size of property in bytes.
 
virtual size_t size_of (size_t) const
 
virtual void stats (std::ostream &_ostr) const
 
virtual void serialize (std::ostream &_ostr) const
 
virtual void deserialize (std::istream &_istr)
 
const value_type * data () const
 
reference operator[] (int _idx)
 Access the i'th element. No range check is performed!
 
const_reference operator[] (int _idx) const
 Const access the i'th element. No range check is performed!
 
OpenVolumeMeshPropertyT< value_type > * clone () const
 Return a deep copy of self.
 
vector_type::const_iterator begin () const
 
vector_type::iterator begin ()
 
vector_type::const_iterator end () const
 
vector_type::iterator end ()
 
 OpenVolumeMeshPropertyT (const std::string &_name="<unknown>", const std::string _def=std::string())
 Default constructor.
 
 OpenVolumeMeshPropertyT (const OpenVolumeMeshPropertyT &_rhs)
 Copy constructor.
 
virtual void reserve (size_t _n)
 Reserve memory for n elements.
 
virtual void resize (size_t _n)
 Resize storage to hold n elements.
 
virtual void clear ()
 Clear all elements and free memory.
 
virtual void push_back ()
 Extend the number of elements by one.
 
virtual void swap (size_t _i0, size_t _i1)
 Let two elements swap their storage place.
 
void delete_element (size_t _idx)
 Erase an element of the vector.
 
virtual size_t n_elements () const
 Number of elements in property.
 
virtual size_t element_size () const
 Size of one element in bytes or UnknownSize if not known.
 
virtual size_t size_of () const
 Return size of property in bytes.
 
virtual size_t size_of (size_t _n_elem) const
 
virtual void serialize (std::ostream &_ostr) const
 
virtual void deserialize (std::istream &_istr)
 
const std::string * data () const
 Get pointer to array (does not work for T==bool)
 
vector_type & data_vector ()
 Get reference to property vector (be careful, improper usage, e.g. resizing, may crash)
 
reference operator[] (int _idx)
 Access the i'th element. No range check is performed!
 
const_reference operator[] (int _idx) const
 Const access to the i'th element. No range check is performed!
 
OpenVolumeMeshPropertyT< std::string > * clone () const
 Make a copy of self.
 
vector_type::const_iterator begin () const
 
vector_type::iterator begin ()
 
vector_type::const_iterator end () const
 
vector_type::iterator end ()
 
- Public Member Functions inherited from OpenVolumeMesh::OpenVolumeMeshBaseProperty
 OpenVolumeMeshBaseProperty (const std::string &_name="<unknown>")
 
 OpenVolumeMeshBaseProperty (const OpenVolumeMeshBaseProperty &_rhs)
 
const std::string & name () const
 Return the name of the property.
 
void set_persistent (bool _persistent)
 
bool persistent () const
 
const OpenVolumeMeshHandlehandle () const
 
void set_handle (const OpenVolumeMeshHandle &_handle)
 

Protected Member Functions

virtual void delete_multiple_entries (const std::vector< bool > &_tags)
 Delete multiple entries in list.
 
virtual void delete_multiple_entries (const std::vector< bool > &_tags)
 Delete multiple entries in list.
 

Friends

template<class PropT, class HandleT>
class PropertyPtr
 
class PropertyPtr
 

Additional Inherited Members

- Static Public Attributes inherited from OpenVolumeMesh::OpenVolumeMeshBaseProperty
static const size_t UnknownSize = std::numeric_limits<size_t>::max()
 Indicates an error when a size is returned by a member.
 

Detailed Description

Property specialization for std::string type.

Member Function Documentation

◆ clear() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::clear ( )
inlinevirtual

Clear all elements and free memory.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ clear() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::clear ( )
inlinevirtual

Clear all elements and free memory.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ clone() [1/2]

OpenVolumeMeshPropertyT< std::string > * OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::clone ( ) const
inlinevirtual

Make a copy of self.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ clone() [2/2]

OpenVolumeMeshPropertyT< value_type > * OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::clone ( ) const
inlinevirtual

Return a deep copy of self.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ delete_element() [1/2]

void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::delete_element ( size_t _idx)
inlinevirtual

Erase an element of the vector.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ delete_element() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::delete_element ( size_t _idx)
inlinevirtual

Erase an element of the vector.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ delete_multiple_entries() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::delete_multiple_entries ( const std::vector< bool > & _tags)
inlineprotectedvirtual

Delete multiple entries in list.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ delete_multiple_entries() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::delete_multiple_entries ( const std::vector< bool > & _tags)
inlineprotectedvirtual

Delete multiple entries in list.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ deserialize() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::deserialize ( std::istream & _istr)
inlinevirtual

◆ deserialize() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::deserialize ( std::istream & _istr)
inlinevirtual

◆ element_size() [1/2]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::element_size ( ) const
inlinevirtual

Size of one element in bytes or UnknownSize if not known.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ element_size() [2/2]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::element_size ( ) const
inlinevirtual

Size of one element in bytes or UnknownSize if not known.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ n_elements() [1/2]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::n_elements ( ) const
inlinevirtual

Number of elements in property.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ n_elements() [2/2]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::n_elements ( ) const
inlinevirtual

Number of elements in property.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ push_back() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::push_back ( )
inlinevirtual

Extend the number of elements by one.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ push_back() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::push_back ( )
inlinevirtual

Extend the number of elements by one.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ reserve() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::reserve ( size_t _n)
inlinevirtual

Reserve memory for n elements.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ reserve() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::reserve ( size_t _n)
inlinevirtual

Reserve memory for n elements.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ resize() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::resize ( size_t _n)
inlinevirtual

Resize storage to hold n elements.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ resize() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::resize ( size_t _n)
inlinevirtual

Resize storage to hold n elements.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ serialize() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::serialize ( std::ostream & _ostr) const
inlinevirtual

◆ serialize() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::serialize ( std::ostream & _ostr) const
inlinevirtual

◆ size_of() [1/4]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::size_of ( ) const
inlinevirtual

Return size of property in bytes.

Reimplemented from OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ size_of() [2/4]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::size_of ( ) const
inlinevirtual

Return size of property in bytes.

Reimplemented from OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ size_of() [3/4]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::size_of ( size_t _n_elem) const
inlinevirtual

Estimated size of property if it has _n_elem elements. The member returns UnknownSize if the size cannot be estimated.

Reimplemented from OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ size_of() [4/4]

virtual size_t OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::size_of ( size_t _n_elem) const
inlinevirtual

Estimated size of property if it has _n_elem elements. The member returns UnknownSize if the size cannot be estimated.

Reimplemented from OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ swap() [1/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::swap ( size_t _i0,
size_t _i1 )
inlinevirtual

Let two elements swap their storage place.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.

◆ swap() [2/2]

virtual void OpenVolumeMesh::OpenVolumeMeshPropertyT< std::string >::swap ( size_t _i0,
size_t _i1 )
inlinevirtual

Let two elements swap their storage place.

Implements OpenVolumeMesh::OpenVolumeMeshBaseProperty.


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