Mesh Oriented datABase  (version 5.5.1)
An array-based unstructured mesh library
moab::TypeSequenceManager::DummySequence Class Reference

Dummy EntitySequence for use in querying set container. More...

#include <TypeSequenceManager.hpp>

+ Inheritance diagram for moab::TypeSequenceManager::DummySequence:
+ Collaboration diagram for moab::TypeSequenceManager::DummySequence:

Public Member Functions

 DummySequence (EntityHandle start)
 
EntitySequencesplit (EntityHandle)
 Split this sequence into two consecutive sequences. More...
 
SequenceDatacreate_data_subset (EntityHandle, EntityHandle) const
 Create a new SequenceData that is a copy of a subset of the one referenced by this sequence. More...
 
void get_const_memory_use (unsigned long &a, unsigned long &b) const
 Get memory characteristcs that are the same for all entities. More...
 
unsigned long get_per_entity_memory_use (EntityHandle, EntityHandle) const
 Get portion of memory use that varies per entity. More...
 
- Public Member Functions inherited from moab::EntitySequence
 EntitySequence (EntityHandle start, EntityID count, SequenceData *dat)
 
virtual ~EntitySequence ()
 
EntityType type () const
 
EntityHandle start_handle () const
 
EntityHandle end_handle () const
 
SequenceDatadata () const
 
void data (SequenceData *ptr)
 
EntityID size () const
 
bool using_entire_data () const
 True if SequenceData has no holes and is used only by this EntitySequence. More...
 
virtual int values_per_entity () const
 Integer value used in finding appropriate SequenceData. More...
 
virtual ErrorCode merge (EntitySequence &other)
 Merge this sequence with another. More...
 
virtual ErrorCode pop_back (EntityID count)
 Erase entities in range: (end_handle()-count, end_handle()]. More...
 
virtual ErrorCode pop_front (EntityID count)
 Erase entities in range: [start_handle(), start_handle()+count) More...
 

Additional Inherited Members

- Protected Member Functions inherited from moab::EntitySequence
 EntitySequence (EntityHandle h)
 
 EntitySequence (EntitySequence &split_from, EntityHandle here)
 
SequenceDatacreate_data_subset (EntityHandle start_handle, EntityHandle end_handle, int num_sequence_arrays, unsigned const *bytes_per_element) const
 
ErrorCode prepend_entities (EntityID count)
 
ErrorCode append_entities (EntityID count)
 

Detailed Description

Dummy EntitySequence for use in querying set container.

Definition at line 40 of file TypeSequenceManager.hpp.

Constructor & Destructor Documentation

◆ DummySequence()

moab::TypeSequenceManager::DummySequence::DummySequence ( EntityHandle  start)
inline

Definition at line 43 of file TypeSequenceManager.hpp.

43 : EntitySequence( start ) {}

Member Function Documentation

◆ create_data_subset()

SequenceData* moab::TypeSequenceManager::DummySequence::create_data_subset ( EntityHandle  start_handle,
EntityHandle  end_handle 
) const
inlinevirtual

Create a new SequenceData that is a copy of a subset of the one referenced by this sequence.

Create a new SequenceData that is a copy of a subset of the SequenceData referenced by this EntitySequence. Do not make any changes to this EntitySequence or the current SequenceData.

Implements moab::EntitySequence.

Definition at line 49 of file TypeSequenceManager.hpp.

50  {
51  return 0;
52  }

◆ get_const_memory_use()

void moab::TypeSequenceManager::DummySequence::get_const_memory_use ( unsigned long &  bytes_per_entity,
unsigned long &  size_of_sequence 
) const
inlinevirtual

Get memory characteristcs that are the same for all entities.

Get charactersitic constant memory use for all entities in sequence.

Parameters
bytes_per_entityThe total bytes consumed for each entity in the underlying SequenceData. It is assumed that the same amount of memory is consumed for unused portions of the SequenceData.
size_of_sequenceThe size of the leaf subclass of this class

Implements moab::EntitySequence.

Definition at line 54 of file TypeSequenceManager.hpp.

55  {
56  a = b = 0;
57  }

◆ get_per_entity_memory_use()

unsigned long moab::TypeSequenceManager::DummySequence::get_per_entity_memory_use ( EntityHandle  first,
EntityHandle  last 
) const
inlinevirtual

Get portion of memory use that varies per entity.

Returns
Any per-entity memory use not accounted for in the results of get_const_memory_use.

Reimplemented from moab::EntitySequence.

Definition at line 58 of file TypeSequenceManager.hpp.

59  {
60  return 0;
61  }

◆ split()

EntitySequence* moab::TypeSequenceManager::DummySequence::split ( EntityHandle  here)
inlinevirtual

Split this sequence into two consecutive sequences.

Split this sequence into two sequences.

Parameters
hereNew sequences should be [start_handle(),here) & [here,end_handle()]
Returns
New sequence containing [here,end_handle()]

Implements moab::EntitySequence.

Definition at line 45 of file TypeSequenceManager.hpp.

46  {
47  return 0;
48  }

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