DataObject.h

Go to the documentation of this file.

/**
 *  \file IMP/core/DataObject.h
 *  \brief Helper class for creating an IMP object storing some data.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCORE_DATA_OBJECT_H
#define IMPCORE_DATA_OBJECT_H

#include <IMP/core/core_config.h>
#include <IMP/Object.h>

IMPCORE_BEGIN_NAMESPACE

//! Helper class for creating an IMP object storing some data.
/** This can be used to, eg, add the data to a particle as part of a cache.

    This class is C++ only.
 */
template <class Data>
class DataObject : public IMP::Object {
  Data data_;

 public:
  DataObject(const Data &d, std::string name = "DataObject %1%")
      : Object(name), data_(d) {}
  const Data &get_data() const { return data_; }
  Data &access_data() { return data_; }
  IMP_OBJECT_METHODS(DataObject);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_DATA_OBJECT_H */