text: /*
   * Copyright (c) 2011-2015, Intel Corporation
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without modification,
   * are permitted provided that the following conditions are met:
   *
   * 1. Redistributions of source code must retain the above copyright notice, this
   * list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright notice,
   * this list of conditions and the following disclaimer in the documentation and/or
   * other materials provided with the distribution.
   *
   * 3. Neither the name of the copyright holder nor the names of its contributors
   * may be used to endorse or promote products derived from this software without
   * specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  #pragma once
  
  #include "parameter_export.h"
  
  #include "ConfigurableElement.h"
  #include "TypeElement.h"
  
  #include <list>
  #include <string>
  
  class IMapper;
  class CParameterBlackboard;
  class CParameterAccessContext;
  
  class PARAMETER_EXPORT CInstanceConfigurableElement : public CConfigurableElement
  {
  public:
      enum Type
      {
          EBitParameter,
          EBitParameterBlock,
          EParameter,
          EStringParameter,
          EParameterBlock,
          EComponent
      };
  
      CInstanceConfigurableElement(const std::string &strName, const CTypeElement *pTypeElement);
  
      // Instantiated type
      const CTypeElement *getTypeElement() const;
  
      bool getMappingData(const std::string &strKey, const std::string *&pStrValue) const override;
  
      /**
       * Returns the mapping data associated to the type element of the current
       * InstanceConfigurableElement, as a formatted std::string
       *
       * @return A std::string containing the formatted mapping
       */
      std::string getFormattedMapping() const override;
  
      // From CElement
      std::string getKind() const override;
      std::string getXmlElementName() const override;
  
      // Syncer to/from HW
      void setSyncer(ISyncer *pSyncer);
      void unsetSyncer();
  
      // Type
      virtual Type getType() const = 0;
  
      // Mapping execution
      bool map(IMapper &mapper, std::string &strError);
  
      // Element properties
      void showProperties(std::string &strResult) const override;
  
      // Scalar or Array?
      bool isScalar() const;
  
      // Array Length
      size_t getArrayLength() const;
  
      void structureToXml(CXmlElement &xmlElement,
                          CXmlSerializingContext &serializingContext) const override;
  
  protected:
      // Syncer
      ISyncer *getSyncer() const override;
      // Syncer set (descendant)
      void fillSyncerSetFromDescendant(CSyncerSet &syncerSet) const override;
  
      /**
       * Performs the sync if the AutoSync is enabled.
       * If AutoSync is disabled, any call to sync will returns true, even if synchronization has not
       * been done. It will happen when the AutoSync will be switched back on.
       *
       * @param[in,out] parameterAccessContext Parameter access context object
       *
       * @return true if the synchronization succeded or if the AutoSync is off, false otherwise.
       */
      bool sync(CParameterAccessContext &parameterAccessContext) const;
  
      // Check parameter access path well formed for leaf elements
      static bool checkPathExhausted(CPathNavigator &pathNavigator,
                                     utility::ErrorContext &errorContext);
  
  private:
      // Type Element
      const CTypeElement *_pTypeElement;
  
      // Sync to HW
      ISyncer *_pSyncer{nullptr};
  };
  