IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Member Functions | List of all members
ipsdk::BaseBuffer Class Referenceabstract

Base class for buffer encapsulation. More...

#include <BaseBuffer.h>

Inheritance diagram for ipsdk::BaseBuffer:
ipsdk::BaseObjectWithSkeleton ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject ipsdk::BaseBlockBuffer ipsdk::BaseFragBuffer ipsdk::BaseOwnBuffer ipsdk::ExternalBuffer ipsdk::HybridBuffer ipsdk::FragHybridBuffer ipsdk::TOwnBuffer< T > ipsdk::TypedOwnBuffer

Public Member Functions

virtual eBufferType getBufferType () const =0
 retrieve buffer type
 
bool isInit () const
 
ipUInt64 getSize () const
 retrieve buffer size More...
 
ipUInt32 getBufferBaseSize () const
 retrieve buffer base size More...
 
ipUInt64 getMemorySize () const
 retrieve buffer memory size (in octets) More...
 
const eDataTypegetDataType () const
 retrieve buffer data type More...
 
void clear ()
 delete buffer data
 
Constructors and destructors
 BaseBuffer ()
 
virtual ~BaseBuffer ()=0
 
- Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzModegetSerializationMode () const
 retrieve serialization flag for object More...
 
void setSerializationMode (const eSklSrzMode &sklSrzMode) const
 set serialization flag for object
 
 BaseObjectWithSkeleton ()
 
 ~BaseObjectWithSkeleton ()
 
- 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
 

Protected Member Functions

void initBase (const ipUInt64 size, const eDataType &dataType)
 initialization of base class More...
 
virtual void clearDerived ()
 clear method instanciation in derived class
 
- 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
 

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
 
- Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode _sklSrzMode
 serialization flag for object More...
 

Detailed Description

Base class for buffer encapsulation.

Author
E. Noirfalise
Date
2013/1/4

Member Function Documentation

◆ isInit()

bool ipsdk::BaseBuffer::isInit ( ) const
inline

retrieve object initialization flag

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getSize()

ipUInt64 ipsdk::BaseBuffer::getSize ( ) const

retrieve buffer size

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getBufferBaseSize()

ipUInt32 ipsdk::BaseBuffer::getBufferBaseSize ( ) const

retrieve buffer base size

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getMemorySize()

ipUInt64 ipsdk::BaseBuffer::getMemorySize ( ) const

retrieve buffer memory size (in octets)

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getDataType()

const eDataType& ipsdk::BaseBuffer::getDataType ( ) const

retrieve buffer data type

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ initBase()

void ipsdk::BaseBuffer::initBase ( const ipUInt64  size,
const eDataType dataType 
)
protected

initialization of base class

Exceptions
ipsdk::IPSDKBaseDataExceptionif dataType == eDataType::eDT_None

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