RDKit: EnumerationPickler.h Source File

| RDKit Open-source cheminformatics and machine learning.

Loading...
Searching...
No Matches
EnumerationPickler.h
Go to the documentation of this file.
1//
2// Copyright (c) 2015, Novartis Institutes for BioMedical Research Inc.
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following
13// disclaimer in the documentation and/or other materials provided
14// with the distribution.
15// * Neither the name of Novartis Institutes for BioMedical Research Inc.
16// nor the names of its contributors may be used to endorse or promote
17// products derived from this software without specific prior written
18// permission.
19//
20// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31//
32#include <RDGeneral/export.h>
33#ifndef ENUMERATIONPICKLER_H
34#define ENUMERATIONPICKLER_H
35
36#include "EnumerationStrategyBase.h"
37
38namespace RDKit {
39 namespace EnumerationStrategyPickler {
40//! pickles a EnumerationStrategy and adds the results to a stream \c ss
41 RDKIT_CHEMREACTIONS_EXPORT void pickle(
42 const boost::shared_ptr<EnumerationStrategyBase> &enumerator,
43 std::ostream &ss);
44 RDKIT_CHEMREACTIONS_EXPORT void pickle(
45 const boost::shared_ptr<EnumerationStrategyBase> &enumerator,
46 std::string &s);
47
48//! constructs a EnumerationStrategy from a pickle stored in a string
49//! Since an EnumerationStrategyBase is polymorphic, this must return
50//! a shared pointer to the EnumerationStrategyBase
51 RDKIT_CHEMREACTIONS_EXPORT boost::shared_ptr<EnumerationStrategyBase>
52fromPickle(std::istream &pickle);
53
54//! a pointer to the EnumerationStrategyBase
55 RDKIT_CHEMREACTIONS_EXPORT boost::shared_ptr<EnumerationStrategyBase>
56 fromPickle(const std::string &pickle);
57} // namespace EnumerationStrategyPickler
58} // namespace RDKit
59
60#endif
EnumerationStrategyBase.h
export.h
RDKIT_CHEMREACTIONS_EXPORT
#define RDKIT_CHEMREACTIONS_EXPORT
Definition export.h:57
RDKit::EnumerationStrategyPickler
Definition EnumerationPickler.h:39
RDKit::EnumerationStrategyPickler::fromPickle
RDKIT_CHEMREACTIONS_EXPORT boost::shared_ptr< EnumerationStrategyBase > fromPickle(std::istream &pickle)
RDKit::EnumerationStrategyPickler::pickle
RDKIT_CHEMREACTIONS_EXPORT void pickle(const boost::shared_ptr< EnumerationStrategyBase > &enumerator, std::ostream &ss)
pickles a EnumerationStrategy and adds the results to a stream ss
RDKit
Std stuff.
Definition Abbreviations.h:19