IMP logo
IMP Reference Guide  2.18.0
The Integrative Modeling Platform
input_output.h
Go to the documentation of this file.
1 /**
2  * \file IMP/input_output.h
3  * \brief Utility functions to track input/output particles of model objects.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPKERNEL_INPUT_OUTPUT_H
9 #define IMPKERNEL_INPUT_OUTPUT_H
10 
11 #include <IMP/kernel_config.h>
12 #include "base_types.h"
13 #include "container_base.h"
14 #include "Particle.h"
15 
16 IMPKERNEL_BEGIN_NAMESPACE
17 
18 /** \name Inputs and outputs
19  These methods recursively find all inputs or outputs of a given type.
20 
21  If you don't want recursive, use the non input/output variants.
22  @{
23 */
24 //! Return all the input particles for a given ModelObject.
25 IMPKERNELEXPORT ParticlesTemp get_input_particles(const ModelObjectsTemp &mos);
26 
27 //! Return all the input particles for a given ModelObject.
28 IMPKERNELEXPORT ContainersTemp
30 
31 //! Return all the output particles for a given ModelObject.
32 IMPKERNELEXPORT ParticlesTemp get_output_particles(const ModelObjectsTemp &mos);
33 
34 //! Return all the output particles for a given ModelObject.
35 IMPKERNELEXPORT ContainersTemp
37 /** @} */
38 
39 IMPKERNEL_END_NAMESPACE
40 
41 #endif /* IMPKERNEL_INPUT_OUTPUT_H */
Basic types used by IMP.
ContainersTemp get_input_containers(const ModelObjectsTemp &mos)
Return all the input particles for a given ModelObject.
IMP::Vector< IMP::WeakPointer< Container > > ContainersTemp
Definition: base_types.h:101
ContainersTemp get_output_containers(const ModelObjectsTemp &mos)
Return all the output particles for a given ModelObject.
ParticlesTemp get_output_particles(const ModelObjectsTemp &mos)
Return all the output particles for a given ModelObject.
IMP::Vector< IMP::WeakPointer< ModelObject > > ModelObjectsTemp
Definition: base_types.h:89
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
Abstract base class for containers of particles.
ParticlesTemp get_input_particles(const ModelObjectsTemp &mos)
Return all the input particles for a given ModelObject.