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

#include <DenseTag.hpp>

Inheritance diagram for moab::DenseTag:

Collaboration diagram for moab::DenseTag:

Public Member Functions
virtual	~DenseTag ()

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=true)
	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_handler, 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...

ErrorCode	get_array (const SequenceManager seqman, Error error, EntityHandle h, const unsigned char *const &ptr, size_t &count) const
	Get read-only tag storage. More...

ErrorCode	get_array (const EntitySequence seq, const unsigned char const &ptr) const
	Get read-only tag storage for entire sequence. 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 DenseTag *	create_tag (SequenceManager seqman, Error error, const char name, int bytes, DataType type, const void default_value)

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

Private Member Functions
	DenseTag (int array_index, const char name, int size, DataType type, const void default_value)

	DenseTag (const DenseTag &)

DenseTag &	operator= (const DenseTag &)

ErrorCode	get_array_private (SequenceManager seqman, Error error, EntityHandle h, unsigned char *&ptr, size_t &count, bool allocate)
	Get or allocated tag storage. More...

ErrorCode	get_array_private (const SequenceManager seqman, Error error, EntityHandle h, const unsigned char *&ptr, size_t &count) const
	Get tag storage. More...

ErrorCode	get_array_private (const EntitySequence seq, const unsigned char &ptr) const
	Get non-read-only tag storage for entire sequence. More...

ErrorCode	clear_data (bool allocate, SequenceManager seqman, Error error, const EntityHandle entities, size_t num_entities, const void value_ptr)
	Common implementation of public clear_data and remove_data. More...

ErrorCode	clear_data (bool allocate, SequenceManager seqman, Error error, const Range &entities, const void *value_ptr)
	Common implementation of public clear_data and remove_data. More...

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

unsigned char *	meshValue

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

Detailed Description

Dense storage of fixed-length tag data.

Implement normal dense tag.

Definition at line 20 of file DenseTag.hpp.

Constructor & Destructor Documentation

◆ DenseTag() [1/2]

moab::DenseTag::DenseTag	(	int	array_index,
		const char *	name,
		int	size,
		DataType	type,
		const void *	default_value
	)

private

Definition at line 52 of file DenseTag.cpp.

     : TagInfo( name, size, type, default_value, size ), mySequenceArray( index ), meshValue( 0 )
 {
 }

Referenced by create_tag().

◆ ~DenseTag()

moab::DenseTag::~DenseTag ( )

virtual

Definition at line 77 of file DenseTag.cpp.

 {
     assert( mySequenceArray < 0 );
     delete[] meshValue;
 }

References meshValue, and mySequenceArray.

◆ DenseTag() [2/2]

moab::DenseTag::DenseTag ( const DenseTag & )

private

Member Function Documentation

◆ clear_data() [1/4]

ErrorCode moab::DenseTag::clear_data	(	bool	allocate,
		SequenceManager *	seqman,
		Error *	error,
		const EntityHandle *	entities,
		size_t	num_entities,
		const void *	value_ptr
	)

private

Common implementation of public clear_data and remove_data.

Definition at line 433 of file DenseTag.cpp.

 {
     ErrorCode rval;
     const EntityHandle* const end = entities + num_entities;
     unsigned char* array          = NULL;
     size_t junk                   = 0;
  
     for( const EntityHandle* i = entities; i != end; ++i )
     {
         rval = get_array_private( seqman, NULL, *i, array, junk, allocate );MB_CHK_ERR( rval );
  
         if( array )  // Array should never be null if allocate == true
             memcpy( array, value_ptr, get_size() );
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, and MB_SUCCESS.

◆ clear_data() [2/4]

ErrorCode moab::DenseTag::clear_data	(	bool	allocate,
		SequenceManager *	seqman,
		Error *	error,
		const Range &	entities,
		const void *	value_ptr
	)

private

Common implementation of public clear_data and remove_data.

Definition at line 456 of file DenseTag.cpp.

 {
     ErrorCode rval;
     unsigned char* array = NULL;
     size_t avail         = 0;
  
     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_private( seqman, NULL, start, array, avail, allocate );MB_CHK_ERR( rval );
  
             const size_t count = std::min< size_t >( p->second - start + 1, avail );
             if( array )  // Array should never be null if allocate == true
                 SysUtil::setmem( array, value_ptr, get_size(), count );
             start += count;
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, and moab::SysUtil::setmem().

◆ clear_data() [3/4]

ErrorCode moab::DenseTag::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 483 of file DenseTag.cpp.

 {
     if( value_len && value_len != get_size() ) return MB_INVALID_SIZE;
  
     return clear_data( true, seqman, NULL, entities, num_entities, value_ptr );
 }

References entities, moab::TagInfo::get_size(), and MB_INVALID_SIZE.

Referenced by clear_data(), and remove_data().

◆ clear_data() [4/4]

ErrorCode moab::DenseTag::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 495 of file DenseTag.cpp.

 {
     if( value_len && value_len != get_size() ) return MB_INVALID_SIZE;
  
     return clear_data( true, seqman, NULL, entities, value_ptr );
 }

References clear_data(), entities, moab::TagInfo::get_size(), and MB_INVALID_SIZE.

◆ create_tag()

DenseTag * moab::DenseTag::create_tag	(	SequenceManager *	seqman,
		Error *	error,
		const char *	name,
		int	bytes,
		DataType	type,
		const void *	default_value
	)

static

Definition at line 62 of file DenseTag.cpp.

 {
     if( bytes < 1 ) return 0;
  
     int index;
     if( MB_SUCCESS != seqman->reserve_tag_array( NULL, bytes, index ) ) return 0;
  
     return new DenseTag( index, name, bytes, type, default_value );
 }

References DenseTag(), MB_SUCCESS, and moab::SequenceManager::reserve_tag_array().

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

◆ find_entities_with_value()

ErrorCode moab::DenseTag::find_entities_with_value	(	const SequenceManager *	seqman,
		Error *	error_handler,
		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 594 of file DenseTag.cpp.

 {
     if( value_bytes && value_bytes != get_size() )
     {
         MB_SET_ERR( MB_INVALID_SIZE,
                     "Cannot compare data of size " << value_bytes << " with tag of size " << get_size() );
     }
  
     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_values_equal( *this, value, get_size(), start, end, output_entities );
                 }
             }
         }
     }
     else
     {
         const unsigned char* array = NULL;  // Initialize to get rid of warning
         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, NULL, 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_values_equal( *this, value, get_size(), 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(), ErrorCode, moab::find_tag_values_equal(), get_array(), moab::TagInfo::get_size(), moab::Range::lower_bound(), MB_CHK_ERR, MB_INVALID_SIZE, MB_SET_ERR, MB_SUCCESS, MBMAXTYPE, mySequenceArray, moab::TYPE_FROM_HANDLE(), and moab::type_range().

◆ get_array() [1/2]

ErrorCode moab::DenseTag::get_array	(	const EntitySequence *	seq,
		const unsigned char *const &	ptr
	)		const

Get read-only tag storage for entire sequence.

Parameters

seq	Sequence
ptr	Pointer to dag storage. This pointer will be set to null and `MB_SUCCESS` will be returned if no tag storage has been allocated.

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

Definition at line 134 of file DenseTag.cpp.

 {
     // cast away the constness; otherwise it would be infinite recursion
     // probably we are not calling this anywhere
     return get_array_private( seq, const_cast< const unsigned char*& >( ptr ) );
 }

References get_array_private().

◆ get_array() [2/2]

ErrorCode moab::DenseTag::get_array	(	const SequenceManager *	seqman,
		Error *	error,
		EntityHandle	h,
		const unsigned char *const &	ptr,
		size_t &	count
	)		const

Get read-only tag storage.

Parameters

seqman	Sequence manager
error	Error object through which to report errors
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 90 of file DenseTag.cpp.

 {
     //  cast away the const-ness; do we really want to do this?
     // probably we are not calling this anywhere;
     // clang compiler found this
     return get_array_private( seqman, NULL, h, const_cast< const unsigned char*& >( ptr ), count );
 }

References get_array_private().

Referenced by find_entities_with_value(), get_data(), is_tagged(), and moab::WriteDamsel::map_dense_tags().

◆ get_array_private() [1/3]

ErrorCode moab::DenseTag::get_array_private	(	const EntitySequence *	seq,
		const unsigned char *&	ptr
	)		const

private

Get non-read-only tag storage for entire sequence.

Parameters

seq	Sequence
ptr	Pointer to dag storage. This pointer will be set to null and `MB_SUCCESS` will be returned if no tag storage has been allocated.

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

Definition at line 141 of file DenseTag.cpp.

 {
     ptr = reinterpret_cast< const unsigned char* >( seq->data()->get_tag_data( mySequenceArray ) );
     if( ptr ) ptr += get_size() * ( seq->start_handle() - seq->data()->start_handle() );
  
     return MB_SUCCESS;
 }

References moab::EntitySequence::data(), moab::TagInfo::get_size(), moab::SequenceData::get_tag_data(), MB_SUCCESS, mySequenceArray, moab::EntitySequence::start_handle(), and moab::SequenceData::start_handle().

◆ get_array_private() [2/3]

ErrorCode moab::DenseTag::get_array_private	(	const SequenceManager *	seqman,
		Error *	error,
		EntityHandle	h,
		const unsigned char *&	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 102 of file DenseTag.cpp.

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

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

◆ get_array_private() [3/3]

ErrorCode moab::DenseTag::get_array_private	(	SequenceManager *	seqman,
		Error *	error,
		EntityHandle	h,
		unsigned char *&	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 149 of file DenseTag.cpp.

 {
     EntitySequence* seq = 0;
     ErrorCode rval      = seqman->find( h, seq );
     if( MB_SUCCESS != rval )
     {
         if( !h )
         {  // Root set
             if( !meshValue && allocate ) meshValue = new unsigned char[get_size()];
             ptr   = meshValue;
             count = 1;
             return MB_SUCCESS;
         }
         else
         {  // Not root set
             ptr   = 0;
             count = 0;
             return ent_not_found( get_name(), h );
         }
     }
  
     void* mem = seq->data()->get_tag_data( mySequenceArray );
     if( !mem && allocate )
     {
         mem = seq->data()->allocate_tag_array( mySequenceArray, get_size(), get_default_value() );
         if( !mem )
         {
             MB_SET_ERR( MB_MEMORY_ALLOCATION_FAILED, "Memory allocation for dense tag data failed" );
         }
  
         if( !get_default_value() ) memset( mem, 0, get_size() * seq->data()->size() );
     }
  
     ptr   = reinterpret_cast< unsigned char* >( mem );
     count = seq->data()->end_handle() - h + 1;
     if( ptr ) ptr += get_size() * ( h - seq->data()->start_handle() );
     return MB_SUCCESS;
 }

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

Referenced by clear_data(), get_array(), set_data(), and tag_iterate().

◆ get_data() [1/4]

ErrorCode moab::DenseTag::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 251 of file DenseTag.cpp.

 {
     ErrorCode result;
     const EntityHandle* const end = entities + num_entities;
     size_t junk                   = 0;
     const unsigned char* ptr      = NULL;  // Initialize to get rid of warning
  
     if( data_lengths )
     {
         const int len = get_size();
         SysUtil::setmem( data_lengths, &len, sizeof( int ), num_entities );
     }
  
     for( const EntityHandle* i = entities; i != end; ++i, ++pointers )
     {
         result = get_array( seqman, NULL, *i, ptr, junk );MB_CHK_ERR( result );
  
         if( ptr )
             *pointers = ptr;
         else if( get_default_value() )
             *pointers = get_default_value();
         else
             return not_found( get_name(), *i );
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_name(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, moab::not_found(), and moab::SysUtil::setmem().

◆ get_data() [2/4]

ErrorCode moab::DenseTag::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 193 of file DenseTag.cpp.

 {
     size_t junk                   = 0;
     unsigned char* ptr            = reinterpret_cast< unsigned char* >( adata );
     const EntityHandle* const end = entities + num_entities;
     for( const EntityHandle* i = entities; i != end; ++i, ptr += get_size() )
     {
         const unsigned char* data = 0;
         ErrorCode rval            = get_array( seqman, NULL, *i, data, junk );MB_CHK_ERR( rval );
  
         if( data )
             memcpy( ptr, data, get_size() );
         else if( get_default_value() )
             memcpy( ptr, get_default_value(), get_size() );
         else
             return not_found( get_name(), *i );
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_name(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, and moab::not_found().

◆ get_data() [3/4]

ErrorCode moab::DenseTag::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 284 of file DenseTag.cpp.

 {
     ErrorCode rval;
     size_t avail               = 0;
     const unsigned char* array = NULL;
  
     if( data_lengths )
     {
         int len = get_size();
         SysUtil::setmem( data_lengths, &len, sizeof( int ), entities.size() );
     }
  
     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 )
             {
                 for( EntityHandle end = start + count; start != end; ++start )
                 {
                     *pointers = array;
                     array += get_size();
                     ++pointers;
                 }
             }
             else if( const void* val = get_default_value() )
             {
                 SysUtil::setmem( pointers, &val, sizeof( void* ), count );
                 pointers += count;
                 start += count;
             }
             else
             {
                 return not_found( get_name(), start );
             }
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_name(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, moab::not_found(), and moab::SysUtil::setmem().

◆ get_data() [4/4]

ErrorCode moab::DenseTag::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 218 of file DenseTag.cpp.

 {
     ErrorCode rval;
     size_t avail               = 0;
     const unsigned char* array = NULL;  // Initialize to get rid of warning
     unsigned char* data        = reinterpret_cast< unsigned char* >( values );
  
     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 )
                 memcpy( data, array, get_size() * count );
             else if( get_default_value() )
                 SysUtil::setmem( data, get_default_value(), get_size(), count );
             else
                 return not_found( get_name(), start );
  
             data += get_size() * count;
             start += count;
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array(), moab::TagInfo::get_default_value(), moab::TagInfo::get_name(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, moab::not_found(), and moab::SysUtil::setmem().

◆ get_memory_use()

ErrorCode moab::DenseTag::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 672 of file DenseTag.cpp.

 {
     per_entity = get_size();
     total      = TagInfo::get_memory_use() + sizeof( *this );
     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 )
         {
             if( ( *i )->data() != prev_data && ( *i )->data()->get_tag_data( mySequenceArray ) )
             {
                 prev_data = ( *i )->data();
                 total += get_size() * ( *i )->data()->size();
             }
         }
     }
  
     return MB_SUCCESS;
 }

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

◆ get_storage_type()

TagType moab::DenseTag::get_storage_type ( ) const

virtual

Implements moab::TagInfo.

Definition at line 57 of file DenseTag.cpp.

 {
     return MB_TAG_DENSE;
 }

References MB_TAG_DENSE.

◆ get_tagged_entities()

ErrorCode moab::DenseTag::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 559 of file DenseTag.cpp.

 {
     Range tmp;
     Range* entities                           = intersect_list ? &tmp : &entities_in;
     Range::iterator hint                      = entities->begin();
     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 )
             if( ( *i )->data()->get_tag_data( mySequenceArray ) )
                 hint = entities->insert( hint, ( *i )->start_handle(), ( *i )->end_handle() );
     }
  
     if( intersect_list ) entities_in = intersect( *entities, *intersect_list );
  
     return MB_SUCCESS;
 }

References moab::TypeSequenceManager::begin(), moab::TypeSequenceManager::end(), entities, moab::SequenceManager::entity_map(), moab::intersect(), MB_SUCCESS, mySequenceArray, and moab::type_range().

Referenced by num_tagged_entities().

◆ is_tagged()

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

virtual

Check if entity is tagged.

Implements moab::TagInfo.

Definition at line 665 of file DenseTag.cpp.

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

References get_array(), and MB_SUCCESS.

◆ num_tagged_entities()

ErrorCode moab::DenseTag::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 582 of file DenseTag.cpp.

 {
     Range tmp;
     ErrorCode rval = get_tagged_entities( seqman, tmp, type, intersect );
     output_count += tmp.size();
  
     return rval;
 }

References ErrorCode, get_tagged_entities(), moab::intersect(), and moab::Range::size().

◆ operator=()

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

private

◆ release_all_data()

ErrorCode moab::DenseTag::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 83 of file DenseTag.cpp.

 {
     ErrorCode result = seqman->release_tag_array( NULL, mySequenceArray, delete_pending );
     if( MB_SUCCESS == result && delete_pending ) mySequenceArray = -1;
     return result;
 }

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

◆ remove_data() [1/2]

ErrorCode moab::DenseTag::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 506 of file DenseTag.cpp.

 {
     std::vector< unsigned char > zeros;
     const void* value = get_default_value();
     if( !value )
     {
         zeros.resize( get_size(), 0 );
         value = &zeros[0];
     }
  
     return clear_data( false, seqman, NULL, entities, num_entities, value );
 }

References clear_data(), entities, moab::TagInfo::get_default_value(), and moab::TagInfo::get_size().

◆ remove_data() [2/2]

ErrorCode moab::DenseTag::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 522 of file DenseTag.cpp.

 {
     std::vector< unsigned char > zeros;
     const void* value = get_default_value();
     if( !value )
     {
         zeros.resize( get_size(), 0 );
         value = &zeros[0];
     }
  
     return clear_data( false, seqman, NULL, entities, value );
 }

References clear_data(), entities, moab::TagInfo::get_default_value(), and moab::TagInfo::get_size().

◆ set_data() [1/4]

ErrorCode moab::DenseTag::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 333 of file DenseTag.cpp.

 {
     ErrorCode rval;
     const unsigned char* ptr      = reinterpret_cast< const unsigned char* >( data );
     const EntityHandle* const end = entities + num_entities;
     unsigned char* array          = NULL;
     size_t junk                   = 0;
  
     for( const EntityHandle* i = entities; i != end; ++i, ptr += get_size() )
     {
         rval = get_array_private( seqman, NULL, *i, array, junk, true );MB_CHK_ERR( rval );
  
         memcpy( array, ptr, get_size() );
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, and MB_SUCCESS.

◆ set_data() [2/4]

ErrorCode moab::DenseTag::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 379 of file DenseTag.cpp.

 {
     ErrorCode rval = validate_lengths( NULL, data_lengths, num_entities );MB_CHK_ERR( rval );
  
     const EntityHandle* const end = entities + num_entities;
     unsigned char* array          = NULL;
     size_t junk                   = 0;
  
     for( const EntityHandle* i = entities; i != end; ++i, ++pointers )
     {
         rval = get_array_private( seqman, NULL, *i, array, junk, true );MB_CHK_ERR( rval );
  
         memcpy( array, *pointers, get_size() );
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, MB_SUCCESS, and moab::TagInfo::validate_lengths().

◆ set_data() [3/4]

ErrorCode moab::DenseTag::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 355 of file DenseTag.cpp.

 {
     ErrorCode rval;
     const char* data     = reinterpret_cast< const char* >( values );
     unsigned char* array = NULL;
     size_t avail         = 0;
  
     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_private( seqman, NULL, start, array, avail, true );MB_CHK_ERR( rval );
  
             const size_t count = std::min< size_t >( p->second - start + 1, avail );
             memcpy( array, data, get_size() * count );
             data += get_size() * count;
             start += count;
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, and MB_SUCCESS.

◆ set_data() [4/4]

ErrorCode moab::DenseTag::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 402 of file DenseTag.cpp.

 {
     ErrorCode rval;
     unsigned char* array = NULL;
     size_t avail         = 0;
  
     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_private( seqman, NULL, start, array, avail, true );MB_CHK_ERR( rval );
  
             const EntityHandle end = std::min< EntityHandle >( p->second + 1, start + avail );
             while( start != end )
             {
                 memcpy( array, *pointers, get_size() );
                 ++start;
                 ++pointers;
                 array += get_size();
             }
         }
     }
  
     return MB_SUCCESS;
 }

References entities, ErrorCode, get_array_private(), moab::TagInfo::get_size(), MB_CHK_ERR, and MB_SUCCESS.

◆ tag_iterate()

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

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.

\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 535 of file DenseTag.cpp.

 {
     // If asked for nothing, successfully return nothing.
     if( iter == end ) return MB_SUCCESS;
  
     unsigned char* array = NULL;
     size_t avail         = 0;
     ErrorCode rval       = get_array_private( seqman, NULL, *iter, array, avail, allocate );MB_CHK_ERR( rval );
     data_ptr = array;
  
     size_t count = std::min< size_t >( avail, *( iter.end_of_block() ) - *iter + 1 );
     if( 0 != *end && *end <= *( iter.end_of_block() ) )
         iter = end;
     else
         iter += count;
  
     return MB_SUCCESS;
 }

References moab::Range::const_iterator::end_of_block(), ErrorCode, get_array_private(), MB_CHK_ERR, and MB_SUCCESS.

Member Data Documentation

◆ meshValue

unsigned char* moab::DenseTag::meshValue

private

Definition at line 25 of file DenseTag.hpp.

Referenced by get_array_private(), and ~DenseTag().

◆ mySequenceArray

int moab::DenseTag::mySequenceArray

private

Array index in SequenceManager used to store tag data.

Definition at line 23 of file DenseTag.hpp.

Referenced by find_entities_with_value(), get_array_private(), get_memory_use(), get_tagged_entities(), release_all_data(), and ~DenseTag().

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

◆ DenseTag() [1/2]

◆ ~DenseTag()

◆ DenseTag() [2/2]

Member Function Documentation

◆ clear_data() [1/4]

◆ clear_data() [2/4]

◆ clear_data() [3/4]

◆ clear_data() [4/4]

◆ create_tag()

◆ find_entities_with_value()

◆ get_array() [1/2]

◆ get_array() [2/2]

◆ get_array_private() [1/3]

◆ get_array_private() [2/3]

◆ get_array_private() [3/3]

◆ 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/4]

◆ set_data() [2/4]

◆ set_data() [3/4]

◆ set_data() [4/4]

◆ tag_iterate()

Member Data Documentation

◆ meshValue

◆ mySequenceArray