ExampleClass Class Reference

#include <ExampleClass.h>

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

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::ExampleClass

(

)

Constructor.

Definition at line 23 of file ExampleClass.cc.

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

~ExampleClass()

ExampleClass::~ExampleClass ( )

virtual

Virtual Destructor.

Definition at line 29 of file ExampleClass.cc.

                           {
  delete theAlgo;
}

References theAlgo.

Member Function Documentation

computeMean()

float ExampleClass::computeMean

(

)

const

A member function.

Definition at line 61 of file ExampleClass.cc.

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

References mps_fire::result.

count()

int ExampleClass::count

(

void

)

const

A simple getter.

Definition at line 41 of file ExampleClass.cc.

                             {
  return theCount;
}

References theCount.

setCount()

void ExampleClass::setCount

(

int

ticks

)

A simple setter.

Definition at line 35 of file ExampleClass.cc.

                                    {
  theCount = ticks;
}

References theCount.

setValues()

void ExampleClass::setValues

(

const std::vector< float > &

entries

)

Another setter.

Definition at line 48 of file ExampleClass.cc.

                                                         {
  theValues = entries;
}

References theValues.

values()

const vector< float > & ExampleClass::values

(

)

const

A getter returning a const reference.

Definition at line 54 of file ExampleClass.cc.

                                                {
  return theValues;
}

References theValues.

Member Data Documentation

theAlgo

SomeAlgorithm* ExampleClass::theAlgo

private

Definition at line 50 of file ExampleClass.h.

Referenced by ~ExampleClass().

theCount

int ExampleClass::theCount

private

Definition at line 48 of file ExampleClass.h.

Referenced by count(), and setCount().

theValues

std::vector<float> ExampleClass::theValues

private

Definition at line 49 of file ExampleClass.h.

Referenced by setValues(), and values().