RMF
validate.h
Go to the documentation of this file.
1 /**
2  * \file RMF/validate.h
3  * \brief Support for validating the data in a file.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef RMF_VALIDATE_H
10 #define RMF_VALIDATE_H
11 
12 #include <memory>
13 #include <string>
14 #include <vector>
15 
16 #include "FileHandle.h"
17 #include "RMF/FileConstHandle.h"
18 #include "RMF/NodeConstHandle.h"
19 #include "RMF/config.h"
20 
21 RMF_ENABLE_WARNINGS
22 
23 namespace RMF {
24 //! Validate the hierarchy, throwing an exception if any problems were found.
25 /** \throw exception if it is not valid and log any errors encountered.
26 
27  Checks invariants, such as all representation leaves having
28  coordinates and radii.
29  */
30 RMFEXPORT void validate(FileConstHandle fh);
31 
32 } /* namespace RMF */
33 
34 RMF_DISABLE_WARNINGS
35 
36 #endif /* RMF_VALIDATE_H */
FileHandle.h
Declaration for RMF::FileHandle.
NodeConstHandle.h
Declaration of NodeConstHandle.
FileConstHandle.h
Handle read/write of Model data from/to files.
RMF::validate
void validate(FileConstHandle fh)
Validate the hierarchy, throwing an exception if any problems were found.