---

xmlUtil::DictConstraints Class Reference

Represent constraints on values for an id dictionary node. More...

#include <DictConstraints.h>

List of all members.

Public Methods
	DictConstraints (DOM_Element elt)
	Build constraints object from xml representation. More...
bool	equals (const DictConstraints &other)
	~DictConstraints ()
bool	allowed (const unsigned value) const
	Does the specified value satisfy the constraints? More...
bool	allowed (const DictConstraints &other) const
	Are the constraints of the argument a refinement (i.e., define a subset of possible values)? More...
bool	allowed (DictConstraints *other) const
bool	disjoint (const DictConstraints &other) const
bool	disjoint (DictConstraints *other) const
unsigned	getMin () const
unsigned	getMax () const
void	insertValues (std::set< unsigned > &aSet) const
	Add our allowed values to specified set so we can use set operations to look for overlap. More...
	DictConstraints (const DictConstraints &toCopy)
DictConstraints &	operator= (const DictConstraints &)
Private Types
typedef std::vector< unsigned >	DictValList
enum	eStyle { ESTYLE_uninit = 0, ESTYLE_single = 1, ESTYLE_interval = 2, ESTYLE_list = 3 }
Private Methods
void	deepCopy (const DictConstraints &toCopy)
	Utility used by copy constructor, copy assignment operator. More...
	DictConstraints ()
	Will be initialized correctly even for list Default constructor, not normally invoked. More...
eStyle	getType () const
	DictConstraints (const unsigned soleValue)
	DictConstraints (const unsigned min, const unsigned max)
	DictConstraints (const DictValList *const list)
Private Attributes
eStyle	m_style
DictValList *	m_valList
unsigned	m_minVal
unsigned	m_maxVal
	Will be initialized correctly even for list. More...

---

Detailed Description

Represent constraints on values for an id dictionary node.

Definition at line 15 of file DictConstraints.h.

---

Member Typedef Documentation

typedef std::vector<unsigned> xmlUtil::DictConstraints::DictValList [private]

Definition at line 47 of file DictConstraints.h. Referenced by deepCopy(), DictConstraints(), and getType().

---

Member Enumeration Documentation

enum xmlUtil::DictConstraints::eStyle [private]

Enumeration values: ESTYLE_uninit  ESTYLE_single  ESTYLE_interval  ESTYLE_list  Definition at line 52 of file DictConstraints.h. Referenced by getType(). { ESTYLE_uninit = 0, ESTYLE_single = 1, ESTYLE_interval = 2, ESTYLE_list = 3 };

---

Constructor & Destructor Documentation

xmlUtil::DictConstraints::DictConstraints (  DOM_Element    elt )

Build constraints object from xml representation. One and only public constructor. Note that constraints specified as a list in xml, but describable in terms of a min and max bound will be represented in terms of the bounds. The list representation is only used when there is no other option. Definition at line 17 of file DictConstraints.cxx. References ESTYLE_interval, ESTYLE_list, ESTYLE_single, ESTYLE_uninit, m_maxVal, m_minVal, m_style, and m_valList. Referenced by getMax(), and ~DictConstraints(). : m_style(ESTYLE_uninit), m_valList(0), m_minVal(0), m_maxVal(0) { DOMString vType = elt.getTagName(); if (vType.equals("vEnumVal")) { DOMString attVal = elt.getAttribute("value"); m_minVal = atoi(xml::Dom::transToChar(attVal)); m_maxVal = m_minVal; m_style = ESTYLE_single; } else if (vType.equals("vMinMax") ) { DOMString minVal = elt.getAttribute("min"); m_minVal = atoi(xml::Dom::transToChar(minVal)); DOMString maxVal = elt.getAttribute("max"); m_maxVal = atoi(xml::Dom::transToChar(maxVal)); m_style = (m_minVal == m_maxVal) ? ESTYLE_single : ESTYLE_interval; } // Probably should revise this to sort the list before storing // For now, just update min and max correctly else if (vType.equals("vList")) { m_minVal = 0xffffffff; DOM_NodeList children = elt.getChildNodes(); unsigned nChild = children.getLength(); if (nChild == 0) { m_style = ESTYLE_uninit; return; } m_valList = new std::vector<unsigned>(nChild); for (unsigned ix = 0; ix < nChild; ix++) { int temp; DOM_Node childNode = children.item(ix); DOM_Element child = static_cast<DOM_Element &>(childNode); temp = atoi(xml::Dom::transToChar(child.getAttribute("value"))); if (temp < 0) { //complain } else { unsigned newVal = temp; m_valList->push_back(newVal); if (newVal < m_minVal) m_minVal = newVal; if (newVal > m_maxVal) m_maxVal = newVal; } } // if ((m_minVal < 0 ) || (m_maxVal < 0)) { //complain // } // Check if it's really an interval after all. Look for all // inbetween elements if (m_valList) { for (unsigned iy = m_minVal + 1; iy < m_maxVal; iy++) { // if there is anything we can't find, we really need a list if (std::find(m_valList->begin(), m_valList->end(), iy) == m_valList->end()) { m_style = ESTYLE_list; return; } } // Everything was there. The bounds are sufficient. delete m_valList; m_style = (m_minVal == m_maxVal) ? ESTYLE_single : ESTYLE_interval; m_valList = 0; } } }

xmlUtil::DictConstraints::~DictConstraints (    )  [inline]

Definition at line 21 of file DictConstraints.h. References DictConstraints(), and m_valList. {if (m_valList) delete m_valList;}

xmlUtil::DictConstraints::DictConstraints (  const DictConstraints &    toCopy )

Definition at line 106 of file DictConstraints.cxx. References deepCopy(). { deepCopy(toCopy); }

xmlUtil::DictConstraints::DictConstraints (    )  [inline, private]

Will be initialized correctly even for list Default constructor, not normally invoked. Definition at line 65 of file DictConstraints.h. References ESTYLE_uninit, m_style, and m_valList. : m_style(ESTYLE_uninit), m_valList(0) {};

xmlUtil::DictConstraints::DictConstraints (  const unsigned    soleValue )  [private]

Definition at line 85 of file DictConstraints.cxx. : m_style(ESTYLE_single), m_valList(0), m_minVal(soleValue), m_maxVal(soleValue) {}

xmlUtil::DictConstraints::DictConstraints (  const unsigned    min, const unsigned    max )  [private]

Definition at line 89 of file DictConstraints.cxx. : m_style(ESTYLE_interval), m_valList(0), m_minVal(min), m_maxVal(max) {}

xmlUtil::DictConstraints::DictConstraints (  const DictValList *const    list )  [private]

Definition at line 93 of file DictConstraints.cxx. References DictValList, m_maxVal, m_minVal, and m_valList. : m_style(ESTYLE_list) { m_valList = new DictValList(*list); m_minVal = 0xffffffff; m_maxVal = 0; for (DictValList::iterator it = (unsigned int *) list->begin(); it != list->end(); ++it) { const unsigned val = *it; if (val > m_maxVal) m_maxVal = val; if (val < m_minVal) m_minVal = val; } }

---

Member Function Documentation

bool xmlUtil::DictConstraints::allowed (  DictConstraints *    other )  const

Definition at line 157 of file DictConstraints.cxx. References allowed(). { return allowed(*other); }

bool xmlUtil::DictConstraints::allowed (  const DictConstraints &    other )  const

Are the constraints of the argument a refinement (i.e., define a subset of possible values)? Definition at line 161 of file DictConstraints.cxx. References allowed(), m_maxVal, m_minVal, and m_valList. { bool boundsOk = ((other.m_minVal >= m_minVal) && (other.m_maxVal <= m_maxVal) ); // if this isn't a list, this is all there is to check if (m_valList == 0) return boundsOk; // If either has a list of values, bounds must still be ok if (!(boundsOk)) return false; // All that's left to check is case where this has a list // and bounds are ok. Just do the brute force thing and // check each possible value separately. This would be horrible // if both were large enumerated sets, but it's very unlikely // that large sets will be described as a list rather than as an // interval else if (other.m_valList) { for (unsigned ix = 0; ix < (other.m_valList)->size(); ix++) { if (!allowed((*(other.m_valList))[ix])) return false; } } else { // other is interval-type constraint for (unsigned iy = other.m_minVal; iy <= other.m_maxVal; iy++) { if (!allowed(iy)) return false; } } return true; }

bool xmlUtil::DictConstraints::allowed (  const unsigned    value )  const

Does the specified value satisfy the constraints? Definition at line 141 of file DictConstraints.cxx. References ESTYLE_interval, ESTYLE_list, ESTYLE_single, m_maxVal, m_minVal, and m_valList. Referenced by allowed(). { switch(m_style) { case ESTYLE_single: return (value == m_minVal); case ESTYLE_interval: return ((value >= m_minVal) & (value <= m_maxVal)); case ESTYLE_list: return (std::find(m_valList->begin(), m_valList->end(), value) != m_valList->end()); default: return false; } return false; }

void xmlUtil::DictConstraints::deepCopy (  const DictConstraints &    toCopy )  [private]

Utility used by copy constructor, copy assignment operator. Definition at line 110 of file DictConstraints.cxx. References DictValList, m_maxVal, m_minVal, m_style, and m_valList. Referenced by DictConstraints(), and operator=(). { // Nothing to it unless the DictValList is being used m_style = toCopy.m_style; m_valList = 0; m_minVal = toCopy.m_minVal; m_maxVal = toCopy.m_maxVal; if (toCopy.m_valList) { m_valList = new DictValList(*(toCopy.m_valList)); } }

bool xmlUtil::DictConstraints::disjoint (  DictConstraints *    other )  const

Definition at line 205 of file DictConstraints.cxx. References disjoint(). { return disjoint(*other); }

bool xmlUtil::DictConstraints::disjoint (  const DictConstraints &    other )  const

Definition at line 190 of file DictConstraints.cxx. References m_maxVal, m_minVal, and m_valList. Referenced by disjoint(). { if ((other.m_minVal > m_maxVal) || (other.m_maxVal < m_minVal)) return true; // If either is an interval, we'll have an intersection if ((!m_valList) || (!other.m_valList)) return false; // Both are lists. Check for duplicates one at a time for (DictValList::iterator it = m_valList->begin(); it !=m_valList->end(); ++it) { unsigned val = *it; if (other.allowed(val)) return false; } return true; }

bool xmlUtil::DictConstraints::equals (  const DictConstraints &    other )

Definition at line 130 of file DictConstraints.cxx. References ESTYLE_list, m_maxVal, m_minVal, m_style, and m_valList. { if ((m_style != other.m_style) || (m_minVal != other.m_minVal) || (m_maxVal != other.m_maxVal) ) return false; if (m_style == ESTYLE_list) { return (*m_valList == *(other.m_valList)); } else return true; }

unsigned xmlUtil::DictConstraints::getMax (    )  const [inline]

Definition at line 34 of file DictConstraints.h. References DictConstraints(), and m_maxVal. {return m_maxVal;}

unsigned xmlUtil::DictConstraints::getMin (    )  const [inline]

Definition at line 33 of file DictConstraints.h. References m_minVal. {return m_minVal;}

eStyle xmlUtil::DictConstraints::getType (    )  const [inline, private]

Definition at line 67 of file DictConstraints.h. References DictValList, eStyle, and m_style. {return m_style;}

void xmlUtil::DictConstraints::insertValues (  std::set< unsigned > &    aSet )  const

Add our allowed values to specified set so we can use set operations to look for overlap. Definition at line 209 of file DictConstraints.cxx. References m_maxVal, m_minVal, and m_valList. { if (m_valList == 0) { for (unsigned i = m_minVal; i <= m_maxVal; i++) { aSet.insert(i); } } else { aSet.insert(m_valList->begin(), m_valList->end()); } return; }

DictConstraints & xmlUtil::DictConstraints::operator= (  const DictConstraints &    d )

Definition at line 122 of file DictConstraints.cxx. References deepCopy(), and m_valList. { if (this != &d) { if (m_valList) delete m_valList; deepCopy(d); } return *this; }

---

Member Data Documentation

unsigned xmlUtil::DictConstraints::m_maxVal [private]

Will be initialized correctly even for list. Definition at line 62 of file DictConstraints.h. Referenced by allowed(), deepCopy(), DictConstraints(), disjoint(), equals(), getMax(), and insertValues().

unsigned xmlUtil::DictConstraints::m_minVal [private]

Definition at line 61 of file DictConstraints.h. Referenced by allowed(), deepCopy(), DictConstraints(), disjoint(), equals(), getMin(), and insertValues().

eStyle xmlUtil::DictConstraints::m_style [private]

Definition at line 58 of file DictConstraints.h. Referenced by deepCopy(), DictConstraints(), equals(), and getType().

DictValList* xmlUtil::DictConstraints::m_valList [private]

Definition at line 60 of file DictConstraints.h. Referenced by allowed(), deepCopy(), DictConstraints(), disjoint(), equals(), insertValues(), operator=(), and ~DictConstraints().

---

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

• DictConstraints.h
• DictConstraints.cxx

---