IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ipsdk::processor::StaticResultSplit< TProcessor, TAttribute > Class Template Reference

Template class for results splitted data used for static data dispatch. More...

#include <StaticResultSplit.h>

Inheritance diagram for ipsdk::processor::StaticResultSplit< TProcessor, TAttribute >:
ipsdk::processor::BaseStaticSplit ipsdk::processor::BaseDataSplit

Public Types

typedef TProcessor ProcessorType
 processor type associated to object
 
typedef TAttribute AttributeType
 attribute type associated to object
 
typedef boost::enable_if_c< boost::is_same< typename TAttribute::StorageType, boost::shared_ptr< typename TAttribute::ValueType > >::value, typename TAttribute::StorageType >::type ParameterType
 parameter type associated to object
 
typedef std::map< ipUInt32, ParameterTypeParameterColl
 collection of elements associated to static split indexed by starting offset
 
typedef boost::shared_ptr< ParameterCollParameterCollPtr
 shared pointer to collection of elements associated to static split
 

Public Member Functions

eSplitStaticType getSplitStaticType () const
 retrieve static split operation type
 
const std::string & getAttributeName () const
 retrieve attribute name associated to split operation
 
const std::string & getAttributeToolTip () const
 retrieve attribute tooltip associated to split operation
 
void init (const ParameterCollPtr &pParameterColl, const ParameterType &pDefaultValue)
 object initialization method
 
Constructors and destructors
 StaticResultSplit ()
 
 ~StaticResultSplit ()
 
- Public Member Functions inherited from ipsdk::processor::BaseStaticSplit
eSplitBaseType getSplitBaseType () const
 retrieve split operation base type
 
BoolResult initAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
 initialize processor attribute associate to split operation for a starting element index and a number of elements More...
 
 BaseStaticSplit ()
 
virtual ~BaseStaticSplit ()=0
 
- Public Member Functions inherited from ipsdk::processor::BaseDataSplit
bool isInit () const
 retrieve object initialization flag
 
bool isSplitted () const
 check whether object will be associated to split operation More...
 
const ElementsLocationInfogetElementsLocationInfo () const
 retrieve data location informations More...
 
ipUInt64 getFullMemorySize () const
 retrieve full memory data size for elements More...
 
bool areDataLocalized () const
 check whether data are localized More...
 
bool hasLocalData () const
 check whether some data are local data More...
 
bool hasRemoteData () const
 check whether some data are remote data More...
 
void disableDataLocalization ()
 method allowing to disable data localization More...
 
 BaseDataSplit ()
 
virtual ~BaseDataSplit ()=0
 
ipUInt64 getNbElements () const
 retrieve total number of elements associated to input data More...
 
ipUInt64 getDataMemorySize (const ipUInt64 elementIdx) const
 retrieve memory size of data for a given element More...
 
ipUInt64 getDataMemorySize () const
 retrieve memory size of data for a given element More...
 

Protected Member Functions

bool checkProcessorType (const BaseProcessor &processor)
 check processor type in derived class
 
BoolResult processAttribute (BaseProcessor &processor, const ipUInt32 elementIdx, const core::BaseRequestOrigin &requestOrigin)
 initialize processor attribute associate to split operation for a given element index More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseDataSplit
void initBaseSplitted (const ElementsLocationInfo &elementsLocationInfo)
 base class initialization method for splitted elements More...
 
void initBaseUnSplitted (const ElementsLocationInfo &elementsLocationInfo)
 base class initialization method for un splitted elements More...
 
void throwNullInputSharedPtr ()
 

Protected Attributes

ParameterCollPtr _pParameterColl
 collection of elements associated to static split
 
ParameterType _pDefaultValue
 default value for split operation
 

Additional Inherited Members

- Static Public Attributes inherited from ipsdk::processor::BaseStaticSplit
static const eSplitBaseType::domain g_splitBaseType = eSplitBaseType::eSBT_Static
 data split type associated to object
 

Detailed Description

template<typename TProcessor, typename TAttribute>
class ipsdk::processor::StaticResultSplit< TProcessor, TAttribute >

Template class for results splitted data used for static data dispatch.

Author
E. Noirfalise
Date
2014/03/07

Member Function Documentation

◆ processAttribute()

template<typename TProcessor , typename TAttribute >
BoolResult ipsdk::processor::StaticResultSplit< TProcessor, TAttribute >::processAttribute ( BaseProcessor processor,
const ipUInt32  elementIdx,
const core::BaseRequestOrigin requestOrigin 
)
inlineprotectedvirtual

initialize processor attribute associate to split operation for a given element index

Returns
false in case of failure

Implements ipsdk::processor::BaseStaticSplit.


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