votca 2024-dev
Loading...
Searching...
No Matches
topologyreader.h
Go to the documentation of this file.
1/*
2 * Copyright 2009-2019 The VOTCA Development Team (http://www.votca.org)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17
18#ifndef VOTCA_CSG_TOPOLOGYREADER_H
19#define VOTCA_CSG_TOPOLOGYREADER_H
20
21// Standard includes
22#include <string>
23
24// Local VOTCA includes
25#include "fileformatfactory.h"
26#include "topology.h"
27
28namespace votca {
29namespace csg {
30
32 public:
33 virtual ~TopologyReader() = default;
35 virtual bool ReadTopology(std::string file, Topology &top) = 0;
36
37 static void RegisterPlugins(void);
38};
39
40// important - singleton pattern, make sure factory is created before accessed
42 static FileFormatFactory<TopologyReader> TopReaderFactory_;
43 return TopReaderFactory_;
44}
45} // namespace csg
46} // namespace votca
47
48#endif // VOTCA_CSG_TOPOLOGYREADER_H
virtual bool ReadTopology(std::string file, Topology &top)=0
open, read and close topology file
static void RegisterPlugins(void)
virtual ~TopologyReader()=default
topology of the whole system
Definition topology.h:81
FileFormatFactory< TopologyReader > & TopReaderFactory()
base class for all analysis tools
Definition basebead.h:33