IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Public Attributes | List of all members
ipsdk::processor::AlgorithmFunctionIdentifier Class Reference

Class allowing to identify a processing function. More...

#include <AlgorithmFunctionIdentifier.h>

Inheritance diagram for ipsdk::processor::AlgorithmFunctionIdentifier:
ipsdk::BaseDynamicObject

Public Types

typedef DataTypeIdentifierColl DataTypeIdColl
 data type identifier collection associated to object
 
typedef InstructionSetsIdentifier InstructionSetsId
 instruction sets identifier collection associated to object
 
typedef BaseProcessingAlgorithm::FunctionType FunctionType
 function type associated to object
 

Public Member Functions

bool isInit () const
 retrieve object initialisation flag
 
void init (const DataTypeIdColl &dataTypeIdColl, const InstructionSetsId &instructionSetsId, const ipUInt32 computationEfficiency, const FunctionType function)
 object initialization More...
 
const eISAlignmentgetAlignmentType () const
 retrieve data alignment type associated to identifier More...
 
ipUInt8 getAlignmentSize () const
 retrieve data alignment size associated to identifier More...
 
const DataTypeIdCollgetDataTypeIdColl () const
 retrieve data types collection associated to function More...
 
const InstructionSetsIdgetInstructionSetsId () const
 retrieve instruction sets associated to function More...
 
ipUInt32 getComputationEfficiency () const
 retrieve computation efficiency associated to function More...
 
FunctionType getFunction () const
 retrieve underlying processing function More...
 
void clear ()
 clear of object data
 
Constructors and destructors
 AlgorithmFunctionIdentifier ()
 
 ~AlgorithmFunctionIdentifier ()
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Public Attributes

DataTypeIdColl _dataTypeCollId
 data type identifiers associated to function
 
InstructionSetsId _instructionSetsId
 instruction sets associated to function
 
ipUInt32 _computationEfficiency
 computation efficiency associated to function
 
FunctionType _function
 underlying image processing function
 
bool _bInit
 object initialisation flag
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

Class allowing to identify a processing function.

Author
E. Noirfalise
Date
2014/2/17

Member Function Documentation

◆ init()

void ipsdk::processor::AlgorithmFunctionIdentifier::init ( const DataTypeIdColl dataTypeIdColl,
const InstructionSetsId instructionSetsId,
const ipUInt32  computationEfficiency,
const FunctionType  function 
)

object initialization

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif dataTypeIdColl.isInit() == false
ipsdk::processor::IPSDKBaseProcessingExceptionif instructionSetsId.isInit() == false

◆ getAlignmentType()

const eISAlignment& ipsdk::processor::AlgorithmFunctionIdentifier::getAlignmentType ( ) const

retrieve data alignment type associated to identifier

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getAlignmentSize()

ipUInt8 ipsdk::processor::AlgorithmFunctionIdentifier::getAlignmentSize ( ) const

retrieve data alignment size associated to identifier

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getDataTypeIdColl()

const DataTypeIdColl& ipsdk::processor::AlgorithmFunctionIdentifier::getDataTypeIdColl ( ) const

retrieve data types collection associated to function

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getInstructionSetsId()

const InstructionSetsId& ipsdk::processor::AlgorithmFunctionIdentifier::getInstructionSetsId ( ) const

retrieve instruction sets associated to function

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getComputationEfficiency()

ipUInt32 ipsdk::processor::AlgorithmFunctionIdentifier::getComputationEfficiency ( ) const

retrieve computation efficiency associated to function

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ getFunction()

FunctionType ipsdk::processor::AlgorithmFunctionIdentifier::getFunction ( ) const

retrieve underlying processing function

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

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