DDD_ConvertBase.h

Go to the documentation of this file.

#ifndef _DDD_ConvertBase_h_
#define _DDD_ConvertBase_h_

/*! \file DDD_ConvertBase.h
  \brief  The DDD_ConvertBase class.  Base class for Data Director converters.

  \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_ConnectionEndpoint.h"
#include "DDD_AssetBase.h"
#include <string>


/** \def Create_ConverterFactory(ConvertName, ConvertType)  use this to allow the converter factory to find the create function
  *
  * Example:
  * Create_ConverterFactory(Assign, DDD_ConvertAssign);
  * create a function called Create_ConvertAssign that returns an instance of 
  * DDD_ConvertAssign as a DDD_ConvertBase *
*/
#define Create_ConverterFactory(ConvertName, ConvertType) DDD_EXPORT_EXTERN_C DDD_ConvertBase *Create_Convert##ConvertName(DDD_AttributeObserver* observer) \
{ \
    return new ConvertType(observer); \
}

namespace disti
{

#define MAX_CONVERTER_INPUT   65535  /**< Maximum number of inputs (limited for performance) */
#define MAX_CONVERTER_OUTPUT  65535  /**< Maximum number of outputs (limited for performance) */

/** \brief Abstract base class for all DDD_DataDirector converters */
class DDD_EXPORT DDD_ConvertBase : public DDD_Base, public DDD_AttributeContainer
{
public:
    /** Constructor */
    DDD_ConvertBase();

    /* Destructor */
    virtual ~DDD_ConvertBase();

    /** \return Returns string identifying which version of DataDirector this converter was built against
      */
    const char * DataDirectorVersion();

    /** Returns a string label for the input index.
      * Converters must provide named labels to differentiate between different inputs/outputs.
      * \param index  The index of the input
      */
    virtual std::string EndpointInputName(int index);

    /** Returns a string label for the output index.
      * Converters must provide named labels to differentiate between different inputs/outputs.
      * \param index  The index of the output
      */
    virtual std::string EndpointOutputName(int index);

    /** Initializes the converter, if necessary
      * \param paramString 
      * \return True if the converter was successfully initialized.
      */
    virtual bool Init(const std::string &paramStr);

    /** \return Returns the minimum number of inputs required by this converter
      */
    virtual int MinInputs() { return 1; }

    /** \return Returns the maximum number of inputs supported by this converter
      */
    virtual int MaxInputs() { return 1; }

    /** \return Returns the minimum number of outputs required by this converter
      */
    virtual int MinOutputs() { return 1; }

    /** \return Returns the maximum number of outputs supported by this converter
      */
    virtual int MaxOutputs() { return 1; }
    
    /** \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);

    // These must be implemented /////////////////////////////////////////////////////

    /** Performs the actual conversion function
      * \param inputs  A list of inputs to the converter
      * \param outputs  A list of outputs to the converter
      * \return True if the converter fired.
      */
    virtual bool Convert(DDD_EndpointList& inputs, DDD_EndpointList& outputs) = 0;

    /** \return Returns the class name of this converter
      */
    virtual const char* ClassName() = 0;

    /** Used by the GUI to explain what this converter does
      * \return Returns a string for the GUI to use
      */
    virtual const char* Description()=0;

    // From DDD_AttributeContainer
    virtual const char* GetName() {return GetInstanceName();}

protected:
    /** Checks that nInputs fall within the allowed number of inputs
      * \param nInputs The number of inputs
      * \return True if the number of inputs is valid 
      */
    bool InputsOK(int nInputs);

    /** Checks that nOutputs fall within the allowed number of outputs
      * \param nOutputs The number of outputs
      * \return True if the number of outputs is valid 
      */
    bool OutputsOK(int nOutputs);
};


}   // end namespace disti

#endif