Home | History | Annotate | Download | only in parameter
      1 /*
      2  * Copyright (c) 2011-2015, Intel Corporation
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without modification,
      6  * are permitted provided that the following conditions are met:
      7  *
      8  * 1. Redistributions of source code must retain the above copyright notice, this
      9  * list of conditions and the following disclaimer.
     10  *
     11  * 2. Redistributions in binary form must reproduce the above copyright notice,
     12  * this list of conditions and the following disclaimer in the documentation and/or
     13  * other materials provided with the distribution.
     14  *
     15  * 3. Neither the name of the copyright holder nor the names of its contributors
     16  * may be used to endorse or promote products derived from this software without
     17  * specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
     23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
     26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 #pragma once
     31 
     32 #include "parameter_export.h"
     33 
     34 #include <map>
     35 #include <string>
     36 
     37 #include "Element.h"
     38 
     39 class CElementBuilder;
     40 
     41 class PARAMETER_EXPORT CElementLibrary
     42 {
     43     typedef std::map<std::string, const CElementBuilder *> ElementBuilderMap;
     44     typedef ElementBuilderMap::iterator ElementBuilderMapIterator;
     45     typedef ElementBuilderMap::const_iterator ElementBuilderMapConstIterator;
     46 
     47 public:
     48     virtual ~CElementLibrary();
     49 
     50     /** Add a xml tag and it's corresponding builder in the library.
     51        *
     52        * @param[in] type is the tag of an xml element that can be given to the builder to
     53        *                 create a new element.
     54        * @param[in] pElementBuilder is the tag associated element builder.
     55        */
     56     void addElementBuilder(const std::string &type, const CElementBuilder *pElementBuilder);
     57     void clean();
     58 
     59     // Instantiation
     60     CElement *createElement(const CXmlElement &xmlElement) const;
     61 
     62 private:
     63     // Builder type
     64     virtual std::string getBuilderType(const CXmlElement &xmlElement) const;
     65 
     66     // Builders
     67     ElementBuilderMap _elementBuilderMap;
     68 };
     69