lsst::pex::logging::threshold::Family Class Reference

A hierarchical tree structure for holding mappings of names to threshold values. More...

#include <Memory.h>

Public Member Functions
	Family (int defaultThreshold=INHERIT)
	~Family ()
int	getThreshold ()
void	setThreshold (int threshold)
int	getThresholdFor (tokenizer::iterator toptoken, const tokenizer::iterator &end) const
void	setThresholdFor (tokenizer::iterator toptoken, const tokenizer::iterator &end, int threshold)
void	resetThresholdFor (tokenizer::iterator toptoken, const tokenizer::iterator &end)
void	printDescThresholds (std::ostream &out, const std::string &prefix) const
void	deleteDescendants ()

Protected Member Functions
Family *	ensureDescendant (tokenizer::iterator toptoken, const tokenizer::iterator &end)
const Family *	findDescendant (tokenizer::iterator toptoken, const tokenizer::iterator &end, bool orNearest=false) const
Family *	makeDescendants (tokenizer::iterator toptoken, const tokenizer::iterator &end)

Private Types
typedef std::map< std::string, Family * >	ChildMap

Private Attributes
int	_thresh
ChildMap *	_children

Detailed Description

A hierarchical tree structure for holding mappings of names to threshold values.

This contain contains a default threshold value and 0 or more child Family instances, each with a name. One can get or set the default threshold value for the Family as a whole or for any arbitrary descendant. If any threshold is set to the special value INHERIT, the effective value should be taken to be the threshold of its nearest ancestor.

Definition at line 59 of file Memory.h.

Member Typedef Documentation

typedef std::map<std::string, Family*> lsst::pex::logging::threshold::Family::ChildMap

private

Definition at line 159 of file Memory.h.

Constructor & Destructor Documentation

lsst::pex::logging::threshold::Family::Family

(

int

defaultThreshold = INHERIT

)

create a hierarchical container for threshold data

Parameters

defaultThreshold

the threshold value to associate with the name

Definition at line 44 of file Memory.cc.

    : _thresh(defaultThreshold), _children() 
{ }

lsst::pex::logging::threshold::Family::~Family

(

)

delete this container

Definition at line 142 of file Memory.cc.

                {
    deleteDescendants();
}

Member Function Documentation

void lsst::pex::logging::threshold::Family::deleteDescendants

(

)

delete the descendents

Definition at line 127 of file Memory.cc.

                               {

    if (_children == 0) return;

    for(ChildMap::iterator it = _children->begin(); 
        it != _children->end(); 
        ++it)
    {
        if (it->second != 0) delete it->second;
    }

    delete _children;
    _children = 0;
}

Family * lsst::pex::logging::threshold::Family::ensureDescendant ( tokenizer::iterator  toptoken, const tokenizer::iterator &  end  )

protected

return the child data for a given descendant name. Null is returned if the name does not exist.

Parameters

toptoken	the first field in the hierarchical name
end	the end iterator value from the tokenizer that produced toptoken

Definition at line 48 of file Memory.cc.

{
    if (_children == 0) 
        // we have no children yet, so just make the descendents
        return makeDescendants(toptoken, end);

    // look for a child matching the top field in the name
    ChildMap::iterator out = _children->find(*toptoken);

    // if name is not found create all descendants
    if (out == _children->end()) 
        return makeDescendants(toptoken, end);

    // if this was the last token return the found child
    if (++toptoken == end)
        return out->second;

    // look for the the remainder of the name hierarchy
    return out->second->ensureDescendant(toptoken, end);
}

const Family * lsst::pex::logging::threshold::Family::findDescendant ( tokenizer::iterator  toptoken, const tokenizer::iterator &  end, bool  orNearest = false  ) const

protected

return a threshold Family for a given descendant name. What is returned when the name doesn't exist depends on the value of the orNearest parameter.

Parameters

toptoken	the first field in the hierarchical name
end	the end iterator value from the tokenizer that produced toptoken
orNearest	if true and the exact named descendant does not exist, return the nearest ancestor that does exist. If false, return null if it doesn't exist.

Definition at line 70 of file Memory.cc.

{
    if (_children == 0) 
        return ((orNearest && _thresh != INHERIT) ? this : 0);

    // look for a child matching the top field in the name
    ChildMap::const_iterator found = _children->find(*toptoken);

    // if name is not found, return null
    if (found == _children->end()) 
        return ((orNearest && _thresh != INHERIT) ? this : 0);

    const Family *out = found->second;
    if (++toptoken != end) out = out->findDescendant(toptoken, end, orNearest);
    if (out != 0 && out->_thresh == INHERIT) out = 0;

    if (out == 0 && orNearest && _thresh != INHERIT) out = this;
    return out;
}

int lsst::pex::logging::threshold::Family::getThreshold ( )

inline

return the default threshold for the top of this hierarchy

Definition at line 76 of file Memory.h.

{ return _thresh; }

int lsst::pex::logging::threshold::Family::getThresholdFor ( tokenizer::iterator  toptoken, const tokenizer::iterator &  end  ) const

inline

return the threshold associated with a descendent with a given name

Definition at line 86 of file Memory.h.

    {
        const Family *nfd = findDescendant(toptoken, end, true);
        if (nfd == 0 || nfd->_thresh == INHERIT) return _thresh;
        return nfd->_thresh;
    }

Family * lsst::pex::logging::threshold::Family::makeDescendants ( tokenizer::iterator  toptoken, const tokenizer::iterator &  end  )

protected

create a threshold Family for a given descendant name.

Parameters

toptoken	the first field in the hierarchical name
end	the end iterator value from the tokenizer that produced toptoken

Definition at line 92 of file Memory.cc.

{
    if (_children == 0) _children = new ChildMap();

    Family *next = new Family();
    _children->insert(ChildMap::value_type(*toptoken, next));

    if (++toptoken == end) return next;

    return next->makeDescendants(toptoken, end);
}

void lsst::pex::logging::threshold::Family::printDescThresholds	(	std::ostream &	out,
		const std::string &	prefix
	)		const

print the thresholds store in this Family that are not set to INHERIT.

This is intended for debugging purposes.

Definition at line 146 of file Memory.cc.

{
    if (_children == 0) return;

    int i;
    ChildMap::const_iterator it;
    for(it = _children->begin(); it != _children->end(); ++it) {
        out << prefix << it->first;
        if (it->second != 0 && it->second->_thresh != INHERIT) {
            for(i = prefix.length()+it->first.length(); i < 20; ++i)
                out << ' ';
            if (it->second->_thresh >= 0 && it->second->_thresh < 10) 
                out << ' ';
            out << it->second->_thresh;
        }
        out << endl;

        if (it->second != 0) 
            it->second->printDescThresholds(out, prefix+' ');
    }
}

void lsst::pex::logging::threshold::Family::resetThresholdFor	(	tokenizer::iterator	toptoken,
		const tokenizer::iterator &	end
	)

reset the threshold associated with a descendent with a given name to inherit from its parent.

Definition at line 120 of file Memory.cc.

{
    Family *nfd = const_cast<Family*>(findDescendant(toptoken, end));
    if (nfd != 0) nfd->_thresh = INHERIT;
}

void lsst::pex::logging::threshold::Family::setThreshold ( int  threshold )

inline

return the default threshold for the top of this hierarchy

Definition at line 81 of file Memory.h.

{ _thresh = threshold; }

void lsst::pex::logging::threshold::Family::setThresholdFor	(	tokenizer::iterator	toptoken,
		const tokenizer::iterator &	end,
		int	threshold
	)

set the threshold associated with a descendent with a given name

Definition at line 108 of file Memory.cc.

{
    Family *nfd = ensureDescendant(toptoken, end);
    nfd->_thresh = threshold;
}

Member Data Documentation

ChildMap* lsst::pex::logging::threshold::Family::_children

private

Definition at line 161 of file Memory.h.

int lsst::pex::logging::threshold::Family::_thresh

private

Definition at line 160 of file Memory.h.

---

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

• /home/lsstsw/stack/Linux64/pex_logging/11.0.rc2+6/include/lsst/pex/logging/threshold/Memory.h
• /home/lsstsw/stack/Linux64/pex_logging/11.0.rc2+6/src/threshold/Memory.cc