EntitySequence.hpp

Go to the documentation of this file.

#ifndef ENTITY_SEQUENCE_HPP
#define ENTITY_SEQUENCE_HPP

#include "moab/Types.hpp"
#include "Internals.hpp"

namespace moab {

class SequenceData;

class EntitySequence {
private:
  EntityHandle startHandle, endHandle;
  SequenceData* sequenceData;

protected:

  EntitySequence( EntityHandle h )
    : startHandle(h), endHandle(h) {}

  EntitySequence( EntitySequence& split_from, EntityHandle here )
    : startHandle( here ),
      endHandle( split_from.endHandle ),
      sequenceData( split_from.sequenceData )
  {
    split_from.endHandle = here - 1;
  }

  SequenceData* create_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 );

public:

  EntitySequence( EntityHandle start, EntityID count, SequenceData* dat )
    : startHandle(start), endHandle( start + count - 1 ), sequenceData( dat )
    {}

  virtual ~EntitySequence() {}

  EntityType type() const
    { return TYPE_FROM_HANDLE(start_handle()); }

  EntityHandle start_handle() const
    { return startHandle; }
  
  EntityHandle end_handle() const
    { return endHandle; }
  
  SequenceData* data() const
    { return sequenceData; }
    
  void data( SequenceData* ptr )
    { sequenceData = ptr; }
  
  EntityID size() const
    { return endHandle - startHandle + 1; }
    
  bool using_entire_data() const;
  
  virtual int values_per_entity() const;
  
  virtual EntitySequence* split( EntityHandle here ) = 0;

  virtual ErrorCode merge( EntitySequence& other );
  
  virtual ErrorCode pop_back( EntityID count );
  
  virtual ErrorCode pop_front( EntityID count );
  
  virtual SequenceData* create_data_subset( EntityHandle start_handle,
                                            EntityHandle end_handle ) const = 0;

  virtual void get_const_memory_use( unsigned long& bytes_per_entity,
                                     unsigned long& size_of_sequence ) const = 0;
  virtual unsigned long get_per_entity_memory_use( EntityHandle first,
                                                   EntityHandle last ) const;
};
  
} // namespace moab

#endif