include/geometry/mapSurfaceToRoughness.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: mapSurfaceToRoughness.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/

// \file mapSurfaceToRoughness.h
// \brief DtMapSurfaceToRoughness; helper class that maps a DtSurface to a
// DtRoughnessSoilType

#ifndef DtMapSurfaceToRoughness_H_
#define DtMapSurfaceToRoughness_H_

#include "geometry/geometryDefines.h"
#include "geometry/surface.h"

// DtMapSurfaceToRoughness is a functor that maps a DtSurface type to a 
// DtRoughnessSoilType
class DT_DLL_geometry DtMapSurfaceToRoughness
{
public:

   // default constructor
   DtMapSurfaceToRoughness();

   // destructor
   virtual ~DtMapSurfaceToRoughness();

   // copy constructor
   DtMapSurfaceToRoughness(const DtMapSurfaceToRoughness& orig);

   // assignment operator
   DtMapSurfaceToRoughness& operator=(const DtMapSurfaceToRoughness& orig);

   // Function call operator.  Maps given DtSurface to a DtRoughnessSoilType.
   virtual enum DtRoughnessSoilType operator()( const DtSurface& surface ) const;
};

#endif