IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
ipsdk::imaproc::attr::InOptRegMotionModel2d Class Reference

[Input Optional] 2d motion model which should be used for computation More...

#include <InOptRegMotionModel2d.h>

Inheritance diagram for ipsdk::imaproc::attr::InOptRegMotionModel2d:
ipsdk::imaproc::BaseIPEnumAttribute ipsdk::imaproc::BaseImageProcessingAttribute ipsdk::processor::BaseAttribute ipsdk::BaseObjectWithSkeleton ipsdk::BaseToolTip ipsdk::BaseIOData ipsdk::BaseOptData ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Types

typedef ipsdk::imaproc::attr::eRegistrationMotionModel2d ValueType
 Enumerate type associated to attribute.
 

Public Member Functions

 ~InOptRegMotionModel2d ()
 destructor
 
const std::string & getObjectName () const
 method allowing to retrieve object name
 
const std::string & getToolTip () const
 method allowing to retrieve object tooltip
 
bool isOptional () const
 retrieve attribute optional state for processing
 
void init (const ipsdk::imaproc::attr::eRegistrationMotionModel2d &value)
 initialize enumerate associated to attribute
 
ipsdk::imaproc::attr::eRegistrationMotionModel2d getValue () const
 
const boost::filesystem::path getHeaderPath () const
 retrieve relative header path associated to attribute
 
const std::string getLibraryName () const
 retrieve library name associated attribute
 
const ValueTypegetDefaultValue () const
 retrieve attribute default value
 
- Public Member Functions inherited from ipsdk::imaproc::BaseIPEnumAttribute
eImageProcessingAttributeType getImageProcessingAttributeType () const
 
- Public Member Functions inherited from ipsdk::imaproc::BaseImageProcessingAttribute
processor::eAttributeType getAttributeType () const
 
- Public Member Functions inherited from ipsdk::processor::BaseAttribute
bool isInit () const
 
const BaseRulegetRule () const
 
BoolResult isValid () const
 
void clear ()
 
bool isOutOptionalInitForced () const
 
void setOutOptionalInitForced (bool bOutOptionalInitForced) const
 
bool isOutOptionalInitForced () const
 
void setOutOptionalInitForced (bool bOutOptionalInitForced) const
 
- Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzModegetSerializationMode () const
 
void setSerializationMode (const eSklSrzMode &sklSrzMode) const
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 
virtual BaseDynamicObjectcreateNew () const=0
 
virtual DynamicObjectPtr createShared () const=0
 
virtual bool hasCopySupport () const=0
 
virtual BaseDynamicObjectduplicate () const=0
 
virtual DynamicObjectPtr duplicateShared () const=0
 
- Public Member Functions inherited from ipsdk::BaseIOData
virtual eIOStatus getIOStatus () const=0
 
virtual bool isInput () const=0
 
virtual bool isOutput () const=0
 
virtual bool isInOut () const=0
 
- Public Member Functions inherited from ipsdk::BaseOptData
virtual eOptStatus getOptStatus () const=0
 
virtual bool isMandatory () const=0
 

Static Public Member Functions

static boost::shared_ptr< InOptRegMotionModel2dcreateAttribute ()
 attribute creation function
 
static const std::string & getObjectNameStr ()
 method allowing to retrieve object name
 
static const std::string & getToolTipStr ()
 method allowing to retrieve object tooltip
 
static const boost::filesystem::path getHeaderPathStr ()
 retrieve relative header path associated to attribute
 
static const std::string getLibraryNameStr ()
 retrieve library name associated attribute
 
- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 

Static Public Attributes

static const bool g_bOptionalAttribute = true
 attribute optional status More...
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseIPEnumAttribute
static const eImageProcessingAttributeType::domain g_imageProcessingAttributeType
 
- Static Public Attributes inherited from ipsdk::imaproc::BaseImageProcessingAttribute
static const processor::eAttributeType::domain g_attributeType
 

Protected Member Functions

 InOptRegMotionModel2d ()
 constructor
 
- Protected Member Functions inherited from ipsdk::imaproc::BaseIPEnumAttribute
void initBase (ipUInt32 enumValue)
 
ipUInt32 accessEnumValue () const
 
virtual bool checkEnumValue (ipUInt32 enumValue) const=0
 
- Protected Member Functions inherited from ipsdk::processor::BaseAttribute
void initBase ()
 
virtual BoolResult syncInputDerived (const Guid &processingSocketGuid)
 
virtual BoolResult syncOutputDerived (const Guid &processingSocketGuid)
 
virtual RulePtr createRule (const AttributePtr &pBaseThis) const=0
 
virtual void clearDerived ()
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 
virtual BoolResult read (BaseIArchive &ar)
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 

Additional Inherited Members

- Static Protected Member Functions inherited from ipsdk::imaproc::BaseIPEnumAttribute
static boost::mutex & getMutex ()
 
- Protected Attributes inherited from ipsdk::imaproc::BaseIPEnumAttribute
ipUInt32 _enumValue
 
- Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode _sklSrzMode
 

Detailed Description

[Input Optional] 2d motion model which should be used for computation

Author
E.Noirfalise
Date
2016/10/27

Default value :

Used default value for attribute : ipsdk::imaproc::attr::eRegistrationMotionModel2d::eRMM2d_Rigid

Attribute associated library :

IPSDKIPLAttributes

Attribute rule :

Rule on attribute is given by
ipsdk::processor::none ()

Member Function Documentation

◆ getValue()

ipsdk::imaproc::attr::eRegistrationMotionModel2d ipsdk::imaproc::attr::InOptRegMotionModel2d::getValue ( ) const

rief get value associated to attribute hrow ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

Member Data Documentation

◆ g_bOptionalAttribute

static const bool ipsdk::imaproc::attr::InOptRegMotionModel2d::g_bOptionalAttribute = true
static

attribute optional status

attribute optional state for processing


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