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

Base class for mono block buffers. More...

#include <BaseBlockBuffer.h>

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

Public Member Functions

Constructors and destructors
 BaseBlockBuffer ()
 
virtual ~BaseBlockBuffer ()=0
 
const void * getDataPtr () const
 retrieve buffer data More...
 
void * getDataPtr ()
 retrieve buffer data More...
 
const void * getDataPtr (const ipUInt64 offset) const
 retrieve buffer data associated to a given offset More...
 
void * getDataPtr (const ipUInt64 offset)
 retrieve buffer data associated to a given offset More...
 
- Public Member Functions inherited from ipsdk::BaseBuffer
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
 
 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, void *pData)
 initialization of base class More...
 
- Protected Member Functions inherited from ipsdk::BaseBuffer
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 mono block buffers.

Author
E. Noirfalise
Date
2013/8/29

Member Function Documentation

◆ getDataPtr() [1/4]

const void* ipsdk::BaseBlockBuffer::getDataPtr ( ) const

retrieve buffer data

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getDataPtr() [2/4]

void* ipsdk::BaseBlockBuffer::getDataPtr ( )

retrieve buffer data

Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getDataPtr() [3/4]

const void* ipsdk::BaseBlockBuffer::getDataPtr ( const ipUInt64  offset) const

retrieve buffer data associated to a given offset

Warning
there is no check on buffer overrun
Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ getDataPtr() [4/4]

void* ipsdk::BaseBlockBuffer::getDataPtr ( const ipUInt64  offset)

retrieve buffer data associated to a given offset

Warning
there is no check on buffer overrun
Exceptions
ipsdk::IPSDKBaseDataExceptionif isInit() == false

◆ initBase()

void ipsdk::BaseBlockBuffer::initBase ( const ipUInt64  size,
const eDataType dataType,
void *  pData 
)
protected

initialization of base class

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

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