DDD_ConvertClamp.h

Go to the documentation of this file.

#ifndef _CONVERT_CLAMP_H_
#define _CONVERT_CLAMP_H_

/*! \file DDD_ConvertClamp.h
  \brief  The DDD_ConvertClamp class.   Data Director converter.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#include "DDD_ConvertBase.h"
#include "DDD_AttributeDouble.h"
#include "DDD_ConnectionEndpoint.h"

namespace disti
{

////////////////////////////////////////////////////////////////////////////////
/** \brief  Clamp Converter
  *
  *  Restricts output to fit within a specified domain of [min, max]. <br>
  *  input: [1,1] <br>
  *  ouput: [1,MAX_CONVERTER_OUTPUT] <br>
  *  parameters: <br>
  *     \b min \a (double) <br>
  *     \b max \a (double) <br>
  * \note  Converter will refuse to run if min >= max. <br>
  */
class DDD_ConvertClamp : public DDD_ConvertBase 
{
public:

    /** Constructor 
      * \param observer  An attribute observer that will observer the parameters of the converter
      * All converter parameters must use this observer for the converter to work right in the
      * Data Director GUI.
      */
    DDD_ConvertClamp(DDD_AttributeObserver *observer);

    /** Destructor */
    virtual ~DDD_ConvertClamp();

    static const char* CONVERT_CLAMP_CLASSNAME; /**< Classname string constant.  Needed by the ConverterFactory */

    // Overrides from DDD_ConvertBase
    virtual bool Init(const std::string &params);

    /** \return Returns true if the converter's configuration is valid
      * \param inputs  List of converter inputs 
      * \param outputs  List of converter outputs
      */
    virtual bool ConfigurationValid(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    virtual bool Convert(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    virtual int MaxOutputs(){ return MAX_CONVERTER_OUTPUT; }

    virtual const char* ClassName() { return CONVERT_CLAMP_CLASSNAME; }

    virtual const char* Description() { return "Restricts output to fit within a specified domain of [min, max].\nConverter will refuse to run if min >= max."; }

private:
    DDD_AttributeDouble *_min,  /**< The min value for the converter */
                        *_max;  /**< The max value for the converter */ 
};

}   // end namespace disti
#endif