osg::StatCollector Class Reference
[Statistics]

Manager for Stat elements, see Statistics for details. More...

#include <OSGStatCollector.h>

List of all members.

Constructor
static StatCollector *	create (void)
	StatCollector (void)
	StatCollector (const StatCollector &source)
const StatCollector &	operator= (const StatCollector &source)
Public Member Functions
Instance
UInt32	getNumOfElems (void) const
void	refitElemNum (void)
void	clearElems (void)
bool	isValidID (Int32 elemId) const
void	reset (void)
StatElem *	getElem (Int32 elemId) const
StatElem *	getElem (Int32 elemId, bool create=true)
StatElem *	getElem (StatElemDescBase &desc, bool create=true)
template<class T>
T *	getElem (StatElemDesc< T > &desc, bool create=true)
void	putToString (std::string &outVal) const
bool	getFromString (const Char8 *&inVal)
bool	getValue (std::string &name, Real64 &val)
Destructor
virtual	~StatCollector (void)
Comparison
bool	operator< (const StatCollector &other) const
Operators
StatCollector	operator+ (const StatCollector &other)
StatCollector &	operator+= (const StatCollector &other)
Static Public Member Functions
Class Get
static const char *	getClassname (void)
Private Attributes
std::vector< StatElem * >	_elemVec

---

Detailed Description

The StatCollector is responsible for managing a set of osg::StatElem elements, see Statistics for details.

Definition at line 63 of file OSGStatCollector.h.

---

Constructor & Destructor Documentation

StatCollector::StatCollector

(

void

)

Definition at line 78 of file OSGStatCollector.cpp.

References refitElemNum().

Referenced by create().

{
    refitElemNum();
}

StatCollector::StatCollector

(

const StatCollector &

source

)

Definition at line 83 of file OSGStatCollector.cpp.

References _elemVec.

{
    _elemVec.resize(source._elemVec.size());
    
    for(UInt32 i = 0; i < source._elemVec.size(); ++i)
    {
        if(source._elemVec[i])
        {
            _elemVec[i] = source._elemVec[i]->clone();
        }
        else
        {
            _elemVec[i] = NULL;
        }
    }
}

StatCollector::~StatCollector

(

void

)

[virtual]

Definition at line 105 of file OSGStatCollector.cpp.

References _elemVec.

{
    for(UInt32 i = 0; i < _elemVec.size(); ++i)
        delete _elemVec[i];
}

---

Member Function Documentation

static const char* osg::StatCollector::getClassname

(

void

)

[inline, static]

Definition at line 73 of file OSGStatCollector.h.

{ return "StatCollector"; }

UInt32 osg::StatCollector::getNumOfElems

(

void

)

const [inline]

Definition at line 43 of file OSGStatCollector.inl.

References _elemVec.

Referenced by osg::SimpleStatisticsForeground::draw().

{
    return _elemVec.size();
}

void StatCollector::refitElemNum

(

void

)

Increase the size of the StatCollector's data array. This is called during construction and will only be needed later, when a new StatElem has been added after the StatCollector was instanced. This will very rarely be the case.

Definition at line 117 of file OSGStatCollector.cpp.

References _elemVec, and osg::StatElemDescBase::getNumOfDescs().

Referenced by getElem(), and StatCollector().

{
  unsigned eN = _elemVec.size(), dN = StatElemDescBase::getNumOfDescs();

  if(eN != dN)
  {
    _elemVec.resize(dN,0);
  }
}

void StatCollector::clearElems

(

void

)

Remove all elements from the collector.

Definition at line 228 of file OSGStatCollector.cpp.

References _elemVec.

Referenced by osg::SimpleStatisticsForeground::clearElems(), and getFromString().

{
    for(std::vector<StatElem*>::iterator i = _elemVec.begin(); 
        i != _elemVec.end();
        ++i)
    {
        if(*i != NULL)
        {
            delete *i;
            *i = NULL;
        }
    }
    
    _elemVec.clear();
}

bool osg::StatCollector::isValidID

(

Int32

elemId

)

const [inline]

Definition at line 49 of file OSGStatCollector.inl.

References _elemVec.

Referenced by getElem().

{
    return (elemId >= 0) && (elemId < Int32(_elemVec.size()));
}

void StatCollector::reset

(

void

)

Reset all elements to the start value.

Definition at line 247 of file OSGStatCollector.cpp.

References _elemVec.

Referenced by osg::RenderAction::start().

{
    for(std::vector<StatElem*>::iterator i = _elemVec.begin(); 
        i != _elemVec.end();
        ++i)
    {
        if(*i != NULL)
        {
            (*i)->reset();
        }
    }
}

StatElem * osg::StatCollector::getElem

(

Int32

elemId

)

const [inline]

Return a pointer to the StatElem for the id. It will returnn NULL if the element doesn't exist yet.

Definition at line 90 of file OSGStatCollector.inl.

References _elemVec, and isValidID().

Referenced by osg::TextureChunk::activate(), osg::CubeTextureChunk::activate(), osg::PriorityAction::beginEditStateEvent(), osg::DepthFirstStateAction::beginEditStateEvent(), osg::TextureChunk::changeFrom(), osg::CubeTextureChunk::changeFrom(), osg::SimpleStatisticsForeground::draw(), osg::GraphicStatisticsForeground::draw(), osg::SpotLight::drawEnter(), osg::PointLight::drawEnter(), osg::DirectionalLight::drawEnter(), osg::Slices::drawPrimitives(), osg::Geometry::drawPrimitives(), getElem(), getFromString(), getValue(), osg::SimpleSceneManager::initialize(), osg::RenderAction::isOccluded(), osg::RenderAction::isVisible(), osg::DrawAction::isVisible(), osg::RenderAction::pushVisibility(), osg::RemoteAspect::receiveSync(), osg::SpotLight::renderEnter(), osg::PointLight::renderEnter(), osg::DirectionalLight::renderEnter(), osg::RemoteAspect::sendSync(), osg::DrawActionBase::start(), osg::PriorityAction::startEvent(), osg::NewActionBase::startEvent(), osg::DepthFirstStateAction::startEvent(), osg::RenderAction::stop(), osg::DrawActionBase::stop(), osg::PriorityAction::traverseEnter(), osg::DepthFirstStateAction::traverseEnter(), osg::DepthFirstAction::traverseEnter(), osg::DepthFirstStateAction::traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

{
    return isValidID(elemId) ? _elemVec[elemId] : NULL;
}

StatElem * osg::StatCollector::getElem	(	Int32	elemId,
		bool	create = true
	)			[inline]

Return a pointer to the StatElem for the id. This function has two modes. By default it's careful and sets the create argument to true. In this case it checks whether the Collector already contains a StatElem for the given id and creates it if necessary. If you know that your Collector already contains that element (because you explicitly created it outside the testing loop) you can set it to false and speed up the whole function a bit.

Definition at line 65 of file OSGStatCollector.inl.

References _elemVec, osg::StatElemDescBase::createElem(), osg::StatElemDescBase::getDesc(), isValidID(), and refitElemNum().

{
    if(create)
    {
        // This only happens when dynamically adding StatElems
        // but it's really nasty if it happens.
        if(elemId >= int(_elemVec.size())) 
            refitElemNum();
        
        StatElem *elem = _elemVec[elemId];
        if(elem == NULL)
        {
            StatElemDescBase    *desc = StatElemDescBase::getDesc(elemId);
            elem = _elemVec[elemId] = desc->createElem();
        }
        return elem;
    }

    return isValidID(elemId) ? _elemVec[elemId] : NULL;
}

StatElem * osg::StatCollector::getElem	(	StatElemDescBase &	desc,
		bool	create = true
	)			[inline]

Definition at line 96 of file OSGStatCollector.inl.

References getElem(), and osg::StatElemDescBase::getID().

{
    return getElem(desc.getID(), create);
}

template<class T>

T * osg::StatCollector::getElem	(	StatElemDesc< T > &	desc,
		bool	create = true
	)			[inline]

Definition at line 103 of file OSGStatCollector.inl.

References getElem(), and osg::StatElemDescBase::getID().

{
    return reinterpret_cast < T * > (getElem(desc.getID(), create));
}

void StatCollector::putToString

(

std::string &

str

)

const

Convert the current contents into a string. This string can be used as a compact representation of the data, and as input for StatCollector::getFromString.

Definition at line 131 of file OSGStatCollector.cpp.

References _elemVec.

Referenced by osg::osg::FieldDataTraits< StatCollector >::putToString().

{
    std::vector<StatElem*>::const_iterator it;
    bool first = true;
     
    str = "{";
    
    for(it = _elemVec.begin(); it != _elemVec.end(); ++it)
    {
        if(*it != NULL)
        {
            std::string elem;
            
            if(!first)
                str.append("|");
            str.append((*it)->getDesc()->getName().str());
            str.append("=");
            (*it)->putToString(elem);
            str.append(elem);
            first = false;
        }
    }
    str.append("}");
}

bool StatCollector::getFromString

(

const Char8 *&

inVal

)

Set the contents from a string. The string has to have the format that is used by StatCollector::putToString.

Definition at line 160 of file OSGStatCollector.cpp.

References clearElems(), osg::StatElemDescBase::findDescByName(), getElem(), and osg::StatElem::getFromString().

Referenced by osg::osg::FieldDataTraits< StatCollector >::getFromString().

{
    const Char8 *c = inVal;
    
    if(*c++ != '{')
        return false;

    StatElemDescBase *desc;
    StatElem *elem;
    
    clearElems();
    
    while(*c && *c != '}')
    {
        const Char8 *end = c;
        
        while(*end != 0 && *end != '=' && *end != '}' && *end != '|')
            end++;
            
        if(*end == 0 || *end == '}' || *end == '|')
            return false;
        
        std::string name(c, end - c);
        desc = StatElemDescBase::findDescByName(name.c_str());
        
        if(!desc)
            return false;
        
        elem = getElem(*desc);

        c = end = end + 1;       
        while(*end != 0 && *end != '}' && *end != '|')
            end++;
            
        if(*end == 0)
            return false;

        std::string val(c, end - c);
        const Char8 *valp = val.c_str();
        if(!elem->getFromString(valp))
            return false;
 
        c = end + 1;
    }
    return true;
}

bool StatCollector::getValue	(	std::string &	name,
		Real64 &	val
	)

Get the value of the named element, if it exists, return false if not.

Definition at line 209 of file OSGStatCollector.cpp.

References osg::StatElemDescBase::findDescByName(), getElem(), and osg::StatElem::getValue().

{
    StatElemDescBase *desc = StatElemDescBase::findDescByName(name.c_str());
    
    if(!desc)
        return false;
    
    StatElem *el = getElem(*desc, false);
    
    if(!el)
        return false;
    
    val = el->getValue();
    
    return true;
}

StatCollector * StatCollector::create

(

void

)

[static]

Definition at line 100 of file OSGStatCollector.cpp.

References StatCollector().

Referenced by osg::DrawActionBase::getStatistics(), osg::DrawActionBase::start(), and osg::NewActionBase::startEvent().

{
    return new StatCollector();
}

const StatCollector & StatCollector::operator=

(

const StatCollector &

source

)

Definition at line 262 of file OSGStatCollector.cpp.

References _elemVec.

{
    if (this == &source)
        return *this;

    _elemVec = source._elemVec;
 
    return *this;
}

bool StatCollector::operator<

(

const StatCollector &

other

)

const

The comparison is only done on the addresses, as a real comparison is not well defined on a StatCollector.

Definition at line 277 of file OSGStatCollector.cpp.

{
    return this < &other;
}

StatCollector StatCollector::operator+

(

const StatCollector &

other

)

Definition at line 283 of file OSGStatCollector.cpp.

{
    StatCollector res(*this);
    
    res += other;
    
    return res;
}

StatCollector & StatCollector::operator+=

(

const StatCollector &

other

)

Definition at line 292 of file OSGStatCollector.cpp.

References _elemVec.

{
    if(other._elemVec.size() > _elemVec.size())
    {
        _elemVec.resize(other._elemVec.size());
    }
    
    for(UInt32 i = 0; i < _elemVec.size(); ++i)
    {
        if(_elemVec[i])
        {
            *_elemVec[i] += *other._elemVec[i];
        }
    }
    
    return *this;
}

---

Member Data Documentation

std::vector<StatElem*> osg::StatCollector::_elemVec [private]

Definition at line 151 of file OSGStatCollector.h.

Referenced by clearElems(), getElem(), getNumOfElems(), isValidID(), operator+=(), operator=(), putToString(), refitElemNum(), reset(), StatCollector(), and ~StatCollector().

---

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

• OSGStatCollector.h
• OSGStatCollector.cpp
• OSGStatCollector.inl