xmltooling/AbstractComplexElement.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file AbstractComplexElement.h\r
  19  * \r
  20  * AbstractXMLObject mixin that implements children\r
  21  */\r
  22 \r
  23 #ifndef __xmltooling_abscomplexel_h__\r
  24 #define __xmltooling_abscomplexel_h__\r
  25 \r
  26 #include <xmltooling/AbstractXMLObject.h>\r
  27 \r
  28 #if defined (_MSC_VER)\r
  29     #pragma warning( push )\r
  30     #pragma warning( disable : 4250 4251 )\r
  31 #endif\r
  32 \r
  33 namespace xmltooling {\r
  34 \r
  35     /**\r
  36      * AbstractXMLObject mixin that implements children.\r
  37      * Inherit from this class to implement an element with child objects.\r
  38      * No unprotected access to them is supplied here.\r
  39      */\r
  40     class XMLTOOL_API AbstractComplexElement : public virtual AbstractXMLObject\r
  41     {\r
  42     public:\r
  43         virtual ~AbstractComplexElement();\r
  44         \r
  45         bool hasChildren() const {\r
  46             return !m_children.empty();\r
  47         }\r
  48 \r
  49         const std::list<XMLObject*>& getOrderedChildren() const {\r
  50             return m_children;\r
  51         }\r
  52 \r
  53         void removeChild(XMLObject* child);\r
  54 \r
  55     protected:\r
  56         AbstractComplexElement() {}\r
  57         \r
  58         /** Copy constructor. */\r
  59         AbstractComplexElement(const AbstractComplexElement& src) {}\r
  60 \r
  61         /**\r
  62          * Underlying list of child objects.\r
  63          * Manages the lifetime of the children.\r
  64          */\r
  65         std::list<XMLObject*> m_children;\r
  66     };\r
  67     \r
  68 };\r
  69 \r
  70 #if defined (_MSC_VER)\r
  71     #pragma warning( pop )\r
  72 #endif\r
  73 \r
  74 #endif /* __xmltooling_abscomplexel_h__ */\r