argumentDescription.h

Go to the documentation of this file.

#ifndef _DLR_COMMON_ARGUMENTDESCRIPTION_H_
#define _DLR_COMMON_ARGUMENTDESCRIPTION_H_

#include <ostream>

namespace dlr {

  namespace common {
  
    template <class Type>
    std::ostream&
    addArgumentDescription(std::ostream& outputStream, const Type& argument)
    {
      outputStream << argument;
      return outputStream;
    }

  } // namespace common
  
} // namespace dlr


#ifdef _DLRCOMMON_USE_TRACEABLE_

#include <map>
#include <vector>

namespace dlr {

  namespace common {
  
    template <class TYPE>
    std::ostream&
    addArgumentDescription(std::ostream& outputStream,
                           const std::vector<TYPE>& argument)
    {
      outputStream << "std::vector([";
      if(argument.empty() == false) {
        outputStream << argument[0];
      }
      for(size_t index0 = 0; index0 < argument.size(); ++index0) {
        outputStream << "," << argument[index0];
      }
      outputStream << "])";
      return outputStream;
    }


    template <class TYPE0, class TYPE1>
    std::ostream&
    addArgumentDescription(std::ostream& outputStream,
                           const std::pair<TYPE0, TYPE1>& argument)
    {
      outputStream << "std::pair(" << argument.first << ", "
                   << argument.second << ")";
      return outputStream;
    }

  } // namespace common
  
} // namespace dlr

#endif /* #ifdef _DLRCOMMON_USE_TRACEABLE_ */


/* ======= Declarations to maintain compatibility with legacy code. ======= */

namespace dlr {

  using common::addArgumentDescription;
  
} // namespace dlr

#endif /* #ifndef _DLR_COMMON_ARGUMENTDESCRIPTION_H_ */

---