ProductRegistry.hpp

// Copyright (c) 2013, Sandia Corporation.
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//
//     * 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.
//
//     * Neither the name of Sandia Corporation 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
// OWNER 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.
//

#ifndef STK_UTIL_ENVIRONMENT_PRODUCTREGISTRY_HPP
#define STK_UTIL_ENVIRONMENT_PRODUCTREGISTRY_HPP

#include <map>
#include <string>

namespace stk_classic {

class ProductRegistry
{
public:
  typedef std::map<std::string, std::string> AttributeMap;  
  typedef std::map<std::string, AttributeMap> ProductMap; 

  static ProductRegistry &instance();

private:
  ProductRegistry()
    : m_productMap(),
      m_productName(),
      m_registryOK(true)
  {}

  ProductRegistry(const ProductRegistry &);

  ProductRegistry &operator=(const ProductRegistry &);

  ~ProductRegistry()
  {}


public:
  static const char *version();

  void setRegistryInvalid() {
    m_registryOK = false;
  }

  bool isRegistryOK() {
    return m_registryOK;
  }

  const std::string &getProductName() const {
    return m_productName;
  }

  void setProductName(const std::string &product_name) {
    m_productName = product_name;
  }

  ProductMap &getProductMap() const {
    return m_productMap;
  }

  AttributeMap &addProduct(const std::string &name);

  AttributeMap &addTPL(const std::string &name, const std::string &version, const std::string &qualifier = "");

  AttributeMap &addRegion(const std::string &name);

  AttributeMap &getProductAttributeMap(const std::string &name);

  const std::string &getProductAttribute(const std::string &name, const std::string &attribute) const;

  std::string &getProductAttribute(const std::string &name, const std::string &attribute);

  void setProductAttribute(const std::string &name, const std::string &attribute, const std::string &value);

public:
  static const std::string  NAME;       
  static const std::string  TITLE;        
  static const std::string      VERSION;                        
  static const std::string      QUALIFIER;                      
  static const std::string  CONTACT;      
  static const std::string  ERROR;        
  static const std::string  PRODUCT_TYPE;     

  static const std::string  EXECUTABLE;     
  static const std::string  BUILD_TIME;     

  static const std::string  BANNER_DETAIL;      
  static const std::string  COPYRIGHT;      

  static const std::string  REGION_TITLE;     

  static const std::string  PRODUCT_TYPE_REGION;    

private:
  mutable ProductMap    m_productMap;     
  std::string                   m_productName;                  
  bool        m_registryOK;     
};

} // namespace stk_classic

#ifdef STK_BUILT_IN_SIERRA
#undef VERSION // Nice, Trilinos leaves us this gem

namespace sierra {

typedef stk_classic::ProductRegistry ProductRegistry;

} // namespace sierra
#endif // STK_BUILT_IN_SIERRA


#endif // STK_UTIL_ENVIRONMENT_PRODUCTREGISTRY_HPP