IMP logo
IMP Reference Guide  develop.182d9373c4,2021/04/12
The Integrative Modeling Platform
InputAdaptor.h
Go to the documentation of this file.
1 /**
2  * \file IMP/InputAdaptor.h
3  * \brief Convenience class to accept multiple input types.
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPKERNEL_INPUT_ADAPTOR_H
10 #define IMPKERNEL_INPUT_ADAPTOR_H
11 
12 #include <IMP/kernel_config.h>
13 #include "utility_macros.h"
14 
15 IMPKERNEL_BEGIN_NAMESPACE
16 
17 //! Convenience class to accept multiple input types.
18 /** An input adaptor is a convenience class that allows functions to accept a
19  wider variety of inputs than they would otherwise. The InputAdaptor class
20  itself should not be used directly; it is just provided for purposes of
21  documentation.
22 
23  Input adaptor classes do not support output, comparisons or hashing.
24  */
25 class InputAdaptor {
26  protected:
27  InputAdaptor() {}
28 };
29 
30 IMPKERNEL_END_NAMESPACE
31 
32 #endif /* IMPKERNEL_INPUT_ADAPTOR_H */
Various general useful macros for IMP.
Convenience class to accept multiple input types.
Definition: InputAdaptor.h:25