Concrete class for NcML <variable> element. More...

#include <VariableElement.h>

Inheritance diagram for ncml_module::VariableElement:

Collaboration diagram for ncml_module::VariableElement:

Public Member Functions
void	addPreDeleteCB (UseCountHitZeroCB *pCB)
	Add uniquely. More...

bool	checkGotValues () const

virtual VariableElement *	clone () const
	Make and return a copy of this. More...

virtual int	getRefCount () const
	Get the current reference count. More...

virtual const string &	getTypeName () const
	Return the type of the element, which should be: the same as ConcreteClassName::getTypeName() More...

virtual void	handleBegin ()
	Handle a begin on this element. More...

virtual void	handleContent (const string &content)
	Handle the characters content for the element. More...

virtual void	handleEnd ()
	Handle the closing of this element. More...

bool	isNewVariable () const

int	line () const
	Return the current parse line number. More...

const std::string	name () const

const std::string	orgName () const

virtual int	ref () const
	Increase the reference count by one. More...

virtual void	removeFromPool () const
	If the object is in an auto-delete pool, remove it from the pool and force it to only delete when it's ref count goes to 0. More...

void	removePreDeleteCB (UseCountHitZeroCB *pCB)
	Remove it exists. More...

virtual void	setAttributes (const XMLAttributeMap &attrs)
	Set the attributes of this from the map. More...

void	setGotValues ()
	Called once we set the values from ValuesElement so we are aware. More...

void	setParser (NCMLParser *p)

const std::string	shape () const

virtual string	toString () const
	Return a string describing the element. More...

const std::string	type () const

virtual int	unref () const throw ()
	Decrease the reference count by one. More...

virtual bool	validateAttributes (const XMLAttributeMap &attrs, const vector< string > &validAttrs, vector< string > *pInvalidAttrs=0, bool printInvalid=true, bool throwOnError=true)
	Check that the given attributes are all in the valid set, otherwise fill in *pInvalidAttrs with the problematic ones if it's not null. More...

	VariableElement ()

	VariableElement (const VariableElement &proto)

virtual	~VariableElement ()

Static Public Member Functions
static bool	areAllAttributesValid (const XMLAttributeMap &attrMap, const std::vector< string > &validAttrs, std::vector< string > *pInvalidAttributes=0)

static bool	isValidAttribute (const std::vector< string > &validAttrs, const string &attr)

static std::string	printAttributeIfNotEmpty (const std::string &attrName, const std::string &attrValue)
	Helper for subclasses implementing toString(). More...

Static Public Attributes
static const string	_sTypeName = "variable"

static const vector< string >	_sValidAttributes = getValidAttributes()

Protected Attributes
NCMLParser *	_parser

Detailed Description

Concrete class for NcML <variable> element.

This class handles the processing of <variable> elements in the NcML.

The class handles all processing of variables, including setting lexical scope in the parser to the variable's attribute table, renaming variables, and creating new variables.

_isNewVariable specifies if the variable was created new in this NcML parse, or was just a lexical scope. _gotValues specifies if the variable had a contained <values> element processed on it yet.

On handleEnd(), if _isNewVariable && !_gotValues, a parse error is thrown.

It is also an error to specify a second <values> element if _gotValues.

Definition at line 60 of file VariableElement.h.

Constructor & Destructor Documentation

ncml_module::VariableElement::VariableElement ( )

Definition at line 57 of file VariableElement.cc.

Referenced by clone().

ncml_module::VariableElement::VariableElement ( const VariableElement & proto )

Definition at line 70 of file VariableElement.cc.

ncml_module::VariableElement::~VariableElement ( )

virtual

Definition at line 83 of file VariableElement.cc.

Member Function Documentation

void agg_util::RCObject::addPreDeleteCB ( UseCountHitZeroCB * pCB )

inherited

Add uniquely.

If it is added agan, the second time is ignored.

Definition at line 145 of file RCObject.cc.

References BESDEBUG.

bool ncml_module::NCMLElement::areAllAttributesValid	(	const XMLAttributeMap &	attrMap,
		const std::vector< string > &	validAttrs,
		std::vector< string > *	pInvalidAttributes = `0`
	)

staticinherited

Returns: whether all the attributes in attrMap are in validAttrs. If pInvalidAttributes, fill it in with all the illegal attributes.

Definition at line 261 of file NCMLElement.cc.

References ncml_module::XMLAttributeMap::begin(), ncml_module::XMLAttributeMap::end(), and ncml_module::NCMLElement::isValidAttribute().

Referenced by ncml_module::NCMLElement::validateAttributes().

Here is the call graph for this function:

bool ncml_module::VariableElement::checkGotValues ( ) const

Returns: whether we got a values element set to us yet, used to make sure new variables get values once and only once.

Definition at line 157 of file VariableElement.cc.

Referenced by ncml_module::ValuesElement::handleBegin(), and ncml_module::NetcdfElement::VariableValueValidator::validate().

VariableElement * ncml_module::VariableElement::clone ( ) const

virtual

Make and return a copy of this.

Used by the factory from a prototype.

Implements ncml_module::NCMLElement.

Definition at line 97 of file VariableElement.cc.

References VariableElement().

Here is the call graph for this function:

int agg_util::RCObject::getRefCount ( ) const

virtualinherited

Get the current reference count.

Implements agg_util::RCObjectInterface.

Definition at line 110 of file RCObject.cc.

const string & ncml_module::VariableElement::getTypeName ( ) const

virtual

Return the type of the element, which should be: the same as ConcreteClassName::getTypeName()

Implements ncml_module::NCMLElement.

Definition at line 91 of file VariableElement.cc.

References _sTypeName.

void ncml_module::VariableElement::handleBegin ( )

virtual

Handle a begin on this element.

Called after creation and it is assumed the attributes and _parser are already set.

Implements ncml_module::NCMLElement.

Definition at line 114 of file VariableElement.cc.

References ncml_module::NCMLElement::_parser, and VALID_PTR.

void ncml_module::VariableElement::handleContent ( const string & content )

virtual

Handle the characters content for the element.

Default impl throws if the content is not all whitespace. Subclasses that handle non-whitespace content should override.

Parameters

content the string of characters in the element content.

Reimplemented from ncml_module::NCMLElement.

Definition at line 121 of file VariableElement.cc.

References ncml_module::NCMLElement::_parser, ncml_module::NCMLParser::getParseLineNumber(), ncml_module::NCMLUtil::isAllWhitespace(), THROW_NCML_PARSE_ERROR, and toString().

Here is the call graph for this function:

void ncml_module::VariableElement::handleEnd ( )

virtual

Handle the closing of this element.

Implements ncml_module::NCMLElement.

Definition at line 134 of file VariableElement.cc.

References ncml_module::NCMLElement::_parser.

bool ncml_module::VariableElement::isNewVariable ( ) const

Returns: whether this variable was created and added as a new variable in this parse

Definition at line 151 of file VariableElement.cc.

Referenced by ncml_module::ValuesElement::handleContent().

bool ncml_module::NCMLElement::isValidAttribute	(	const std::vector< string > &	validAttrs,
		const string &	attr
	)

staticinherited

Returns: whether the given attr is in the array validAttrs or not... Helper for subclasses

Definition at line 246 of file NCMLElement.cc.

Referenced by ncml_module::NCMLElement::areAllAttributesValid().

int ncml_module::NCMLElement::line ( ) const

inherited

Return the current parse line number.

Shorthand

Definition at line 174 of file NCMLElement.cc.

References ncml_module::NCMLElement::_parser, and ncml_module::NCMLParser::getParseLineNumber().

Referenced by ncml_module::ScanElement::getDatasetList(), ncml_module::NetcdfElement::getNcoordsAsUnsignedInt(), ncml_module::ScanElement::getOlderThanAsSeconds(), and ncml_module::ScanElement::handleBegin().

Here is the call graph for this function:

const std::string ncml_module::VariableElement::name ( ) const

inline

Definition at line 80 of file VariableElement.h.

const std::string ncml_module::VariableElement::orgName ( ) const

inline

Definition at line 95 of file VariableElement.h.

std::string ncml_module::NCMLElement::printAttributeIfNotEmpty	(	const std::string &	attrName,
		const std::string &	attrValue
	)

staticinherited

Helper for subclasses implementing toString().

Returns: a string with attrName="attrValue" if !attrValue.empty(), otherwise return the empty string.

Definition at line 240 of file NCMLElement.cc.

Referenced by ncml_module::VariableAggElement::toString(), ncml_module::ScanElement::toString(), ncml_module::DimensionElement::toString(), ncml_module::NetcdfElement::toString(), and ncml_module::AggregationElement::toString().

int agg_util::RCObject::ref ( ) const

virtualinherited

Increase the reference count by one.

const since we do not consider the ref count part of the semantic constness of the rep

Implements agg_util::RCObjectInterface.

Definition at line 74 of file RCObject.cc.

References BESDEBUG.

Referenced by ncml_module::AggregationElement::addChildDataset(), ncml_module::NetcdfElement::addDimension(), ncml_module::AggregationElement::addScanElement(), ncml_module::NetcdfElement::VariableValueValidator::addVariableToValidate(), and agg_util::RCPtr< ncml_module::AggregationElement >::refAndGet().

void agg_util::RCObject::removeFromPool ( ) const

virtualinherited

If the object is in an auto-delete pool, remove it from the pool and force it to only delete when it's ref count goes to 0.

Useful when we desire a particular object stay around outside of the pool's lifetime.

Implements agg_util::RCObjectInterface.

Definition at line 116 of file RCObject.cc.

References NCML_ASSERT, and agg_util::RCObjectPool::remove().

Here is the call graph for this function:

void agg_util::RCObject::removePreDeleteCB ( UseCountHitZeroCB * pCB )

inherited

Remove it exists.

If not, this unchanged.

Definition at line 164 of file RCObject.cc.

References BESDEBUG.

void ncml_module::VariableElement::setAttributes ( const XMLAttributeMap & attrs )

virtual

Set the attributes of this from the map.

Parameters

attrs the attribute map to set this class to.

Implements ncml_module::NCMLElement.

Definition at line 103 of file VariableElement.cc.

References _sValidAttributes, ncml_module::XMLAttributeMap::getValueForLocalNameOrDefault(), and ncml_module::NCMLElement::validateAttributes().

Here is the call graph for this function:

void ncml_module::VariableElement::setGotValues ( )

Called once we set the values from ValuesElement so we are aware.

Definition at line 163 of file VariableElement.cc.

Referenced by ncml_module::NetcdfElement::VariableValueValidator::setVariableGotValues().

void ncml_module::NCMLElement::setParser ( NCMLParser * p )

inherited

Definition at line 166 of file NCMLElement.cc.

References ncml_module::NCMLElement::_parser, and NCML_ASSERT_MSG.

const std::string ncml_module::VariableElement::shape ( ) const

inline

Definition at line 90 of file VariableElement.h.

string ncml_module::VariableElement::toString ( ) const

virtual

Return a string describing the element.

Implements ncml_module::NCMLElement.

Definition at line 140 of file VariableElement.cc.

References _sTypeName.

Referenced by ncml_module::ValuesElement::handleBegin(), ncml_module::ValuesElement::handleContent(), and handleContent().

const std::string ncml_module::VariableElement::type ( ) const

inline

Definition at line 85 of file VariableElement.h.

int agg_util::RCObject::unref	(	)	const
throw	(
	)

virtualinherited

Decrease the reference count by one.

If it goes from 1 to 0, delete this and this is no longer valid.

Returns: the new ref count. If it is 0, the caller knows the object was deleted.

It is illegal to unref() an object with a count of 0. We don't throw to allow use in dtors, so the caller is assumed not to do it!

const since the reference count is not part of the semantic constness of the rep

Implements agg_util::RCObjectInterface.

Definition at line 82 of file RCObject.cc.

References BESDEBUG, agg_util::RCObjectPool::release(), and agg_util::RCObject::toString().

Referenced by ncml_module::NetcdfElement::clearDimensions(), agg_util::RCPtr< ncml_module::AggregationElement >::operator=(), ncml_module::AggregationElement::~AggregationElement(), and ncml_module::NetcdfElement::VariableValueValidator::~VariableValueValidator().

Here is the call graph for this function:

bool ncml_module::NCMLElement::validateAttributes	(	const XMLAttributeMap &	attrs,
		const vector< string > &	validAttrs,
		vector< string > *	pInvalidAttrs = `0`,
		bool	printInvalid = `true`,
		bool	throwOnError = `true`
	)

virtualinherited

Check that the given attributes are all in the valid set, otherwise fill in *pInvalidAttrs with the problematic ones if it's not null.

If pInvalidAttrs && printInvalid is set, we print the problematic attributes to BESDEBUG "ncml" channel If throwOnError is set, we throw a parse error instead of returning.