trajectoryreader.h

Go to the documentation of this file.

/*
 * Copyright 2009-2019 The VOTCA Development Team (http://www.votca.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef VOTCA_CSG_TRAJECTORYREADER_H
#define VOTCA_CSG_TRAJECTORYREADER_H
 
// Standard includes
#include <string>
 
// Local VOTCA includes
#include "fileformatfactory.h"
#include "topology.h"
 
namespace votca {
namespace csg {
 
class TrajectoryReader {
 public:
  virtual ~TrajectoryReader() = default;
  virtual bool Open(const std::string &file) = 0;
 
  virtual void Close() {};
 
  virtual bool FirstFrame(Topology &top) = 0;
  virtual bool NextFrame(Topology &top) = 0;
 
  static void RegisterPlugins(void);
};
 
// important - singleton pattern, make sure factory is created before accessed
inline FileFormatFactory<TrajectoryReader> &TrjReaderFactory() {
  static FileFormatFactory<TrajectoryReader> TrjReaderFactory_;
  return TrjReaderFactory_;
}
 
}  // namespace csg
}  // namespace votca
 
#endif /*  VOTCA_CSG_TRAJECTORYREADER_H */