|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
#ifndef ExampleClass_H
#define ExampleClass_H
/** \class ExampleClass
* An example of doxygen-documented class conforming to the CMS style rules.
*
* Features:<br>
* -doxygen-style header (note the \class directive)<br>
* -doxygen-like member function documentation<br>
* -Few setters and getters
*
* $Date: $
* $Revision: $
* \author W. Woodpecker - CERN
*/
#include <vector>
class SomeAlgorithm;
class ExampleClass {
public:
/// Constructor
ExampleClass();
/// Virtual Destructor
virtual ~ExampleClass();
/// A simple setter
void setCount(int ticks);
/// A simple getter
int count() const;
/// Another setter
void setValues(const std::vector<float>& entries);
/// A getter returning a const reference
const std::vector<float>& values() const;
/// A member function
float computeMean() const;
protected:
private:
int theCount; //< An int data member
std::vector<float> theValues; //< A vector data member
SomeAlgorithm * theAlgo; //< A pointer data member
};
#endif // ExampleClass_H
|