RingerRings Class Reference

This class carries the generated Rings. More...

#include <RingerRings.h>

Collaboration diagram for RingerRings:

Public Member Functions
	RingerRings ()
	Class default constructor.
	RingerRings (const std::vector< float > &rings)
	Class constructor.
	RingerRings (const unsigned int nRings, const float *rings)
	Class constructor.
std::vector< float > &	rings ()
	Acessor methods.
const std::vector< float > &	rings () const
void	rings (const std::vector< float > &r)
float &	at (const unsigned int i)
const float &	at (const unsigned int i) const
unsigned int	size () const
const float &	operator[] (const unsigned int i) const
float &	operator[] (const unsigned int i)
void	print (MsgStream &log) const
	Prints some debug message.

Private Attributes
std::vector< float >	m_rings

Detailed Description

This class carries the generated Rings.

Definition at line 18 of file RingerRings.h.

Constructor & Destructor Documentation

RingerRings() [1/3]

RingerRings::RingerRings

(

)

Class default constructor.

Definition at line 7 of file RingerRings.cxx.

  : m_rings() {
}

RingerRings() [2/3]

RingerRings::RingerRings

(

const std::vector< float > &

rings

)

Class constructor.

Parameters

rings

The rings to be saved.

Definition at line 11 of file RingerRings.cxx.

  : m_rings(rings) {
}

RingerRings() [3/3]

RingerRings::RingerRings	(	const unsigned int	nRings,
		const float *	rings )

Class constructor.

Parameters

nRings	Number of rings.
rings	Ring array.

Definition at line 15 of file RingerRings.cxx.

                                                                      {
  if (!rings)
    return;
  for (unsigned int i = 0; i < nRings; ++i) {
    m_rings.push_back(rings[i]);
  }
}

Member Function Documentation

at() [1/2]

float & RingerRings::at

(

const unsigned int

i

)

Definition at line 35 of file RingerRings.cxx.

                                           {
  return m_rings[i];
}

at() [2/2]

const float & RingerRings::at

(

const unsigned int

i

)

const

Definition at line 39 of file RingerRings.cxx.

                                                       {
  return m_rings[i];
}

operator[]() [1/2]

float & RingerRings::operator[]

(

const unsigned int

i

)

Definition at line 51 of file RingerRings.cxx.

                                                    {
  return m_rings[i];
}

operator[]() [2/2]

const float & RingerRings::operator[]

(

const unsigned int

i

)

const

Definition at line 47 of file RingerRings.cxx.

                                                                {
  return m_rings[i];
}

print()

void RingerRings::print

(

MsgStream &

log

)

const

Prints some debug message.

Parameters

log	The msg stream to print the info to.

Definition at line 55 of file RingerRings.cxx.

                                            {
  log << MSG::DEBUG << "Dumping RingerRings information for debugging. There are " << m_rings.size()  << " rings." << endmsg;
  log << MSG::DEBUG << "Ringer values: ";
  for (std::vector<float>::const_iterator i = m_rings.begin(); i != m_rings.end(); ++i) {
    log << (*i) << "   ";
  }
  log << endmsg;
}

rings() [1/3]

std::vector< float > & RingerRings::rings

(

)

Acessor methods.

Definition at line 23 of file RingerRings.cxx.

                                     {
  return m_rings;
}

rings() [2/3]

const std::vector< float > & RingerRings::rings

(

)

const

Definition at line 27 of file RingerRings.cxx.

                                                 {
  return m_rings;
}

rings() [3/3]

void RingerRings::rings

(

const std::vector< float > &

r

)

Definition at line 31 of file RingerRings.cxx.

                                                 {
  m_rings = r;
}

size()

unsigned int RingerRings::size

(

)

const

Definition at line 43 of file RingerRings.cxx.

                                     {
  return m_rings.size();
}

Member Data Documentation

m_rings

std::vector<float> RingerRings::m_rings

private

Definition at line 21 of file RingerRings.h.

---

The documentation for this class was generated from the following files:

• RingerRings.h
• RingerRings.cxx