DataDirector API
Public Member Functions | Static Public Attributes | List of all members
DDD_ConvertScale Class Reference

Offset Converter. More...

#include <DDD_ConvertScale.h>

Inheritance diagram for DDD_ConvertScale:
DDD_ConvertBase DDD_Base DDD_AttributeContainer DDD_LogFacade

Public Member Functions

 DDD_ConvertScale (DDD_AttributeObserver *observer)
 
virtual ~DDD_ConvertScale ()
 
virtual bool Convert (DDD_EndpointList &inputs, DDD_EndpointList &outputs)
 
virtual int MaxOutputs ()
 
virtual const char * ClassName ()
 
virtual const char * Description ()
 
- Public Member Functions inherited from DDD_ConvertBase
 DDD_ConvertBase ()
 
const char * DataDirectorVersion ()
 
virtual std::string EndpointInputName (int index)
 
virtual std::string EndpointOutputName (int index)
 
virtual bool Init (const std::string &paramStr)
 
virtual int MinInputs ()
 
virtual int MaxInputs ()
 
virtual int MinOutputs ()
 
virtual bool ConfigurationValid (DDD_EndpointList &inputs, DDD_EndpointList &outputs)
 
- Public Member Functions inherited from DDD_Base
 DDD_Base ()
 
virtual ~DDD_Base ()
 
const char * GetInstanceName () const
 
virtual void SetInstanceName (const char *name)
 
virtual void SetParams (const DDD_AttributeList &params)
 
virtual DDD_AttributeListGetParams ()
 

Static Public Attributes

static const char * CONVERT_SCALE_CLASSNAME
 

Additional Inherited Members

- Static Public Member Functions inherited from DDD_LogFacade
static void LogDebug (const char *format,...)
 
static void LogInfo (const char *format,...)
 
static void LogWarning (const char *format,...)
 
static void LogError (const char *format,...)
 
- Protected Member Functions inherited from DDD_ConvertBase
bool InputsOK (int nInputs)
 
bool OutputsOK (int nOutputs)
 
- Protected Attributes inherited from DDD_Base
std::string _instanceName
 
DDD_AttributeList _params
 

Detailed Description

Offset Converter.

Multiplies input by a constant before outputting.
input: [1,1]
ouput: [1,MAX_CONVERTER_OUTPUT]
parameters:
multiplier (double)

Constructor & Destructor Documentation

Constructor

Parameters
observerAn 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.
virtual ~DDD_ConvertScale ( )
virtual

Destructor

Member Function Documentation

virtual const char* ClassName ( )
inlinevirtual
Returns
Returns the class name of this converter

Implements DDD_ConvertBase.

virtual bool Convert ( DDD_EndpointList inputs,
DDD_EndpointList outputs 
)
virtual

Performs the actual conversion function

Parameters
inputsA list of inputs to the converter
outputsA list of outputs to the converter
Returns
True if the converter fired.

Implements DDD_ConvertBase.

virtual const char* Description ( )
inlinevirtual

Used by the GUI to explain what this converter does

Returns
Returns a string for the GUI to use

Implements DDD_ConvertBase.

virtual int MaxOutputs ( )
inlinevirtual
Returns
Returns the maximum number of outputs supported by this converter

< Maximum number of outputs (limited for performance)

Reimplemented from DDD_ConvertBase.

Member Data Documentation

const char* CONVERT_SCALE_CLASSNAME
static

Classname string constant. Needed by the ConverterFactory


The documentation for this class was generated from the following file: