sventon subversion web client - http://www.sventon.org
[show recent changes]
 
  Help
HEAD
Rev: 10093 - svn://svn.freehep.org/svn / freehep / cvs / aidainclude / tags / AIDA-33-BRANCH-pre-merge-1 / AIDA / ICloud.h
Show File - ICloud.h  [show properties]
Search for Help
spinner
// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
// =========================================================================
#ifndef AIDA_ICLOUD_H
#define AIDA_ICLOUD_H 1
10  // This file is part of the AIDA library
11  // Copyright (C) 2002 by the AIDA team. All rights reserved.
12  // This library is free software and under the terms of the
13  // GNU Library General Public License described in the LGPL.txt
14 
15  #include "AIDA/IBaseHistogram.h"
16 
17  namespace AIDA {
18 
19  /**
20   * User level interface to a Cloud.
21   * A Cloud is an unbinned collection of points. It can be used to
22   * represent scatter plots or dynamically rebinnable histograms.
23   * If they number of entries in the cloud exceeds some threshold
24   * they may be automatically converted to a binned histogram.
25   *
26   * @author The AIDA team (http://aida.freehep.org/)
27   *
28   */
29 
30  class ICloud : virtual public IBaseHistogram {
31 
32  public:
33      /// Destructor.
34      virtual ~ICloud() { /* nop */; }
35 
36      /**
37       * Get the sum of weights of all the entries.
38       * @return The sum of the weights of all the entries.
39       *
40       */
41      virtual double sumOfWeights() const = 0;
42 
43      /**
44       * Convert the ICloud to an IHistogram using the default number of bins.
45       * @return false If the ICloud has already been converted.
46       *
47       */
48      virtual bool convertToHistogram() = 0;
49 
50      /**
51       * Check if the ICloud has been converted to an IHistogram.
52       * @return <code>true</code> if it has been converted.
53       *
54       */
55      virtual bool isConverted() const = 0;
56 
57      /**
58       * Get the number of entries after which the cloud will be converted to an IHistogram.
59       * @return The number of entries.
60       *
61       */
62      virtual int maxEntries() const = 0;
63 
64      /**
65       * Scale the weights by a given factor.
66       * @param scaleFactor The scale factor.
67       * @return false If a non-positive scale factor is provided.
68       *
69       */
70      virtual bool scale(double scaleFactor) = 0;
71  }; // class
72  } // namespace AIDA
73  #endif /* ifndef AIDA_ICLOUD_H */


feed icon

sventon 2.5.1