fwAtoms::Blob Class Reference

Representation of a buffer. More...

#include <Blob.hpp>

Inheritance diagram for fwAtoms::Blob:

Collaboration diagram for fwAtoms::Blob:

Public Member Functions
virtual bool	isA (const std::string &type) const override
	Blob (::fwAtoms::Base::Key key)
	Constructor. More...
virtual	~Blob ()
	Destructor.
virtual FWATOMS_API Base::sptr	clone () const override
	Returns a clone object.
::fwAtoms::Base::AtomType	type () const override
	returns Atom type
FWATOMS_API::fwMemory::BufferObject::sptr	getBufferObject () const
	buffer accessor. More...
FWATOMS_API void	setBufferObject (const ::fwMemory::BufferObject::sptr &bo)
	buffer accessor. More...
Public Member Functions inherited from fwAtoms::Base
bool	isValue () const
	Test if the current base is a value or not (Value = {string;numeric;boolean}) More...
bool	isBoolean () const
	Test if the current base is a boolean. More...
bool	isNumeric () const
	Test if the current base is a Numeric (real or integer) More...
bool	isString () const
	Test if the current base is a string. More...
bool	isSequence () const
	Test if the current base is a sequence. More...
bool	isMapping () const
	Test if the current base is a mapping. More...
bool	isBlob () const
	Test if the current base is a blob (a object with a buffer) More...
bool	isObject () const
	Test if the current base is an object (representation of fwData) More...
virtual FWATOMS_API std::string	getString () const
	Return the string representation of a value. More...
Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)
static FWATOMS_API Blob::sptr	New (::fwMemory::BufferObject::sptr buffer)
	create a new Blob shared ptr. More...
static FWATOMS_API Blob::sptr	New (void *buffer, unsigned int size)
	create a new Blob shared ptr. More...
Static Public Member Functions inherited from fwAtoms::Base
static bool	isTypeOf (const std::string &type)
static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject
Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Attributes
::fwMemory::BufferObject::sptr	m_bufferObject

Friends
template<class , class , class >
class	::fwTools::ClassFactory
class	::fwTools::Factory

Demangling methods
virtual const std::string &	getLeafClassname () const override
	return object's classname without its namespace, i.e. BaseObject
virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Additional Inherited Members
Public Types inherited from fwAtoms::Base
enum	AtomType {   BOOLEAN = 1, NUMERIC, STRING, OBJECT,   SEQUENCE, MAP, BLOB }
typedef ::fwAtoms::factory::Key	Key
Static Public Attributes inherited from fwAtoms::Base
static FWATOMS_API const std::string	s_VERSION = "1"
	Defines fwAtoms version.
Protected Member Functions inherited from fwAtoms::Base
	Base ()
	Constructor.

Detailed Description

Representation of a buffer.

A blob wraps a buffer

Definition at line 23 of file Blob.hpp.

Constructor & Destructor Documentation

fwAtoms::Blob::Blob ( ::fwAtoms::Base::Key  key )

inline

Constructor.

Parameters

key	Private construction key

Definition at line 32 of file Blob.hpp.

Member Function Documentation

fwMemory::BufferObject::sptr fwAtoms::Blob::getBufferObject

(

)

const

buffer accessor.

Returns

the a pointer to the first buffer element.

Definition at line 37 of file Blob.cpp.

Blob::sptr fwAtoms::Blob::New ( ::fwMemory::BufferObject::sptr  buffer )

static

create a new Blob shared ptr.

Parameters

buffer

the buffer object

Definition at line 17 of file Blob.cpp.

Referenced by clone(), fwStructuralPatch::creator::fwMedData::ImageSeries1::create(), New(), and fwAtomsPatch::patcher::DefaultPatcher::processBase().

Here is the caller graph for this function:

Blob::sptr fwAtoms::Blob::New ( void *  buffer, unsigned int  size  )

static

create a new Blob shared ptr.

Parameters

buffer	the buffer
size	the buffer size

Definition at line 27 of file Blob.cpp.

References New().

Here is the call graph for this function:

void fwAtoms::Blob::setBufferObject

(

const ::fwMemory::BufferObject::sptr &

bo

)

buffer accessor.

Returns

the a pointer to the first buffer element.

Definition at line 44 of file Blob.cpp.

---

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

• Blob.hpp
• Blob.cpp