#include <TagInfo.hpp>

Inheritance diagram for moab::TagInfo:

Collaboration diagram for moab::TagInfo:

Public Member Functions
	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 ()

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

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

virtual TagType	get_storage_type () const =0

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

virtual ErrorCode	get_data (const SequenceManager seqman, Error error_handler, const Range &entities, void *data) const =0
	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 =0
	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 =0
	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)=0
	Set tag value for passed entities. More...

virtual ErrorCode	set_data (SequenceManager seqman, Error error_handler, const Range &entities, const void *data)=0
	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)=0
	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)=0
	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)=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)=0
	Set tag value for passed entities. More...

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

virtual ErrorCode	remove_data (SequenceManager seqman, Error error_handler, const Range &entities)=0
	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)=0
	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 =0
	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 =0
	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 =0
	Get all tagged entities with tag value. More...

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

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

Static Public Member Functions
static int	size_from_data_type (DataType t)

Protected Member Functions
unsigned long	get_memory_use () const

Private Member Functions
	TagInfo (const TagInfo &copy)

TagInfo &	operator= (const TagInfo &copy)

Private Attributes
void *	mDefaultValue
	stores the default data, if any More...

void *	mMeshValue
	store the mesh value, if any More...

int	mDefaultValueSize
	Size of mDefaultValue and mMeshValue, in bytes NOTE: These sizes differ from mDataSize in two cases: a) Variable-length tags b) Bit tags (where mDataSize is bits, not bytes.) More...

int	mMeshValueSize

int	mDataSize
	stores the size of the data for this tag More...

DataType	dataType
	type of tag data More...

std::string	mTagName
	stores the tag name More...

Detailed Description

Examples: DeformMeshRemap.cpp, DirectAccessNoHoles.cpp, DirectAccessWithHoles.cpp, ExtractLand.cpp, LaplacianSmoother.cpp, LloydRelaxation.cpp, LoadPartial.cpp, QuadTriConv.cpp, ReadPartFile.cpp, ReduceExchangeTags.cpp, SetsNTags.cpp, TestErrorHandling.cpp, TestExodusII.cpp, VisTags.cpp, addPCdata.cpp, and copyPartition.cpp.

Definition at line 15 of file TagInfo.hpp.

Constructor & Destructor Documentation

◆ TagInfo() [1/3]

moab::TagInfo::TagInfo ( )

inline

constructor

Definition at line 19 of file TagInfo.hpp.

         : mDefaultValue( NULL ), mMeshValue( NULL ), mDefaultValueSize( 0 ), mMeshValueSize( 0 ), mDataSize( 0 ),
           dataType( MB_TYPE_OPAQUE )
     {
     }

◆ TagInfo() [2/3]

moab::TagInfo::TagInfo	(	const char *	name,
		int	size,
		DataType	type,
		const void *	default_value,
		int	default_value_size
	)

constructor that takes all parameters

Definition at line 11 of file TagInfo.cpp.

     : mDefaultValue( NULL ), mMeshValue( NULL ), mDefaultValueSize( default_value_size ), mMeshValueSize( 0 ),
       mDataSize( size ), dataType( type )
 {
     if( default_value )
     {
         mDefaultValue = malloc( mDefaultValueSize );
         memcpy( mDefaultValue, default_value, mDefaultValueSize );
     }
     if( name ) mTagName = name;
 }

References mDefaultValue, mDefaultValueSize, and mTagName.

◆ ~TagInfo()

moab::TagInfo::~TagInfo ( )

virtual

Definition at line 23 of file TagInfo.cpp.

 {
     free( mDefaultValue );
     mDefaultValue     = 0;
     mDefaultValueSize = 0;
 }

References mDefaultValue, and mDefaultValueSize.

◆ TagInfo() [3/3]

moab::TagInfo::TagInfo ( const TagInfo & copy )

private

Member Function Documentation

◆ check_valid_sizes()

bool moab::TagInfo::check_valid_sizes	(	const int *	sizes,
		int	num_sizes
	)		const

Definition at line 60 of file TagInfo.cpp.

 {
     const unsigned size = size_from_data_type( get_data_type() );
     if( 1 == size ) return true;
  
     unsigned sum = 0;
     for( int i = 0; i < num_sizes; ++i )
         sum |= ( (unsigned)sizes[i] ) % size;
  
     return ( 0 == sum );
 }

References get_data_type(), size, size_from_data_type(), sizes, and moab::sum().

◆ clear_data() [1/2]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ clear_data() [2/2]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ equals_default_value()

bool moab::TagInfo::equals_default_value	(	const void *	data,
		int	size = `-1`
	)		const

compare the passed value to the default value. returns false if no default value.

Definition at line 36 of file TagInfo.cpp.

 {
     if( !get_default_value() ) return false;
  
     if( variable_length() && size != get_default_value_size() ) return false;
  
     if( !variable_length() && size >= 0 && size != get_size() ) return false;
  
     if( get_data_type() == MB_TYPE_BIT )
     {
         assert( get_size() <= 8 && get_default_value_size() == 1 );
         unsigned char byte1 = *reinterpret_cast< const unsigned char* >( data );
         unsigned char byte2 = *reinterpret_cast< const unsigned char* >( get_default_value() );
         unsigned char mask  = (unsigned char)( ( 1u << get_size() ) - 1 );
         return ( byte1 & mask ) == ( byte2 & mask );
     }
     else
     {
         return !memcmp( data, get_default_value(), get_default_value_size() );
     }
 }

References get_data_type(), get_default_value(), get_default_value_size(), get_size(), MB_TYPE_BIT, size, and variable_length().

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

◆ find_entities_with_value()

virtual ErrorCode moab::TagInfo::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

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

Implemented in moab::VarLenSparseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, moab::BitTag, and moab::VarLenDenseTag.

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

◆ get_data() [1/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ get_data() [2/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

Referenced by moab::ParallelComm::packed_tag_size(), moab::Core::tag_get_by_ptr(), and moab::Core::tag_get_data().

◆ get_data() [3/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ get_data() [4/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ get_data_type()

DataType moab::TagInfo::get_data_type ( ) const

inline

Definition at line 73 of file TagInfo.hpp.

     {
         return dataType;
     }

References dataType.

Referenced by check_valid_sizes(), equals_default_value(), moab::find_map_values_equal(), moab::find_map_varlen_values_equal(), moab::find_tag_values_equal(), moab::find_tag_varlen_values_equal(), moab::ParallelComm::pack_tag(), moab::Core::tag_clear_data(), moab::Core::tag_get_by_ptr(), moab::Core::tag_get_data_type(), moab::Core::tag_get_default_value(), moab::Core::tag_get_handle(), moab::Core::tag_get_length(), moab::Core::tag_set_by_ptr(), and validate_lengths().

◆ get_default_value()

const void* moab::TagInfo::get_default_value ( ) const

inline

get the default data

Definition at line 64 of file TagInfo.hpp.

     {
         return mDefaultValue;
     }

References mDefaultValue.

Referenced by moab::SparseTag::allocate_data(), moab::BitTag::default_val(), equals_default_value(), moab::DenseTag::get_array_private(), moab::VarLenDenseTag::get_data(), moab::DenseTag::get_data(), moab::MeshTag::get_data(), moab::SparseTag::get_data(), moab::SparseTag::get_data_ptr(), moab::VarLenSparseTag::get_data_ptr(), moab::ParallelComm::pack_tag(), moab::ParallelComm::packed_tag_size(), moab::DenseTag::remove_data(), moab::Core::tag_get_default_value(), moab::Core::tag_get_handle(), and moab::SparseTag::tag_iterate().

◆ get_default_value_size()

int moab::TagInfo::get_default_value_size ( ) const

inline

get length of default value

Definition at line 58 of file TagInfo.hpp.

     {
         return mDefaultValueSize;
     }

References mDefaultValueSize.

Referenced by equals_default_value(), moab::VarLenDenseTag::get_data(), moab::MeshTag::get_data(), moab::VarLenSparseTag::get_data_ptr(), get_memory_use(), moab::ParallelComm::pack_tag(), moab::ParallelComm::packed_tag_size(), and moab::Core::tag_get_default_value().

◆ get_memory_use() [1/2]

unsigned long moab::TagInfo::get_memory_use ( ) const

inlineprotected

Definition at line 406 of file TagInfo.hpp.

     {
         return get_default_value_size() + get_name().size();
     }

References get_default_value_size(), and get_name().

Referenced by moab::DenseTag::get_memory_use(), moab::MeshTag::get_memory_use(), moab::SparseTag::get_memory_use(), moab::VarLenDenseTag::get_memory_use(), and moab::VarLenSparseTag::get_memory_use().

◆ get_memory_use() [2/2]

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

pure virtual

Get memory use for tag data.

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ get_name()

const std::string& moab::TagInfo::get_name ( ) const

inline

◆ get_size()

int moab::TagInfo::get_size ( ) const

inline

get the size of the data in bytes

Definition at line 79 of file TagInfo.hpp.

     {
         return mDataSize;
     }

References mDataSize.

Referenced by moab::SparseTag::allocate_data(), moab::DenseTag::clear_data(), moab::SparseTag::clear_data(), equals_default_value(), moab::DenseTag::find_entities_with_value(), moab::SparseTag::find_entities_with_value(), moab::VarLenSparseTag::find_entities_with_value(), moab::DenseTag::get_array_private(), moab::DenseTag::get_data(), moab::SparseTag::get_data(), moab::DenseTag::get_memory_use(), moab::SparseTag::get_memory_use(), moab::WriteDamsel::map_sparse_tags(), moab::ParallelComm::pack_tag(), moab::ParallelComm::packed_tag_size(), moab::DenseTag::remove_data(), moab::SparseTag::set_data(), moab::DenseTag::set_data(), moab::MeshTag::set_data(), moab::Core::tag_get_bytes(), moab::Core::tag_get_handle(), moab::Core::tag_get_length(), validate_lengths(), and variable_length().

◆ get_storage_type()

virtual TagType moab::TagInfo::get_storage_type ( ) const

pure virtual

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

Referenced by moab::WriteDamsel::init_tag_info(), moab::Core::tag_get_bytes(), moab::Core::tag_get_handle(), and moab::Core::tag_get_type().

◆ get_tagged_entities()

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ is_tagged()

virtual bool moab::TagInfo::is_tagged	(	const SequenceManager *	seqman,
		EntityHandle	entity
	)		const

pure virtual

Check if entity is tagged.

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ num_tagged_entities()

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ operator=()

TagInfo& moab::TagInfo::operator= ( const TagInfo & copy )

private

◆ release_all_data()

virtual ErrorCode moab::TagInfo::release_all_data	(	SequenceManager *	seqman,
		Error *	error_handler,
		bool	tag_delete_pending
	)

pure virtual

Remove/clear tag data for all entities.

Remove tag values from entities.

Parameters

tag_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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ remove_data() [1/2]

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

pure 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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

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

◆ remove_data() [2/2]

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

pure 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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ set_data() [1/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

Referenced by moab::Core::tag_set_by_ptr(), and moab::Core::tag_set_data().

◆ set_data() [2/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ set_data() [3/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ set_data() [4/4]

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

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

Implemented in moab::VarLenSparseTag, moab::VarLenDenseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, and moab::BitTag.

◆ set_name()

void moab::TagInfo::set_name ( const std::string & name )

inline

set the name of the tag

Definition at line 46 of file TagInfo.hpp.

     {
         mTagName = name;
     }

References mTagName.

◆ size_from_data_type()

int moab::TagInfo::size_from_data_type ( DataType t )

static

Definition at line 30 of file TagInfo.cpp.

 {
     static const int sizes[] = { 1, sizeof( int ), sizeof( double ), 1, sizeof( EntityHandle ), 0 };
     return sizes[t];
 }

References sizes.

Referenced by check_valid_sizes(), moab::ParallelComm::pack_tag(), moab::Core::tag_clear_data(), moab::Core::tag_get_by_ptr(), moab::Core::tag_get_default_value(), moab::Core::tag_get_handle(), moab::Core::tag_get_length(), moab::Core::tag_set_by_ptr(), moab::ParallelComm::unpack_tags(), and validate_lengths().

◆ tag_iterate()

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

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

Implemented in moab::VarLenSparseTag, moab::SparseTag, moab::MeshTag, moab::DenseTag, moab::BitTag, and moab::VarLenDenseTag.

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

◆ validate_lengths()

ErrorCode moab::TagInfo::validate_lengths	(	Error *	error_handler,
		const int *	lengths,
		size_t	num_lengths
	)		const

Returns: MB_VARIABLE_LENGTH_DATA If variable_length() && lengths is NULL MB_INVALID_SIZE If variable_length() && lengths is not NULL && any size is not a multiple of type size. MB_INVALID_SIZE If !variable_length() && lengths is not NULL && any size is not the tag size. MB_SUCCESS Otherwise.

Definition at line 72 of file TagInfo.cpp.

 {
     int bits = 0;
     if( variable_length() )
     {
         if( !lengths )
         {
             MB_SET_ERR( MB_VARIABLE_DATA_LENGTH, "No size specified for variable-length tag" );
         }
         const unsigned type_size = size_from_data_type( get_data_type() );
         if( type_size == 1 ) return MB_SUCCESS;
         for( size_t i = 0; i < num_lengths; ++i )
             bits |= lengths[i] % type_size;
     }
     else if( lengths )
     {
         for( size_t i = 0; i < num_lengths; ++i )
             bits |= lengths[i] - get_size();
     }
     if( 0 == bits ) return MB_SUCCESS;
  
     MB_SET_ERR( MB_INVALID_SIZE, "Tag data with invalid size" );
 }

References get_data_type(), get_size(), MB_INVALID_SIZE, MB_SET_ERR, MB_SUCCESS, MB_VARIABLE_DATA_LENGTH, size_from_data_type(), and variable_length().

Referenced by moab::MeshTag::clear_data(), moab::VarLenSparseTag::clear_data(), moab::VarLenDenseTag::set_data(), moab::DenseTag::set_data(), moab::MeshTag::set_data(), moab::SparseTag::set_data(), and moab::VarLenSparseTag::set_data().

◆ variable_length()

bool moab::TagInfo::variable_length ( ) const

inline

Check if variable-length tag.

Definition at line 85 of file TagInfo.hpp.

     {
         return get_size() == MB_VARIABLE_LENGTH;
     }

References get_size(), and MB_VARIABLE_LENGTH.

Referenced by equals_default_value(), moab::MeshTag::get_data(), moab::MeshTag::set_data(), moab::Core::tag_get_bytes(), moab::Core::tag_get_default_value(), moab::Core::tag_get_handle(), moab::Core::tag_get_length(), and validate_lengths().

Member Data Documentation

◆ dataType

DataType moab::TagInfo::dataType

private

type of tag data

Definition at line 432 of file TagInfo.hpp.

Referenced by get_data_type().

◆ mDataSize

int moab::TagInfo::mDataSize

private

stores the size of the data for this tag

Definition at line 429 of file TagInfo.hpp.

Referenced by get_size().

◆ mDefaultValue

void* moab::TagInfo::mDefaultValue

private

stores the default data, if any

Definition at line 417 of file TagInfo.hpp.

Referenced by get_default_value(), TagInfo(), and ~TagInfo().

◆ mDefaultValueSize

int moab::TagInfo::mDefaultValueSize

private

Size of mDefaultValue and mMeshValue, in bytes NOTE: These sizes differ from mDataSize in two cases: a) Variable-length tags b) Bit tags (where mDataSize is bits, not bytes.)

Definition at line 426 of file TagInfo.hpp.

Referenced by get_default_value_size(), TagInfo(), and ~TagInfo().

◆ mMeshValue

void* moab::TagInfo::mMeshValue

private

store the mesh value, if any

Definition at line 420 of file TagInfo.hpp.

◆ mMeshValueSize

int moab::TagInfo::mMeshValueSize

private

Definition at line 426 of file TagInfo.hpp.

◆ mTagName

std::string moab::TagInfo::mTagName

private

stores the tag name

Definition at line 435 of file TagInfo.hpp.

Referenced by get_name(), set_name(), and TagInfo().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TagInfo() [1/3]

◆ TagInfo() [2/3]

◆ ~TagInfo()

◆ TagInfo() [3/3]

Member Function Documentation

◆ check_valid_sizes()

◆ clear_data() [1/2]

◆ clear_data() [2/2]

◆ equals_default_value()

◆ find_entities_with_value()

◆ get_data() [1/4]

◆ get_data() [2/4]

◆ get_data() [3/4]

◆ get_data() [4/4]

◆ get_data_type()

◆ get_default_value()

◆ get_default_value_size()

◆ get_memory_use() [1/2]

◆ get_memory_use() [2/2]

◆ get_name()

◆ get_size()

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

◆ set_name()

◆ size_from_data_type()

◆ tag_iterate()

◆ validate_lengths()

◆ variable_length()

Member Data Documentation

◆ dataType

◆ mDataSize

◆ mDefaultValue

◆ mDefaultValueSize

◆ mMeshValue

◆ mMeshValueSize

◆ mTagName