Base class for fragmented buffers. More...

#include <BaseFragBuffer.h>

Inheritance diagram for ipsdk::BaseFragBuffer:

Public Member Functions
ipUInt64	getNbFragments () const
	retrieve number of fragments for buffer More...

ipUInt64	getFragmentsSize () const
	retrieve fragments size More...

const BufferPtrColl &	getBufferPtrColl () const
	retrieve fragment pointers collection for buffer More...

void	rollUpFragments ()
	method allowing to roll up all fragments into buffer. Fragments indexes are modified as follow : More...

void	rollDownFragments ()
	method allowing to roll down all fragments into buffer. Fragments indexes are modified as follow : More...

Constructors and destructors
	BaseFragBuffer ()

virtual	~BaseFragBuffer ()=0


const void *	getDataPtr (const ipUInt64 fragmentIndex) const
	retrieve buffer data for a given fragment index More...

void *	getDataPtr (const ipUInt64 fragmentIndex)
	retrieve buffer data for a given fragment index More...


const void *	getDataPtr (const ipUInt64 fragmentIndex, const ipUInt64 offset) const
	retrieve buffer data for a given fragment index and a given offset More...

void *	getDataPtr (const ipUInt64 fragmentIndex, const ipUInt64 offset)
	retrieve buffer data for a given fragment index and 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 eDataType &	getDataType () const
	retrieve buffer data type More...

void	clear ()
	delete buffer data

	BaseBuffer ()

virtual	~BaseBuffer ()=0

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () 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 BaseDynamicObject *	createNew () 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 BaseDynamicObject *	duplicate () 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 eDataType &dataType, const BufferPtrColl &bufferPtrColl, const ipUInt64 fragmentsSize)
	initialization of base class More...

void	setDataPtr (const ipUInt64 fragmentIndex, void *pData)
	method allowing to set a given data pointer for buffer More...

virtual void	clearDerived ()
	clear method instanciation in derived class

Protected Member Functions inherited from ipsdk::BaseBuffer
void	initBase (const ipUInt64 size, const eDataType &dataType)
	initialization of base class 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

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 fragmented buffers.

Author: E. Noirfalise

Date: 2013/8/29

Copyright: 2013 Reactiv'IP, all right reserved.

All fragments are supposed to have same size

Member Function Documentation

◆ getNbFragments()

ipUInt64 ipsdk::BaseFragBuffer::getNbFragments ( ) const

retrieve number of fragments for buffer

Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ getFragmentsSize()

ipUInt64 ipsdk::BaseFragBuffer::getFragmentsSize ( ) const

retrieve fragments size

Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ getBufferPtrColl()

const BufferPtrColl& ipsdk::BaseFragBuffer::getBufferPtrColl ( ) const

retrieve fragment pointers collection for buffer

Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ getDataPtr() [1/4]

const void* ipsdk::BaseFragBuffer::getDataPtr ( const ipUInt64 fragmentIndex ) const

retrieve buffer data for a given fragment index

Exceptions

ipsdk::IPSDKBaseDataException if fragmentIndex >= getNbFragments()

◆ getDataPtr() [2/4]

void* ipsdk::BaseFragBuffer::getDataPtr ( const ipUInt64 fragmentIndex )

retrieve buffer data for a given fragment index

Exceptions

ipsdk::IPSDKBaseDataException if fragmentIndex >= getNbFragments()

◆ getDataPtr() [3/4]

const void* ipsdk::BaseFragBuffer::getDataPtr	(	const ipUInt64	fragmentIndex,
		const ipUInt64	offset
	)		const

retrieve buffer data for a given fragment index and a given offset

Warning: there is no check on buffer overrun

Exceptions

ipsdk::IPSDKBaseDataException if fragmentIndex >= getNbFragments()

◆ getDataPtr() [4/4]

void* ipsdk::BaseFragBuffer::getDataPtr	(	const ipUInt64	fragmentIndex,
		const ipUInt64	offset
	)

retrieve buffer data for a given fragment index and a given offset

Warning: there is no check on buffer overrun

Exceptions

ipsdk::IPSDKBaseDataException if fragmentIndex >= getNbFragments()

◆ rollUpFragments()

void ipsdk::BaseFragBuffer::rollUpFragments ( )

method allowing to roll up all fragments into buffer. Fragments indexes are modified as follow :

Fragment with index 0 before call is set to index getNbFragments()-1 after call
Fragment with index i before call is set to index i-1 after call
Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ rollDownFragments()

void ipsdk::BaseFragBuffer::rollDownFragments ( )

method allowing to roll down all fragments into buffer. Fragments indexes are modified as follow :

Fragment with index i before call is set to index i+1 after call
Fragment with index getNbFragments()-1 before call is set to index 0 after call
Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ initBase()

void ipsdk::BaseFragBuffer::initBase	(	const eDataType &	dataType,
		const BufferPtrColl &	bufferPtrColl,
		const ipUInt64	fragmentsSize
	)

protected

initialization of base class

Exceptions

ipsdk::IPSDKBaseDataException if dataType == eDataType::eDT_None

◆ setDataPtr()

void ipsdk::BaseFragBuffer::setDataPtr	(	const ipUInt64	fragmentIndex,
		void *	pData
	)

protected

method allowing to set a given data pointer for buffer

Exceptions

ipsdk::IPSDKBaseDataException if fragmentIndex >= getNbFragments()

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/Buffer/BaseFragBuffer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getNbFragments()

◆ getFragmentsSize()

◆ getBufferPtrColl()

◆ getDataPtr() [1/4]

◆ getDataPtr() [2/4]

◆ getDataPtr() [3/4]

◆ getDataPtr() [4/4]

◆ rollUpFragments()

◆ rollDownFragments()

◆ initBase()

◆ setDataPtr()