DDD_ConvertClamp Class Reference

Clamp Converter. More...

#include <DDD_ConvertClamp.h>

Inheritance diagram for DDD_ConvertClamp:

Public Member Functions
	DDD_ConvertClamp (DDD_AttributeObserver *observer)
virtual	~DDD_ConvertClamp ()
virtual bool	Init (const std::string &params)
virtual bool	ConfigurationValid (DDD_EndpointList &inputs, DDD_EndpointList &outputs)
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 int	MinInputs ()
virtual int	MaxInputs ()
virtual int	MinOutputs ()
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_AttributeList &	GetParams ()

Static Public Attributes
static const char *	CONVERT_CLAMP_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

Clamp Converter.

Restricts output to fit within a specified domain of [min, max].
input: [1,1]
ouput: [1,MAX_CONVERTER_OUTPUT]
parameters:
min (double)
max (double)

Note

Converter will refuse to run if min >= max.

Constructor & Destructor Documentation

DDD_ConvertClamp

(

DDD_AttributeObserver *

observer

)

Constructor

Parameters

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.

virtual ~DDD_ConvertClamp ( )

virtual

Destructor

Member Function Documentation

virtual const char* ClassName ( )

inlinevirtual

Returns

Returns the class name of this converter

Implements DDD_ConvertBase.

virtual bool ConfigurationValid ( DDD_EndpointList &  inputs, DDD_EndpointList &  outputs  )

virtual

Returns

Returns true if the converter's configuration is valid

Parameters

inputs	List of converter inputs
outputs	List of converter outputs

Reimplemented from DDD_ConvertBase.

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

virtual

Performs the actual conversion function

Parameters

inputs	A list of inputs to the converter
outputs	A 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 bool Init ( const std::string &  paramStr )

virtual

Initializes the converter, if necessary

Parameters

paramString

Returns

True if the converter was successfully initialized.

Reimplemented from 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_CLAMP_CLASSNAME

static

Classname string constant. Needed by the ConverterFactory

---

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

• DDD_ConvertClamp.h