ExampleClass Class Reference

#include <ExampleClass.h>

List of all members.

Public Member Functions
float	computeMean () const
	A member function.
int	count () const
	A simple getter.
	ExampleClass ()
	Constructor.
void	setCount (int ticks)
	A simple setter.
void	setValues (const std::vector< float > &entries)
	Another setter.
const std::vector< float > &	values () const
	A getter returning a const reference.
virtual	~ExampleClass ()
	Virtual Destructor.
Private Attributes
SomeAlgorithm *	theAlgo
int	theCount
std::vector< float >	theValues

---

Detailed Description

An example of doxygen-documented class conforming to the CMS style rules.

Features:
-doxygen-style header (note the

Definition at line 22 of file ExampleClass.h.

---

Constructor & Destructor Documentation

ExampleClass::ExampleClass

(

)

Constructor.

Definition at line 23 of file ExampleClass.cc.

                           :
  theCount(0),
  theAlgo(new SomeAlgorithm()) 
{}

ExampleClass::~ExampleClass

(

)

[virtual]

Virtual Destructor.

Definition at line 29 of file ExampleClass.cc.

References theAlgo.

                           {
  delete theAlgo;
}

---

Member Function Documentation

float ExampleClass::computeMean

(

)

const

A member function.

Definition at line 61 of file ExampleClass.cc.

                                      {
  float result = 1.;
  //... do all necessary computations...
  return result;
}

int ExampleClass::count

(

)

const

A simple getter.

Definition at line 41 of file ExampleClass.cc.

References theCount.

                             {
  return theCount;
}

void ExampleClass::setCount

(

int

ticks

)

A simple setter.

Definition at line 35 of file ExampleClass.cc.

References theCount.

                                    {
  theCount = ticks;
}

void ExampleClass::setValues

(

const std::vector< float > &

entries

)

Another setter.

Definition at line 48 of file ExampleClass.cc.

References theValues.

                                                         {
  theValues = entries;
}

const vector< float > & ExampleClass::values

(

)

const

A getter returning a const reference.

Definition at line 54 of file ExampleClass.cc.

References theValues.

                                                {
  return theValues;
}

---

Member Data Documentation

SomeAlgorithm* ExampleClass::theAlgo [private]

Definition at line 50 of file ExampleClass.h.

Referenced by ~ExampleClass().

int ExampleClass::theCount [private]

Definition at line 48 of file ExampleClass.h.

Referenced by count(), and setCount().

std::vector<float> ExampleClass::theValues [private]

Definition at line 49 of file ExampleClass.h.

Referenced by setValues(), and values().