IDOMFunction Class Reference

Base class for PDF/PS Style functions All function instances throw IEDLError exceptions on failure. More...

#include <idomfunction.h>

Inheritance diagram for IDOMFunction:

Public Types
enum	eFunctionType
	An enum for the various types of functions.

Public Member Functions
virtual eFunctionType	getFunctionType () const =0
	Retrieves function type.
virtual uint32	getNumInputValues () const =0
	Get the number of input values that this function will operate on.
virtual uint32	getNumOutputValues () const =0
	Get the number of output values that this function will produce.
virtual void	getInputDomain (uint32 inputNum, float &low, float &high) const =0
	Get the input domain for a given input to the function.
virtual bool	getOutputRange (uint32 outputNum, float &low, float &high) const =0
	Get the output range for a given input to the function.
virtual void	evaluate (const float *inputValues, float *outputValues) const =0
	Evaluate the input through the function and return the result.
virtual void	evaluate (const int32 *inputValues, float *outputValues) const =0
	Evaluate the input through the function and return the result.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Base class for PDF/PS Style functions All function instances throw IEDLError exceptions on failure.

Member Function Documentation

evaluate() [1/2]

virtual void IDOMFunction::evaluate ( const float * inputValues, float * outputValues ) const

pure virtual

Evaluate the input through the function and return the result.

Parameters

inputValues	An array of floats that are input into the function. The size of the array must be the same as the required number of inputValues
outputValues	An array of floats that are the result of evaluating the input through the function. The size of the array must be the same as the required number of inputValues

evaluate() [2/2]

virtual void IDOMFunction::evaluate ( const int32 * inputValues, float * outputValues ) const

pure virtual

Evaluate the input through the function and return the result.

Parameters

inputValues	An array of integers that are input into the function. The size of the array must be the same as the required number of inputValues
outputValues	An array of floats that are the result of evaluating the input through the function. The size of the array must be the same as the required number of inputValues

getFunctionType()

virtual eFunctionType IDOMFunction::getFunctionType ( ) const

pure virtual

Retrieves function type.

Returns

eFunctionType The function type

getInputDomain()

virtual void IDOMFunction::getInputDomain ( uint32 inputNum, float & low, float & high ) const

pure virtual

Get the input domain for a given input to the function.

Parameters

inputNum	The 0-indexed input number
low	A reference to receive the low domain bound for the given inputNum
high	A reference to receive the high domain bound for the given inputNum

getNumInputValues()

virtual uint32 IDOMFunction::getNumInputValues ( ) const

pure virtual

Get the number of input values that this function will operate on.

Returns

uint32 The number of input values.

getNumOutputValues()

virtual uint32 IDOMFunction::getNumOutputValues ( ) const

pure virtual

Get the number of output values that this function will produce.

Returns

uint32 The number of output values.

getOutputRange()

virtual bool IDOMFunction::getOutputRange ( uint32 outputNum, float & low, float & high ) const

pure virtual

Get the output range for a given input to the function.

Parameters

outputNum	The 0-indexed output number
low	A reference to receive the low range bound for the given outputNum
high	A reference to receive the high range bound for the given outputNum

Returns

bool Returns true on success. False if there is no output range (which is not required for all function types).

---

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

• idomfunction.h