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

Base class for data item leafs associated to enumerate value. More...

#include <BaseDataItemEnumLeaf.h>

Inheritance diagram for ipsdk::BaseDataItemEnumLeaf:
ipsdk::BaseDataItemLeaf ipsdk::BaseDataItem ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject ipsdk::DataItemEnumLeaf< enumType >

Public Member Functions

eDataItemValueType getDataItemValueType () const
 retrieve data item value type
 
virtual std::string getEnumNameStr () const
 method allowing to retrieve enumerate name
 
virtual std::string getValueStr () const
 retrieve string representation associated to enumerate value
 
Constructors and destructors
 BaseDataItemEnumLeaf ()
 
 ~BaseDataItemEnumLeaf ()
 
- Public Member Functions inherited from ipsdk::BaseDataItemLeaf
eDataItemType getDataItemType () const
 retrieve data item type
 
 BaseDataItemLeaf ()
 
virtual ~BaseDataItemLeaf ()=0
 
- Public Member Functions inherited from ipsdk::BaseDataItem
 BaseDataItem ()
 
virtual ~BaseDataItem ()=0
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- 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
 

Static Public Attributes

static const eDataItemValueType::domain g_dataItemValueType = eDataItemValueType::eDIVT_Enum
 enumerate associated to value type
 
- Static Public Attributes inherited from ipsdk::BaseDataItemLeaf
static const bool g_bIsColl = false
 flags indicating item type
 
static const bool g_bNode = false
 flags indicating item type
 
static const bool g_bLeaf = true
 flags indicating item type
 
static const eDataItemType::domain g_itemType = eDataItemType::eDIT_Leaf
 flags indicating item type
 

Protected Member Functions

virtual bool fromString (const std::string &strValue, ipUInt32 &intValue) const
 method allowing to convert enumerate string value to an integer value More...
 
virtual bool toString (const ipUInt32 &intValue, std::string &strValue) const
 method allowing to convert enumerate integer value to a string value More...
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- 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
 

Protected Attributes

ipUInt32 _enumValue
 integer value associated to enumerate
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 

Detailed Description

Base class for data item leafs associated to enumerate value.

Author
E. Noirfalise
Date
2015/07/08

Member Function Documentation

◆ fromString()

bool ipsdk::BaseDataItemEnumLeaf::fromString ( const std::string &  strValue,
ipUInt32 intValue 
) const
inlineprotectedvirtual

method allowing to convert enumerate string value to an integer value

Returns
false in case of error

Reimplemented in ipsdk::DataItemEnumLeaf< enumType >.

◆ toString()

bool ipsdk::BaseDataItemEnumLeaf::toString ( const ipUInt32 intValue,
std::string &  strValue 
) const
inlineprotectedvirtual

method allowing to convert enumerate integer value to a string value

Returns
false in case of error

Reimplemented in ipsdk::DataItemEnumLeaf< enumType >.


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