Dense storage of variable-length tag data. More...

#include <VarLenDenseTag.hpp>

Inheritance diagram for moab::VarLenDenseTag:

Collaboration diagram for moab::VarLenDenseTag:

Public Member Functions
virtual	~VarLenDenseTag ()

virtual TagType	get_storage_type () const

virtual ErrorCode	release_all_data (SequenceManager seqman, Error error_handler, bool delete_pending)
	Remove/clear tag data for all entities. More...

virtual ErrorCode	get_data (const SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, void data) const
	Get tag value for passed entities. More...

virtual ErrorCode	get_data (const SequenceManager seqman, Error error_handler, const Range &entities, void *data) const
	Get tag value for passed entities. More...

virtual ErrorCode	get_data (const SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, const void data_ptrs, int data_lengths) const
	Get tag value for passed entities. More...

virtual ErrorCode	get_data (const SequenceManager seqman, Error error_handler, const Range &entities, const void *data_ptrs, int data_lengths) const
	Get tag value for passed entities. More...

virtual ErrorCode	set_data (SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, const void data)
	Set tag value for passed entities. More...

virtual ErrorCode	set_data (SequenceManager seqman, Error error_handler, const Range &entities, const void *data)
	Set tag value for passed entities. More...

virtual ErrorCode	set_data (SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, void const const data_ptrs, const int data_lengths)
	Set tag value for passed entities. More...

virtual ErrorCode	set_data (SequenceManager seqman, Error error_handler, const Range &entities, void const const data_ptrs, const int *data_lengths)
	Set tag value for passed entities. More...

virtual ErrorCode	clear_data (SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, const void value_ptr, int value_len=0)
	Set tag value for passed entities. More...

virtual ErrorCode	clear_data (SequenceManager seqman, Error error_handler, const Range &entities, const void *value_ptr, int value_len=0)
	Set tag value for passed entities. More...

virtual ErrorCode	remove_data (SequenceManager seqman, Error error_handler, const EntityHandle *entities, size_t num_entities)
	Remove/clear tag data for entities. More...

virtual ErrorCode	remove_data (SequenceManager seqman, Error error_handler, const Range &entities)
	Remove/clear tag data for entities. More...

virtual ErrorCode	tag_iterate (SequenceManager seqman, Error error_handler, Range::iterator &iter, const Range::iterator &end, void *&data_ptr, bool allocate)
	Access tag data via direct pointer into contiguous blocks. More...

virtual ErrorCode	get_tagged_entities (const SequenceManager seqman, Range &output_entities, EntityType type=MBMAXTYPE, const Range intersect=0) const
	Get all tagged entities. More...

virtual ErrorCode	num_tagged_entities (const SequenceManager seqman, size_t &output_count, EntityType type=MBMAXTYPE, const Range intersect=0) const
	Count all tagged entities. More...

virtual ErrorCode	find_entities_with_value (const SequenceManager seqman, Error error, Range &output_entities, const void value, int value_bytes=0, EntityType type=MBMAXTYPE, const Range intersect_entities=0) const
	Get all tagged entities with tag value. More...

virtual bool	is_tagged (const SequenceManager *, EntityHandle h) const
	Check if entity is tagged. More...

virtual ErrorCode	get_memory_use (const SequenceManager *seqman, unsigned long &total, unsigned long &per_entity) const
	Get memory use for tag data. More...

Public Member Functions inherited from moab::TagInfo
	TagInfo ()
	constructor More...

	TagInfo (const char name, int size, DataType type, const void default_value, int default_value_size)
	constructor that takes all parameters More...

virtual	~TagInfo ()

void	set_name (const std::string &name)
	set the name of the tag More...

const std::string &	get_name () const
	get the name of the tag More...

int	get_default_value_size () const
	get length of default value More...

const void *	get_default_value () const
	get the default data More...

bool	equals_default_value (const void *data, int size=-1) const
	compare the passed value to the default value. returns false if no default value. More...

DataType	get_data_type () const

int	get_size () const
	get the size of the data in bytes More...

bool	variable_length () const
	Check if variable-length tag. More...

bool	check_valid_sizes (const int *sizes, int num_sizes) const

ErrorCode	validate_lengths (Error error_handler, const int lengths, size_t num_lengths) const

Static Public Member Functions
static VarLenDenseTag *	create_tag (SequenceManager seqman, Error error_handler, const char name, DataType type, const void default_value, int default_value_len)

Static Public Member Functions inherited from moab::TagInfo
static int	size_from_data_type (DataType t)

Private Member Functions
	VarLenDenseTag (int array_index, const char name, DataType type, const void default_value, int default_value_len)

	VarLenDenseTag (const VarLenDenseTag &)

VarLenDenseTag &	operator= (const VarLenDenseTag &)

ErrorCode	get_array (SequenceManager seqman, Error error_handler, EntityHandle h, VarLenTag *&ptr, size_t &count, bool allocate)
	Get or allocated tag storage. More...

ErrorCode	get_array (const SequenceManager seqman, Error error_handler, EntityHandle h, const VarLenTag *&ptr, size_t &count) const
	Get tag storage. More...

ErrorCode	set_data (SequenceManager seqman, Error error_handler, const EntityHandle entities, size_t num_entities, bool one_value, void const const pointers, const int lengths)
	Common implementation of set_data, and clear_data. More...

ErrorCode	set_data (SequenceManager seqman, Error error_handler, const Range &entities, bool one_value, void const const pointers, const int *lengths)
	Common implementation of set_data, and clear_data. More...

Private Attributes
int	mySequenceArray
	Array index in SequenceManager used to store tag data. More...

VarLenTag	meshValue

Additional Inherited Members
Protected Member Functions inherited from moab::TagInfo
unsigned long	get_memory_use () const

Detailed Description

Dense storage of variable-length tag data.

Implement variable-length dense tag.

Definition at line 21 of file VarLenDenseTag.hpp.

Constructor & Destructor Documentation

◆ VarLenDenseTag() [1/2]

moab::VarLenDenseTag::VarLenDenseTag	(	int	array_index,
		const char *	name,
		DataType	type,
		const void *	default_value,
		int	default_value_len
	)

private

Definition at line 38 of file VarLenDenseTag.cpp.

     : TagInfo( name, MB_VARIABLE_LENGTH, type, default_value, default_value_size ), mySequenceArray( index )
 {
 }

Referenced by create_tag().

◆ ~VarLenDenseTag()

moab::VarLenDenseTag::~VarLenDenseTag ( )

virtual

Definition at line 60 of file VarLenDenseTag.cpp.

 {
     assert( mySequenceArray < 0 );
 }

References mySequenceArray.

◆ VarLenDenseTag() [2/2]

moab::VarLenDenseTag::VarLenDenseTag ( const VarLenDenseTag & )

private

Member Function Documentation

◆ clear_data() [1/2]

ErrorCode moab::VarLenDenseTag::clear_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		const void *	value_ptr,
		int	value_len = `0`
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
num_entities	Length of `entities` array
value_ptr	Pointer to a single tag value which is to be stored for each of the passed entities.
value_len	Length of tag value in bytes. Ignored for fixed-length tags. Required for variable- length tags.

Implements moab::TagInfo.

Definition at line 372 of file VarLenDenseTag.cpp.

 {
     if( !value_ptr || !value_len )
         return remove_data( seqman, NULL, entities, num_entities );
     else
         return set_data( seqman, NULL, entities, num_entities, true, &value_ptr, &value_len );
 }

References entities, remove_data(), and set_data().

◆ clear_data() [2/2]

ErrorCode moab::VarLenDenseTag::clear_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		const void *	value_ptr,
		int	value_len = `0`
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
value_ptr	Pointer to a single tag value which is to be stored for each of the passed entities.
value_len	Length of tag value in bytes. Ignored for fixed-length tags. Required for variable- length tags.

Implements moab::TagInfo.

Definition at line 385 of file VarLenDenseTag.cpp.

 {
     if( !value_ptr || !value_len )
         return remove_data( seqman, NULL, entities );
     else
         return set_data( seqman, NULL, entities, true, &value_ptr, &value_len );
 }

References entities, remove_data(), and set_data().

◆ create_tag()

VarLenDenseTag * moab::VarLenDenseTag::create_tag	(	SequenceManager *	seqman,
		Error *	error_handler,
		const char *	name,
		DataType	type,
		const void *	default_value,
		int	default_value_len
	)

static

Definition at line 47 of file VarLenDenseTag.cpp.

 {
     int index;
     if( MB_SUCCESS != seqman->reserve_tag_array( error, MB_VARIABLE_LENGTH, index ) ) return NULL;
  
     return new VarLenDenseTag( index, name, type, default_value, default_value_size );
 }

References moab::error(), MB_SUCCESS, MB_VARIABLE_LENGTH, moab::SequenceManager::reserve_tag_array(), and VarLenDenseTag().

Referenced by moab::Core::tag_get_handle().

◆ find_entities_with_value()

ErrorCode moab::VarLenDenseTag::find_entities_with_value	(	const SequenceManager *	seqman,
		Error *	error,
		Range &	output_entities,
		const void *	value,
		int	value_bytes = `0`,
		EntityType	type = `MBMAXTYPE`,
		const Range *	intersect_entities = `0`
	)		const

virtual

Get all tagged entities with tag value.

Get the list of entities which have the specified tag value.

Parameters

seqman	Pointer to entity storage database
output_entities	Results appended to this range
value	Pointer to tag value
value_bytes	Size of tag value in bytes.
type	Optional entity type. If specified, search is limited to entities of specified type.
intersect_entities	Optional intersect list. If specified, search is restricted to entities in this list.

Implements moab::TagInfo.

Definition at line 554 of file VarLenDenseTag.cpp.

 {
     if( !intersect_entities )
     {
         std::pair< EntityType, EntityType > range = type_range( type );
         TypeSequenceManager::const_iterator i;
         for( EntityType t = range.first; t != range.second; ++t )
         {
             const TypeSequenceManager& map = seqman->entity_map( t );
             for( i = map.begin(); i != map.end(); ++i )
             {
                 const void* data = ( *i )->data()->get_tag_data( mySequenceArray );
                 if( data )
                 {
                     ByteArrayIterator start( ( *i )->data()->start_handle(), data, *this );
                     ByteArrayIterator end( ( *i )->end_handle() + 1, 0, 0 );
                     start += ( *i )->start_handle() - ( *i )->data()->start_handle();
                     find_tag_varlen_values_equal( *this, value, value_bytes, start, end, output_entities );
                 }
             }
         }
     }
     else
     {
         const VarLenTag* array;
         size_t count;
         ErrorCode rval;
  
         Range::const_pair_iterator p = intersect_entities->begin();
         if( type != MBMAXTYPE )
         {
             p = intersect_entities->lower_bound( type );
             assert( TYPE_FROM_HANDLE( p->first ) == type );
         }
         for( ;
              p != intersect_entities->const_pair_end() && ( MBMAXTYPE == type || TYPE_FROM_HANDLE( p->first ) == type );
              ++p )
         {
             EntityHandle start = p->first;
             while( start <= p->second )
             {
                 rval = get_array( seqman, error, start, array, count );MB_CHK_ERR( rval );
  
                 if( p->second - start < count - 1 ) count = p->second - start + 1;
  
                 if( array )
                 {
                     ByteArrayIterator istart( start, array, *this );
                     ByteArrayIterator iend( start + count, 0, 0 );
                     find_tag_varlen_values_equal( *this, value, value_bytes, istart, iend, output_entities );
                 }
                 start += count;
             }
         }
     }
  
     return MB_SUCCESS;
 }

References moab::Range::begin(), moab::TypeSequenceManager::begin(), moab::Range::const_pair_end(), moab::ByteArrayIterator::data, moab::TypeSequenceManager::end(), moab::SequenceManager::entity_map(), moab::error(), ErrorCode, moab::find_tag_varlen_values_equal(), get_array(), moab::Range::lower_bound(), MB_CHK_ERR, MB_SUCCESS, MBMAXTYPE, mySequenceArray, moab::TYPE_FROM_HANDLE(), and moab::type_range().

◆ get_array() [1/2]

ErrorCode moab::VarLenDenseTag::get_array	(	const SequenceManager *	seqman,
		Error *	error_handler,
		EntityHandle	h,
		const VarLenTag *&	ptr,
		size_t &	count
	)		const

inlineprivate

Get tag storage.

Parameters

h	First entity for which to return storage.
ptr	Pointer to dag storage. This pointer will be set to null and `MB_SUCCESS` will be returned if the handle is valid but no tag storage has been allocated.
count	Number of consecutive entities for which tag storage is returned. This value will be valid even if null is returned for `ptr` and indicates the number of consecutive entities for which no tag storage has been allocated.

Returns: MB_SUCCESS if handle is valid (regardless of whether or not any tag storage is allocated).

Definition at line 84 of file VarLenDenseTag.cpp.

 {
     const EntitySequence* seq = NULL;
     ErrorCode rval            = seqman->find( h, seq );
     if( MB_SUCCESS != rval )
     {
         if( !h )
         {  // Root set
             ptr   = &meshValue;
             count = 1;
             return MB_SUCCESS;
         }
         else
         {
             ptr   = NULL;
             count = 0;
             return not_found( get_name(), h );
         }
     }
  
     const void* mem = seq->data()->get_tag_data( mySequenceArray );
     ptr             = reinterpret_cast< const VarLenTag* >( mem );
     count           = seq->data()->end_handle() - h + 1;
     if( ptr ) ptr += h - seq->data()->start_handle();
  
     return MB_SUCCESS;
 }

References moab::EntitySequence::data(), moab::SequenceData::end_handle(), ErrorCode, moab::SequenceManager::find(), moab::TagInfo::get_name(), moab::SequenceData::get_tag_data(), MB_SUCCESS, meshValue, mySequenceArray, moab::not_found(), and moab::SequenceData::start_handle().

◆ get_array() [2/2]

ErrorCode moab::VarLenDenseTag::get_array	(	SequenceManager *	seqman,
		Error *	error_handler,
		EntityHandle	h,
		VarLenTag *&	ptr,
		size_t &	count,
		bool	allocate
	)

inlineprivate

Get or allocated tag storage.

Parameters

h	First entity for which to return storage.
ptr	Pointer to dag storage. This pointer will be set to null and `MB_SUCCESS` will be returned if the handle is valid but no tag storage has been allocated.
count	Number of consecutive entities for which tag storage is returned. This value will be valid even if null is returned for `ptr` and indicates the number of consecutive entities for which no tag storage has been allocated.
allocate	If true storage will be allocated and initialized if it has not already been allocated.

Returns: MB_SUCCESS if handle is valid (regardless of whether or not any tag storage is allocated).

Definition at line 116 of file VarLenDenseTag.cpp.

 {
     EntitySequence* seq = NULL;
     ErrorCode rval      = seqman->find( h, seq );
     if( MB_SUCCESS != rval )
     {
         if( !h )
         {  // Root set
             ptr   = &meshValue;
             count = 1;
             return MB_SUCCESS;
         }
         else
         {
             ptr   = NULL;
             count = 0;
             return not_found( get_name(), h );
         }
     }
  
     void* mem = seq->data()->get_tag_data( mySequenceArray );
     if( !mem && allocate )
     {
         mem = seq->data()->allocate_tag_array( mySequenceArray, sizeof( VarLenTag ) );
         if( !mem )
         {
             MB_SET_ERR( MB_MEMORY_ALLOCATION_FAILED, "Memory allocation for variable-length dense tag data failed" );
         }
  
         memset( mem, 0, sizeof( VarLenTag ) * seq->data()->size() );
     }
  
     ptr   = reinterpret_cast< VarLenTag* >( mem );
     count = seq->data()->end_handle() - h + 1;
     if( ptr ) ptr += h - seq->data()->start_handle();
  
     return MB_SUCCESS;
 }

References moab::SequenceData::allocate_tag_array(), moab::EntitySequence::data(), moab::SequenceData::end_handle(), ErrorCode, moab::SequenceManager::find(), moab::TagInfo::get_name(), moab::SequenceData::get_tag_data(), MB_MEMORY_ALLOCATION_FAILED, MB_SET_ERR, MB_SUCCESS, meshValue, mySequenceArray, moab::not_found(), moab::SequenceData::size(), and moab::SequenceData::start_handle().

Referenced by find_entities_with_value(), get_data(), is_tagged(), remove_data(), and set_data().

◆ get_data() [1/4]

ErrorCode moab::VarLenDenseTag::get_data	(	const SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		const void **	data_ptrs,
		int *	data_lengths
	)		const

virtual

Get tag value for passed entities.

Get tag values for specified entities.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to retrieve tag data
num_entities	Length of `entities` array
data_ptrs	Array of pointers to tag values, one pointer for each passed entity.
data_lengths	One value for each entity specifying the length of the tag value for the corresponding entity.

Implements moab::TagInfo.

Definition at line 174 of file VarLenDenseTag.cpp.

 {
     if( !lengths )
     {
         MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
     }
  
     ErrorCode result              = MB_SUCCESS, rval;
     const EntityHandle* const end = entities + num_entities;
     size_t junk                   = 0;
     const VarLenTag* ptr          = NULL;
  
     for( const EntityHandle* i = entities; i != end; ++i, ++pointers, ++lengths )
     {
         rval = get_array( seqman, NULL, *i, ptr, junk );MB_CHK_ERR( rval );
  
         if( ptr && ptr->size() )
         {
             *pointers = ptr->data();
             *lengths  = ptr->size();
         }
         else if( get_default_value() )
         {
             *pointers = get_default_value();
             *lengths  = get_default_value_size();
         }
         else
         {
             *pointers = 0;
             *lengths  = 0;
             result    = not_found( get_name(), *i );
         }
     }
  
     return result;
 }

References moab::VarLenTag::data(), entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_default_value_size(), moab::TagInfo::get_name(), MB_CHK_ERR, MB_SET_ERR, MB_SUCCESS, MB_VARIABLE_DATA_LENGTH, moab::not_found(), and moab::VarLenTag::size().

◆ get_data() [2/4]

ErrorCode moab::VarLenDenseTag::get_data	(	const SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		void *	data
	)		const

virtual

Get tag value for passed entities.

Get tag values for specified entities.

\Note Will fail for variable-length data.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to retrieve tag data
num_entities	Length of `entities` array
data	Pointer to memory in which to store consecutive tag values, one for each passed entity.

Implements moab::TagInfo.

Definition at line 160 of file VarLenDenseTag.cpp.

 {
     MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
 }

References moab::TagInfo::get_name(), MB_SET_ERR, and MB_VARIABLE_DATA_LENGTH.

◆ get_data() [3/4]

ErrorCode moab::VarLenDenseTag::get_data	(	const SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		const void **	data_ptrs,
		int *	data_lengths
	)		const

virtual

Get tag value for passed entities.

Get tag values for specified entities.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to retrieve tag data
data_ptrs	Array of pointers to tag values, one pointer for each passed entity.
data_lengths	One value for each entity specifying the length of the tag value for the corresponding entity.

Implements moab::TagInfo.

Definition at line 216 of file VarLenDenseTag.cpp.

 {
     if( !lengths )
     {
         MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
     }
  
     ErrorCode rval;
     size_t avail           = 0;
     const VarLenTag* array = NULL;
  
     for( Range::const_pair_iterator p = entities.const_pair_begin(); p != entities.const_pair_end(); ++p )
     {
         EntityHandle start = p->first;
         while( start <= p->second )
         {
             rval = get_array( seqman, NULL, start, array, avail );MB_CHK_ERR( rval );
  
             const size_t count = std::min< size_t >( p->second - start + 1, avail );
  
             if( !array )
             {
                 const void* defval = get_default_value();
                 const int len      = get_default_value_size();
                 SysUtil::setmem( pointers, &defval, sizeof( void* ), count );
                 SysUtil::setmem( lengths, &len, sizeof( int ), count );
                 pointers += count;
                 lengths += count;
                 if( !defval ) return not_found( get_name(), start );
             }
  
             const VarLenTag* end_data = array + count;
             while( array != end_data )
             {
                 if( array->size() )
                 {
                     *pointers = array->data();
                     *lengths  = array->size();
                 }
                 else if( get_default_value() )
                 {
                     *pointers = get_default_value();
                     *lengths  = get_default_value_size();
                 }
                 else
                 {
                     *pointers = NULL;
                     *lengths  = 0;
                     return not_found( get_name(), start );
                 }
                 ++pointers;
                 ++lengths;
                 ++array;
                 ++start;
             }
         }
     }
  
     return MB_SUCCESS;
 }

References moab::VarLenTag::data(), entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_default_value_size(), moab::TagInfo::get_name(), MB_CHK_ERR, MB_SET_ERR, MB_SUCCESS, MB_VARIABLE_DATA_LENGTH, moab::not_found(), moab::SysUtil::setmem(), and moab::VarLenTag::size().

◆ get_data() [4/4]

ErrorCode moab::VarLenDenseTag::get_data	(	const SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		void *	data
	)		const

virtual

Get tag value for passed entities.

Get tag values for specified entities.

\Note Will fail for variable-length data.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to retrieve tag data
data	Pointer to memory in which to store consecutive tag values, one for each passed entity.

Implements moab::TagInfo.

Definition at line 169 of file VarLenDenseTag.cpp.

 {
     MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
 }

References moab::TagInfo::get_name(), MB_SET_ERR, and MB_VARIABLE_DATA_LENGTH.

◆ get_memory_use()

ErrorCode moab::VarLenDenseTag::get_memory_use	(	const SequenceManager *	seqman,
		unsigned long &	total,
		unsigned long &	per_entity
	)		const

virtual

Get memory use for tag data.

Implements moab::TagInfo.

Definition at line 626 of file VarLenDenseTag.cpp.

 {
     total        = 0;
     per_entity   = 0;
     size_t count = 0;
     for( EntityType t = MBVERTEX; t <= MBENTITYSET; ++t )
     {
         const TypeSequenceManager& map = seqman->entity_map( t );
         const SequenceData* prev_data  = 0;
         for( TypeSequenceManager::const_iterator i = map.begin(); i != map.end(); ++i )
         {
             const void* mem = ( *i )->data()->get_tag_data( mySequenceArray );
             if( !mem ) continue;
  
             if( ( *i )->data() != prev_data )
             {
                 total += ( *i )->data()->size();
                 prev_data = ( *i )->data();
             }
  
             count += ( *i )->size();
             const VarLenTag* array = reinterpret_cast< const VarLenTag* >( mem );
             for( int j = 0; j < ( *i )->size(); ++j )
                 per_entity += array[j].mem();
         }
     }
     total *= sizeof( VarLenTag );
     total += per_entity + sizeof( *this ) + TagInfo::get_memory_use();
     total += meshValue.mem() + sizeof( meshValue );
     if( count ) per_entity /= count;
     per_entity += sizeof( VarLenTag );
  
     return MB_SUCCESS;
 }

References moab::TypeSequenceManager::begin(), moab::TypeSequenceManager::end(), moab::SequenceManager::entity_map(), moab::TagInfo::get_memory_use(), moab::SequenceData::get_tag_data(), MB_SUCCESS, MBENTITYSET, MBVERTEX, moab::VarLenTag::mem(), meshValue, mySequenceArray, and moab::SequenceData::size().

◆ get_storage_type()

TagType moab::VarLenDenseTag::get_storage_type ( ) const

virtual

Implements moab::TagInfo.

Definition at line 65 of file VarLenDenseTag.cpp.

 {
     return MB_TAG_DENSE;
 }

References MB_TAG_DENSE.

◆ get_tagged_entities()

ErrorCode moab::VarLenDenseTag::get_tagged_entities	(	const SequenceManager *	seqman,
		Range &	output_entities,
		EntityType	type = `MBMAXTYPE`,
		const Range *	intersect = `0`
	)		const

virtual

Get all tagged entities.

Get the list of entities for which the a tag value has been set, or a close approximation if the tag storage scheme cannot accurately determine exactly which entities have explicit values.

Parameters

seqman	Pointer to entity storage database
output_entities	Results appended to this range
type	Optional entity type. If specified, search is limited to entities of specified type.
intersect	Optional intersect list. If specified, search is restricted to entities in this list.

Implements moab::TagInfo.

Definition at line 535 of file VarLenDenseTag.cpp.

 {
     return get_tagged( seqman, mySequenceArray, entities, type, intersect );
 }

References entities, moab::get_tagged(), moab::intersect(), and mySequenceArray.

◆ is_tagged()

bool moab::VarLenDenseTag::is_tagged	(	const SequenceManager *	seqman,
		EntityHandle	h
	)		const

virtual

Check if entity is tagged.

Implements moab::TagInfo.

Definition at line 619 of file VarLenDenseTag.cpp.

 {
     const VarLenTag* ptr = NULL;  // Initialize to get rid of warning
     size_t count;
     return ( MB_SUCCESS == get_array( seqman, 0, h, ptr, count ) ) && ( NULL != ptr ) && ( NULL != ptr->data() );
 }

References moab::VarLenTag::data(), get_array(), and MB_SUCCESS.

◆ num_tagged_entities()

ErrorCode moab::VarLenDenseTag::num_tagged_entities	(	const SequenceManager *	seqman,
		size_t &	output_count,
		EntityType	type = `MBMAXTYPE`,
		const Range *	intersect = `0`
	)		const

virtual

Count all tagged entities.

Count the entities for which the a tag value has been set, or a close approximation if the tag storage scheme cannot accurately determine exactly which entities have explicit values.

Parameters

seqman	Pointer to entity storage database
output_count	This is incremented for each detected entity.
type	Optional entity type. If specified, search is limited to entities of specified type.
intersect	Optional intersect list. If specified, search is restricted to entities in this list.

Implements moab::TagInfo.

Definition at line 543 of file VarLenDenseTag.cpp.

 {
     InsertCount counter( output_count );
     ErrorCode rval = get_tagged( seqman, mySequenceArray, counter, type, intersect );
     output_count   = counter.end();
     return rval;
 }

References moab::InsertCount::end(), ErrorCode, moab::get_tagged(), moab::intersect(), and mySequenceArray.

◆ operator=()

VarLenDenseTag& moab::VarLenDenseTag::operator= ( const VarLenDenseTag & )

private

◆ release_all_data()

ErrorCode moab::VarLenDenseTag::release_all_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		bool	delete_pending
	)

virtual

Remove/clear tag data for all entities.

Remove tag values from entities.

Parameters

delete_pending If true, then release any global data associated with the tag in preparation for deleting the tag itself.

\Note Invalidates tag if tag_delete_pending is true. The only valid method that can be invoked that is is the destructor.

Parameters

seqman Pointer to mesh entity database

Implements moab::TagInfo.

Definition at line 70 of file VarLenDenseTag.cpp.

 {
     Range all_ents;
     seqman->get_entities( all_ents );
     ErrorCode rval = remove_data( seqman, error, all_ents );
     if( MB_SUCCESS == rval )
     {
         rval = seqman->release_tag_array( error, mySequenceArray, delete_pending );
         if( MB_SUCCESS == rval && delete_pending ) mySequenceArray = -1;
     }
  
     return rval;
 }

References moab::error(), ErrorCode, moab::SequenceManager::get_entities(), MB_SUCCESS, mySequenceArray, moab::SequenceManager::release_tag_array(), and remove_data().

◆ remove_data() [1/2]

ErrorCode moab::VarLenDenseTag::remove_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities
	)

virtual

Remove/clear tag data for entities.

Remove tag values from entities.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
num_entities	Length of `entities` array

Implements moab::TagInfo.

Definition at line 397 of file VarLenDenseTag.cpp.

 {
     const EntityHandle* const end = entities + num_entities;
     VarLenTag* array              = NULL;
     size_t junk                   = 0;
     ErrorCode rval;
  
     for( const EntityHandle* i = entities; i != end; ++i )
     {
         rval = get_array( seqman, NULL, *i, array, junk, false );MB_CHK_ERR( rval );
  
         if( array ) array->clear();
     }
  
     return MB_SUCCESS;
 }

References moab::VarLenTag::clear(), entities, ErrorCode, get_array(), MB_CHK_ERR, and MB_SUCCESS.

Referenced by clear_data(), and release_all_data().

◆ remove_data() [2/2]

ErrorCode moab::VarLenDenseTag::remove_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities
	)

virtual

Remove/clear tag data for entities.

Remove tag values from entities.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data

Implements moab::TagInfo.

Definition at line 417 of file VarLenDenseTag.cpp.

 {
     VarLenTag* array = NULL;
     size_t avail     = 0;
     ErrorCode rval;
  
     for( Range::const_pair_iterator p = entities.const_pair_begin(); p != entities.const_pair_end(); ++p )
     {
         EntityHandle start = p->first;
         while( start <= p->second )
         {
             rval = get_array( seqman, NULL, start, array, avail, false );MB_CHK_ERR( rval );
  
             const EntityHandle end = std::min< EntityHandle >( p->second + 1, start + avail );
             if( array )
             {
                 while( start != end )
                 {
                     array->clear();
                     ++start;
                     ++array;
                 }
             }
             else
             {
                 start = end;
             }
         }
     }
  
     return MB_SUCCESS;
 }

References moab::VarLenTag::clear(), entities, ErrorCode, get_array(), MB_CHK_ERR, and MB_SUCCESS.

◆ set_data() [1/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		bool	one_value,
		void const const	pointers,
		const int *	lengths
	)

inlineprivate

Common implementation of set_data, and clear_data.

Parameters

allocate	If false and no storage is currently allocated for an entity then leave entity tag unallocated.
one_value	If true, pointers and lengths are assumed to be arrays of length 1 and all entities are set to the corresponding value

Definition at line 291 of file VarLenDenseTag.cpp.

 {
     ErrorCode rval = validate_lengths( NULL, lengths, one_value ? 1 : num_entities );MB_CHK_ERR( rval );
  
     const EntityHandle* const end = entities + num_entities;
     VarLenTag* array              = NULL;
     size_t junk                   = 0;
     const size_t step             = one_value ? 0 : 1;
  
     for( const EntityHandle* i = entities; i != end; ++i )
     {
         rval = get_array( seqman, NULL, *i, array, junk, true );MB_CHK_ERR( rval );
  
         array->set( *pointers, *lengths );
         pointers += step;
         lengths += step;
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), MB_CHK_ERR, MB_SUCCESS, moab::VarLenTag::set(), and moab::TagInfo::validate_lengths().

◆ set_data() [2/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		const void *	data
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values \Note Will fail for variable-length data.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
num_entities	Length of `entities` array
data	Pointer to memory holding consecutive tag values, one for each passed entity.

Implements moab::TagInfo.

Definition at line 281 of file VarLenDenseTag.cpp.

 {
     MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
 }

References moab::TagInfo::get_name(), MB_SET_ERR, and MB_VARIABLE_DATA_LENGTH.

Referenced by clear_data(), and set_data().

◆ set_data() [3/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const EntityHandle *	entities,
		size_t	num_entities,
		void const const	data_ptrs,
		const int *	data_lengths
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
num_entities	Length of `entities` array
data_ptrs	Array of pointers to tag values, one pointer for each passed entity.
data_lengths	One value for each entity specifying the length of the tag value for the corresponding entity. Array is required for variable-length tags and is ignored for fixed-length tags.

Implements moab::TagInfo.

Definition at line 353 of file VarLenDenseTag.cpp.

 {
     return set_data( seqman, NULL, entities, num_entities, false, pointers, lengths );
 }

References entities, and set_data().

◆ set_data() [4/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		bool	one_value,
		void const const	pointers,
		const int *	lengths
	)

inlineprivate

Common implementation of set_data, and clear_data.

Parameters

allocate	If false and no storage is currently allocated for an entity then leave entity tag unallocated.
one_value	If true, pointers and lengths are assumed to be arrays of length 1 and all entities are set to the corresponding value

Definition at line 318 of file VarLenDenseTag.cpp.

 {
     ErrorCode rval = validate_lengths( NULL, lengths, one_value ? 1 : entities.size() );MB_CHK_ERR( rval );
  
     VarLenTag* array  = NULL;
     size_t avail      = 0;
     const size_t step = one_value ? 0 : 1;
  
     for( Range::const_pair_iterator p = entities.const_pair_begin(); p != entities.const_pair_end(); ++p )
     {
         EntityHandle start = p->first;
         while( start <= p->second )
         {
             rval = get_array( seqman, NULL, start, array, avail, true );MB_CHK_ERR( rval );
  
             const EntityHandle end = std::min< EntityHandle >( p->second + 1, start + avail );
             while( start != end )
             {
                 array->set( *pointers, *lengths );
                 ++start;
                 ++array;
                 pointers += step;
                 lengths += step;
             }
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), MB_CHK_ERR, MB_SUCCESS, moab::VarLenTag::set(), and moab::TagInfo::validate_lengths().

◆ set_data() [5/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		const void *	data
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values \Note Will fail for variable-length data.

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
data	Pointer to memory holding consecutive tag values, one for each passed entity.

Implements moab::TagInfo.

Definition at line 286 of file VarLenDenseTag.cpp.

 {
     MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag " << get_name() << " data" );
 }

References moab::TagInfo::get_name(), MB_SET_ERR, and MB_VARIABLE_DATA_LENGTH.

◆ set_data() [6/6]

ErrorCode moab::VarLenDenseTag::set_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		const Range &	entities,
		void const const	data_ptrs,
		const int *	data_lengths
	)

virtual

Set tag value for passed entities.

Store tag data or update stored tag values

Parameters

seqman	Pointer to mesh entity database
entities	Entity handles for which to store tag data
data_ptrs	Array of pointers to tag values, one pointer for each passed entity.
data_lengths	One value for each entity specifying the length of the tag value for the corresponding entity. Array is required for variable-length tags and is ignored for fixed-length tags.

Implements moab::TagInfo.

Definition at line 363 of file VarLenDenseTag.cpp.

 {
     return set_data( seqman, NULL, entities, false, pointers, lengths );
 }

References entities, and set_data().

◆ tag_iterate()

ErrorCode moab::VarLenDenseTag::tag_iterate	(	SequenceManager *	seqman,
		Error *	error_handler,
		Range::iterator &	iter,
		const Range::iterator &	end,
		void *&	data_ptr,
		bool	allocate
	)

virtual

Access tag data via direct pointer into contiguous blocks.

Iteratively obtain direct access to contiguous blocks of tag storage. This function cannot be used with bit tags because of the compressed bit storage. This function cannot be used with variable length tags because it does not provide a mechanism to determine the length of the value for each entity. This function may be used with sparse tags, but if it is used, it will return data for a single entity at a time.

Parameters

iter	As input, the first entity for which to return data. As output, one past the last entity for which data was returned.
end	One past the last entity for which data is desired
data_ptr	Output: pointer to tag storage.
allocate	If true, space for this tag will be allocated, if not it wont

\Note If this function is called for entities for which no tag value has been set, but for which a default value exists, it will force the allocation of explicit storage for each such entity even though MOAB would normally not explicitly store tag values for such entities.

Implements moab::TagInfo.

Definition at line 450 of file VarLenDenseTag.cpp.

 {
     MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "Cannot iterate over variable-length tag data" );
 }

References MB_SET_ERR, and MB_VARIABLE_DATA_LENGTH.

Member Data Documentation

◆ meshValue

VarLenTag moab::VarLenDenseTag::meshValue

private

Definition at line 26 of file VarLenDenseTag.hpp.

Referenced by get_array(), and get_memory_use().

◆ mySequenceArray

int moab::VarLenDenseTag::mySequenceArray

private

Array index in SequenceManager used to store tag data.

Definition at line 24 of file VarLenDenseTag.hpp.

Referenced by find_entities_with_value(), get_array(), get_memory_use(), get_tagged_entities(), num_tagged_entities(), release_all_data(), and ~VarLenDenseTag().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VarLenDenseTag() [1/2]

◆ ~VarLenDenseTag()

◆ VarLenDenseTag() [2/2]

Member Function Documentation

◆ clear_data() [1/2]

◆ clear_data() [2/2]

◆ create_tag()

◆ find_entities_with_value()

◆ get_array() [1/2]

◆ get_array() [2/2]

◆ get_data() [1/4]

◆ get_data() [2/4]

◆ get_data() [3/4]

◆ get_data() [4/4]

◆ get_memory_use()

◆ get_storage_type()

◆ get_tagged_entities()

◆ is_tagged()

◆ num_tagged_entities()

◆ operator=()

◆ release_all_data()

◆ remove_data() [1/2]

◆ remove_data() [2/2]

◆ set_data() [1/6]

◆ set_data() [2/6]

◆ set_data() [3/6]

◆ set_data() [4/6]

◆ set_data() [5/6]

◆ set_data() [6/6]

◆ tag_iterate()

Member Data Documentation

◆ meshValue

◆ mySequenceArray