ParaView
Public Member Functions
pqNameCount Class Reference

The pqNameCount class is used to associate a count to a name. More...

#include <pqNameCount.h>

List of all members.

Public Member Functions

 pqNameCount ()
 ~pqNameCount ()
unsigned int GetCount (const QString &name)
 Gets the current count for the specified name.
unsigned int GetCountAndIncrement (const QString &name)
 Gets the current count for a name and then increments the stored value.
void IncrementCount (const QString &name)
 Increments the count for a specified name.
void SetCount (const QString &name, unsigned int count)
 Sets the count for the specified name.
void Reset ()
 Resets the name/count map to an empty state.

Detailed Description

The pqNameCount class is used to associate a count to a name.

The count associated with a name string can be incremented or set to a specific value. The name/count map can be reset as well.

Definition at line 55 of file pqNameCount.h.


Constructor & Destructor Documentation

pqNameCount::pqNameCount ( )
pqNameCount::~pqNameCount ( )

Member Function Documentation

unsigned int pqNameCount::GetCount ( const QString &  name)

Gets the current count for the specified name.

If the name does not exist in the map, a new entry is created and 1 is returned.

Parameters:
nameThe name to look up.
Returns:
The count associated with the specified name.
unsigned int pqNameCount::GetCountAndIncrement ( const QString &  name)

Gets the current count for a name and then increments the stored value.

Parameters:
nameThe name to look up.
Returns:
The count associated with the specified name.
See also:
pqNameCount::GetCount(const QString &)
void pqNameCount::IncrementCount ( const QString &  name)

Increments the count for a specified name.

Parameters:
nameThe name to look up.
See also:
pqNameCount::GetCountAndIncrement(const QString &)
void pqNameCount::SetCount ( const QString &  name,
unsigned int  count 
)

Sets the count for the specified name.

Parameters:
nameThe name to look up.
countThe new count to assign to the name.
void pqNameCount::Reset ( )

Resets the name/count map to an empty state.


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