Base class for PDF/PS Style functions All function instances throw IEDLError exceptions on failure.
More...
#include <idomfunction.h>
|
| virtual eFunctionType | getFunctionType () const =0 |
| | Retrieves function type. More...
|
| |
| virtual uint32 | getNumInputValues () const =0 |
| | Get the number of input values that this function will operate on. More...
|
| |
| virtual uint32 | getNumOutputValues () const =0 |
| | Get the number of output values that this function will produce. More...
|
| |
| virtual void | getInputDomain (uint32 inputNum, float &low, float &high) const =0 |
| | Get the input domain for a given input to the function. More...
|
| |
| virtual bool | getOutputRange (uint32 outputNum, float &low, float &high) const =0 |
| | Get the output range for a given input to the function. More...
|
| |
| virtual void | evaluate (const float *inputValues, float *outputValues) const =0 |
| | Evaluate the input through the function and return the result. More...
|
| |
| virtual void | evaluate (const int32 *inputValues, float *outputValues) const =0 |
| | Evaluate the input through the function and return the result. More...
|
| |
| virtual const CClassID & | getClassID () const =0 |
| | Returns class ID of IEDLObject. More...
|
| |
| 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. More...
|
| |
| virtual bool | clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory) |
| | Create a copy of EDLObject. More...
|
| |
|
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. More...
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to. More...
|
| |
|
virtual | ~IDOMHashable () |
| | Virtual destructor.
|
| |
| virtual bool | hash (uint64 &hash)=0 |
| | Retrieve a hash for this object. More...
|
| |
| virtual uint64 | hashE () |
| | As hash(), but throws an exception if the operation fails. More...
|
| |
Base class for PDF/PS Style functions All function instances throw IEDLError exceptions on failure.
◆ 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()
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:
Public Member Functions inherited from IEDLObject