bes  Updated for version 3.20.6
DimensionElement.h
1 // This file is part of the "NcML Module" project, a BES module designed
3 // to allow NcML files to be used to be used as a wrapper to add
4 // AIS to existing datasets of any format.
5 //
6 // Copyright (c) 2009 OPeNDAP, Inc.
7 // Author: Michael Johnson <m.johnson@opendap.org>
8 //
9 // For more information, please also see the main website: http://opendap.org/
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License along with this library; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 //
25 // Please see the files COPYING and COPYRIGHT for more information on the GLPL.
26 //
27 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
29 #ifndef __NCML_MODULE__DIMENSION_ELEMENT_H__
30 #define __NCML_MODULE__DIMENSION_ELEMENT_H__
31 
32 #include "Dimension.h"
33 #include "NCMLElement.h"
34 
35 namespace ncml_module {
36 
37 class NCMLParser;
38 
56 private:
57  DimensionElement& operator=(const DimensionElement& rhs); // disallow
58 
59 public:
60  static const std::string _sTypeName;
61  static const std::vector<std::string> _sValidAttributes;
62 
64  DimensionElement(const DimensionElement& proto);
66  virtual ~DimensionElement();
67  virtual const std::string& getTypeName() const;
68  virtual DimensionElement* clone() const; // override clone with more specific subclass
69  virtual void setAttributes(const XMLAttributeMap& attrs);
70  virtual void handleBegin();
71  virtual void handleContent(const std::string& content);
72  virtual void handleEnd();
73  virtual std::string toString() const;
74 
79  bool checkDimensionsMatch(const DimensionElement& rhs) const;
80 
81  const std::string& name() const;
82  const std::string& length() const
83  {
84  return _length;
85  }
86 
88  unsigned int getLengthNumeric() const;
89  unsigned int getSize() const;
90 
91  const agg_util::Dimension& getDimension() const
92  {
93  return _dim;
94  }
95 
96 private:
97 #if 0
98 
102  void parseAndCacheDimension();
103 
107  void validateOrThrow();
108 #endif
109 
115  void parseValidateAndCacheDimension();
116 
120  static std::vector<std::string> getValidAttributes();
121 
122  void processRenameDimension(NCMLParser& p);
123 
124 private:
125  // string _name; // within _dim
126  std::string _length; // unparsed size
127  std::string _orgName; // unparsed original name
128  std::string _isUnlimited; // unused
129  std::string _isShared; // unused
130  std::string _isVariableLength; // unused
131 
132  // the actual parsed values from above...
133  agg_util::Dimension _dim;
134 };
135 
136 }
137 
138 #endif /* __NCML_MODULE__DIMENSION_ELEMENT_H__ */
ncml_module::DimensionElement::toString
virtual std::string toString() const
Definition: DimensionElement.cc:170
ncml_module::DimensionElement::handleEnd
virtual void handleEnd()
Definition: DimensionElement.cc:165
ncml_module::DimensionElement::handleContent
virtual void handleContent(const std::string &content)
Definition: DimensionElement.cc:156
agg_util::Dimension
Definition: Dimension.h:49
ncml_module::NCMLParser
Definition: NCMLParser.h:158
ncml_module::DimensionElement::setAttributes
virtual void setAttributes(const XMLAttributeMap &attrs)
Definition: DimensionElement.cc:80
ncml_module::XMLAttributeMap
Definition: XMLHelpers.h:93
ncml_module::DimensionElement
Definition: DimensionElement.h:55
ncml_module::DimensionElement::handleBegin
virtual void handleBegin()
Definition: DimensionElement.cc:96
ncml_module::NCMLElement
Base class for NcML element concrete classes.
Definition: NCMLElement.h:61
ncml_module::DimensionElement::getTypeName
virtual const std::string & getTypeName() const
Definition: DimensionElement.cc:69
ncml_module::DimensionElement::checkDimensionsMatch
bool checkDimensionsMatch(const DimensionElement &rhs) const
Definition: DimensionElement.cc:183
ncml_module::DimensionElement::clone
virtual DimensionElement * clone() const
Definition: DimensionElement.cc:75
ncml_module
NcML Parser for adding/modifying/removing metadata (attributes) to existing local datasets using NcML...
Definition: AggregationElement.cc:72
ncml_module::DimensionElement::getLengthNumeric
unsigned int getLengthNumeric() const
Definition: DimensionElement.cc:194