DataItemTypes.h

Go to the documentation of this file.

// DataItemTypes.h:
// ----------------
//

#ifndef __IPSDKBASEDATA_DATAITEMTYPES_H__
#define __IPSDKBASEDATA_DATAITEMTYPES_H__

#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKUtil/Tools/EnumMacros.h>
#include <boost/shared_ptr.hpp>
#include <set>

namespace ipsdk {

class BaseDataItem;
class BaseDataItemLeaf;
template <typename T>
class DataItemLeaf;
class BaseDataItemLeafColl;
template <typename T>
class DataItemLeafColl;
class BaseDataItemNode;
class BaseDataItemNodeColl;
class DataItemMap;


IPSDK_ENUM(eDataItemType,

    (eDIT_Leaf)         
    (eDIT_Node)         
    (eDIT_LeafColl)     
    (eDIT_NodeColl)     
    (eDIT_Map)          
)

IPSDK_ENUM(eDataItemValueType,

    (eDIVT_Bool)     
    (eDIVT_Int8)     
    (eDIVT_UInt8)    
    (eDIVT_Int16)    
    (eDIVT_UInt16)   
    (eDIVT_Int32)    
    (eDIVT_UInt32)   
    (eDIVT_Int64)    
    (eDIVT_UInt64)   
    (eDIVT_Real32)   
    (eDIVT_Real64)   
    (eDIVT_String)   
    (eDIVT_Path)     
    (eDIVT_Enum)     
)


typedef DataItemLeaf<ipBool>                    BoolDataItem;
typedef DataItemLeaf<ipInt8>                    Int8DataItem;
typedef DataItemLeaf<ipUInt8>                   UInt8DataItem;
typedef DataItemLeaf<ipInt16>                   Int16DataItem;
typedef DataItemLeaf<ipUInt16>                  UInt16DataItem;
typedef DataItemLeaf<ipInt32>                   Int32DataItem;
typedef DataItemLeaf<ipUInt32>                  UInt32DataItem;
typedef DataItemLeaf<ipInt64>                   Int64DataItem;
typedef DataItemLeaf<ipUInt64>                  UInt64DataItem;
typedef DataItemLeaf<ipReal32>                  Real32DataItem;
typedef DataItemLeaf<ipReal64>                  Real64DataItem;
typedef DataItemLeaf<std::string>               StringDataItem;
typedef DataItemLeaf<boost::filesystem::path>   PathDataItem;

// \brief basic collections for data items
typedef DataItemLeafColl<ipBool>                    BoolVectorDataItem;
typedef DataItemLeafColl<ipInt8>                    Int8VectorDataItem;
typedef DataItemLeafColl<ipUInt8>                   UInt8VectorDataItem;
typedef DataItemLeafColl<ipInt16>                   Int16VectorDataItem;
typedef DataItemLeafColl<ipUInt16>                  UInt16VectorDataItem;
typedef DataItemLeafColl<ipInt32>                   Int32VectorDataItem;
typedef DataItemLeafColl<ipUInt32>                  UInt32VectorDataItem;
typedef DataItemLeafColl<ipInt64>                   Int64VectorDataItem;
typedef DataItemLeafColl<ipUInt64>                  UInt64VectorDataItem;
typedef DataItemLeafColl<ipReal32>                  Real32VectorDataItem;
typedef DataItemLeafColl<ipReal64>                  Real64VectorDataItem;
typedef DataItemLeafColl<std::string>               StringVectorDataItem;
typedef DataItemLeafColl<boost::filesystem::path>   PathVectorDataItem;


typedef std::set<std::string> ItemNames;

typedef boost::shared_ptr<BaseDataItem> DataItemPtr;

typedef boost::shared_ptr<const BaseDataItem> DataItemConstPtr;

typedef boost::shared_ptr<BaseDataItemLeaf> DataItemLeafPtr;

typedef boost::shared_ptr<BaseDataItemLeafColl> DataItemLeafCollPtr;

typedef boost::shared_ptr<BaseDataItemNode> DataItemNodePtr;

typedef boost::shared_ptr<const BaseDataItemNode> DataItemNodeConstPtr;

typedef boost::shared_ptr<BaseDataItemNodeColl> DataItemNodeCollPtr;

typedef boost::shared_ptr<DataItemMap> DataItemMapPtr;

typedef boost::shared_ptr<const DataItemMap> DataItemMapConstPtr;


typedef DataItemNodePtr (*DataItemNodeCreator)();


template <typename T>
struct DataItemValueType2Enum;

#define IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ValueType, EnumValue)                           \
    template<> struct DataItemValueType2Enum<ValueType> {                                       \
        static const eDataItemValueType::domain g_enumValue = eDataItemValueType::EnumValue;    \
    };

IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipBool, eDIVT_Bool);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipInt8, eDIVT_Int8);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipUInt8, eDIVT_UInt8);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipInt16, eDIVT_Int16);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipUInt16, eDIVT_UInt16);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipInt32, eDIVT_Int32);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipUInt32, eDIVT_UInt32);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipInt64, eDIVT_Int64);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipUInt64, eDIVT_UInt64);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipReal32, eDIVT_Real32);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(ipReal64, eDIVT_Real64);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(std::string, eDIVT_String);
IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT(boost::filesystem::path, eDIVT_Path);

template <eDataItemValueType::value_type enumValue>
struct Enum2DataItemValueType;

#define IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ValueType, EnumValue)  \
    template<> struct Enum2DataItemValueType<eDataItemValueType::EnumValue> { \
        typedef ValueType Type;                              \
    };

IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipBool, eDIVT_Bool);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipInt8, eDIVT_Int8);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipUInt8, eDIVT_UInt8);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipInt16, eDIVT_Int16);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipUInt16, eDIVT_UInt16);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipInt32, eDIVT_Int32);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipUInt32, eDIVT_UInt32);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipInt64, eDIVT_Int64);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipUInt64, eDIVT_UInt64);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipReal32, eDIVT_Real32);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(ipReal64, eDIVT_Real64);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(std::string, eDIVT_String);
IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE(boost::filesystem::path, eDIVT_Path);


} // end of namespace ipsdk

#endif // __IPSDKBASEDATA_DATAITEMTYPES_H__