RMF
signature.h
Go to the documentation of this file.
1 /**
2  * \file RMF/signature.h
3  * \brief Return a (long) string describing a file that can be compared.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef RMF_SIGNATURE_H
10 #define RMF_SIGNATURE_H
11 
12 #include "RMF/config.h"
13 #include "FileConstHandle.h"
14 
15 RMF_ENABLE_WARNINGS
16 
17 namespace RMF {
18 
19 //! Return a string that captures information about the file.
20 /** This string can be saved and compared against the string generated
21  with future versions of the library to make sure that the old files
22  parse reasonably well. The strings are diffable. */
23 RMFEXPORT std::string get_signature_string(FileConstHandle file);
24 
25 } /* namespace RMF */
26 
27 RMF_DISABLE_WARNINGS
28 
29 #endif /* RMF_SIGNATURE_H */
RMF::get_signature_string
std::string get_signature_string(FileConstHandle file)
Return a string that captures information about the file.
FileConstHandle.h
Handle read/write of Model data from/to files.