G3D::AnyTableReader Class Reference

#include <Any.h>

Public Member Functions
	AnyTableReader (const std::string &name, const Any &a)
	AnyTableReader (const Any &a)
bool	hasMore () const
void	verifyDone () const
const Any &	any () const
void	get (const std::string &s, std::string &v)
void	get (const std::string &s, uint8 &v)
void	get (const std::string &s, uint16 &v)
template<class T >
void	get (const std::string &s, Array< T > &v)
template<class T >
void	get (const std::string &s, Table< std::string, T > &v)
template<class ValueType >
void	get (const std::string &s, ValueType &v)
const Any &	operator[] (const std::string &s)
template<class ValueType >
bool	getIfPresent (const std::string &s, ValueType &v)
bool	containsUnread (const std::string &s) const

Private Attributes
Any	m_any
Set< std::string >	m_alreadyRead

Detailed Description

Convenient iteration over the keys of a Any::TABLE, usually for implementing construction of an object from an Any.

Getting an element using either iteration or explicit requests consumes that element from the iterator (but not from the Any!) It is an error to consume the same element more than once from the same iterator.

AnyTableReader r(a);
r.getIfPresent("enabled", enabled);
r.getIfPresent("showSamples", showSamples);
r.get("showTiles", showTiles);

r.verifyDone();

Constructor & Destructor Documentation

G3D::AnyTableReader::AnyTableReader	(	const std::string &	name,
		const Any &	a
	)

Verifies that is a TABLE with the given name.

 : m_any(a) {
 try {
 m_any.verifyType(Any::TABLE);
 m_any.verifyName(name);
 } catch (const ParseError& e) {
 // If an exception is thrown, the destructors will not be 
 // invoked automatically.
 m_any.~Any();
 m_alreadyRead.~Set();
 throw e;
 }
}

Here is the call graph for this function:

G3D::AnyTableReader::AnyTableReader

(

const Any &

a

)

Verifies that is a TABLE.

 : m_any(a) {
 try {
 m_any.verifyType(Any::TABLE);
 } catch (const ParseError& e) {
 // If an exception is thrown, the destructors will not be 
 // invoked automatically.
 m_any.~Any();
 m_alreadyRead.~Set();
 throw e;
 }
}

Here is the call graph for this function:

Member Function Documentation

const Any& G3D::AnyTableReader::any ( ) const

inline

Return the underlying Any.

 {
 return m_any;
 }

bool G3D::AnyTableReader::containsUnread ( const std::string &  s ) const

inline

Returns

True if s is in the table and has not yet been read using get() or getIfPresent().

 {
 return m_any.containsKey(s) && ! m_alreadyRead.contains(s);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::AnyTableReader::get ( const std::string &  s, std::string &  v  )

inline

If key s appears in the any, reads its value into v and removes that key from the ones available to iterate over.

If key s does not appear in the any, throws a G3D::ParseError.

Assumes that if key s appears in the any it has not already been extracted by this iterator. If it has been read before, an assertion will fail in debug mode.

 {
 v = m_any[s].string();
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

void G3D::AnyTableReader::get ( const std::string &  s, uint8 &  v  )

inline

If key s appears in the any, reads its value into v and removes that key from the ones available to iterate over.

If key s does not appear in the any, throws a G3D::ParseError.

Assumes that if key s appears in the any it has not already been extracted by this iterator. If it has been read before, an assertion will fail in debug mode.

 {
 v = uint8(m_any[s].number());
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

void G3D::AnyTableReader::get ( const std::string &  s, uint16 &  v  )

inline

If key s appears in the any, reads its value into v and removes that key from the ones available to iterate over.

If key s does not appear in the any, throws a G3D::ParseError.

Assumes that if key s appears in the any it has not already been extracted by this iterator. If it has been read before, an assertion will fail in debug mode.

 {
 v = uint16(m_any[s].number());
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

template<class T >

void G3D::AnyTableReader::get ( const std::string &  s, Array< T > &  v  )

inline

Read an entire array at once.

 {
 m_any[s].getArray(v);
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

template<class T >

void G3D::AnyTableReader::get ( const std::string &  s, Table< std::string, T > &  v  )

inline

 {
 m_any[s].getTable(v);
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

template<class ValueType >

void G3D::AnyTableReader::get ( const std::string &  s, ValueType &  v  )

inline

If key s appears in the any, reads its value into v and removes that key from the ones available to iterate over.

If key s does not appear in the any, throws a G3D::ParseError.

Assumes that if key s appears in the any it has not already been extracted by this iterator. If it has been read before, an assertion will fail in debug mode.

 {
 v = ValueType(m_any[s]);
 m_alreadyRead.insert(s);
 }

Here is the call graph for this function:

template<class ValueType >

bool G3D::AnyTableReader::getIfPresent ( const std::string &  s, ValueType &  v  )

inline

Get the value associated with a key only if the key is actually present.

If key s appears in the any, reads its value into v and removes that key from the ones available to iterate over.

If key s does not appear in the any, does nothing.

Assumes that if key s appears in the any it has not already been extracted by this iterator. If it has been read before, an assertion will fail in debug mode.

Returns

True if the value was read.

 {
 if (m_any.containsKey(s)) {
 debugAssertM(! m_alreadyRead.contains(s), "read twice");

 get(s, v);
 return true;
 } else {
 return false;
 }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool G3D::AnyTableReader::hasMore ( ) const

inline

 {
 return m_any.size() > m_alreadyRead.size();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

const Any& G3D::AnyTableReader::operator[] ( const std::string &  s )

inline

Same as get()

 {
 m_alreadyRead.insert(s);
 return m_any[s];
 }

Here is the call graph for this function:

void G3D::AnyTableReader::verifyDone

(

)

const

Verifies that all keys have been read.

 {
 if (hasMore()) {
 // Some entries were unread. Find them.
 const Table<std::string, Any>& table = m_any.table();

 for (Table<std::string, Any>::Iterator it = table.begin();
 it.hasMore();
 ++it) {
 
 if (containsUnread(it->key)) {
 it->value.verify(false, std::string("Unread Any table key \"") + it->key + "\"");
 }
 }
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Set<std::string> G3D::AnyTableReader::m_alreadyRead

private

Any G3D::AnyTableReader::m_any

private

---

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

• dep/g3dlite/include/G3D/Any.h
• dep/g3dlite/source/AnyTableReader.cpp