SparseTagSuperCollection.hpp

Go to the documentation of this file.

/**********************************************
 * Filename   :     SparseTagSuperCollection.hpp
 *
 * Purpose    :     To store any size data with
 *                  any entity handle
 *
 * Creator    :     Clinton Stimpson
 *
 * Date       :     3 April 2002
 *
 * ********************************************/



#ifndef SPARSE_TAG_SUPER_COLLECTION_HPP
#define SPARSE_TAG_SUPER_COLLECTION_HPP

#ifndef IS_BUILDING_MB
#error "SparseTagSuperCollection.hpp isn't supposed to be included into an application"
#endif

#ifdef WIN32
#pragma warning(disable : 4786)
#endif

#include <map>
#include <vector>

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

#define get_collection( A ) ((A) < mDataTags.size() ? mDataTags[(A)] : 0)

namespace moab {

class SparseTagCollection;

class SparseTagSuperCollection
{
public:
  SparseTagSuperCollection(){}
  
  virtual ~SparseTagSuperCollection();

  void reset_data();

  ErrorCode reserve_tag_id(int data_size, TagId tag_id);

  ErrorCode release_tag_id(TagId tag_id);

  int tag_size(const TagId tag_id) const;

  ErrorCode set_data( TagId tag_handle,
                        const EntityHandle* handles,
                        int num_handles,
                        const void* data );

  ErrorCode set_data( TagId tag_handle,
                        const EntityHandle* handles,
                        int num_handles,
                        void const* const* data_pointers,
                        const int* lengths = 0,
                        bool one_value = false );

  ErrorCode set_data( TagId tag_handle,
                        const Range& handles,
                        const void* data );

  ErrorCode set_data( TagId tag_handle,
                        const Range& handles,
                        void const* const* data_pointers,
                        const int* lengths = 0,
                        bool one_value = false );

  ErrorCode tag_iterate( TagId tag_handle,
                         Range::iterator& iter,
                         const Range::iterator& end,
                         void*& data_ptr,
                         const void* default_value );
  
  ErrorCode get_data( TagId tag_handle,
                        const EntityHandle* handles,
                        int num_handles,
                        void* data,
                        const void* default_value ) const;
  
  ErrorCode get_data( TagId tag_handle,
                        const EntityHandle* handles,
                        int num_handles,
                        const void** data,
                        int* lengths,
                        const void* default_value,
                        int default_value_length ) const;
  
  ErrorCode get_data( TagId tag_handle,
                        const Range& handles,
                        void* data,
                        const void* default_value ) const;
  
  ErrorCode get_data( TagId tag_handle,
                        const Range& handles,
                        const void** data,
                        int* lengths,
                        const void* default_value,
                        int default_value_length ) const;

  ErrorCode remove_data(const TagId tag_handle, const EntityHandle entity_handle);

  ErrorCode get_entities(const TagId tag_handle, Range &entities);

  ErrorCode get_entities(const TagId tag_handle, const EntityType type,
                            Range &entities);

  ErrorCode get_entities(const Range &range,
                            const TagId tag_handle, const EntityType type,
                            Range &entities);

  ErrorCode get_tags(const EntityHandle entity,
                       std::vector<Tag> &all_tags);
  
  ErrorCode get_entities_with_tag_value( const TagId tag_handle, 
                                           const TagInfo& tag_info,
                                           const EntityType type,
                                           Range &entities,
                                           const void* tag_value,
                                           int value_size);

  ErrorCode get_entities_with_tag_value( const Range &range,
                                           const TagId tag_handle, 
                                           const TagInfo& tag_info,
                                           const EntityType type,
                                           Range &entities,
                                           const void* tag_value,
                                           int value_size);

  ErrorCode get_number_entities(const TagId tag_handle, const EntityType type, int& num_ent);


  ErrorCode get_number_entities(const Range &range,
                                   const TagId tag_handle, const EntityType type, int& num_ent);

  ErrorCode get_memory_use( TagId tag_id, 
                              unsigned long& total,
                              unsigned long& per_entity );

private:

  std::vector<SparseTagCollection*> mDataTags;
};

} // namespace moab

#endif //SPARSE_TAG_SUPER_COLLECTION_HPP