Descriptor class for the .bck BUCKET file format header. More...

#include <aims/io/bckheader.h>

Inheritance diagram for aims::BckHeader:

[legend]

Collaboration diagram for aims::BckHeader:

[legend]

Public Member Functions
	BckHeader (const std::string &name, const std::string &type="UNKNOWN", float sizex=1, float sizey=1, float sizez=1, float sizet=1, uint byteorder=AIMS_MAGIC_NUMBER, const std::string &openmode="binar")

virtual	~BckHeader ()

std::string	name () const

std::string	dataType () const

virtual int	dimX () const

virtual int	dimY () const

virtual int	dimZ () const

virtual int	dimT () const

virtual float	sizeX () const

virtual float	sizeY () const

virtual float	sizeZ () const

virtual float	sizeT () const

uint	byteOrder () const

std::string	openMode () const

std::string	filename () const

virtual std::string	extension () const
	standard file format extension of specialized headers More...

virtual std::set< std::string >	extensions () const
	possible filename extensions for specialized formats More...

void	read (uint32_t *offset=0)

void	write ()

Public Member Functions inherited from aims::PythonHeader
	PythonHeader ()

	PythonHeader (const internal::PythonHeaderType &)

	PythonHeader (const PythonHeader &)

	PythonHeader (carto::Headered &)
	initialization by reference More...

virtual	~PythonHeader ()

virtual PythonHeader &	operator= (const PythonHeader &)

virtual const char *	id () const

virtual bool	readMinf (const std::string &filename)
	read meta-info header More...

virtual bool	writeMinf (const std::string &filename)
	write meta-info header, non-const version (may change some attributes) More...

virtual bool	writeMinf (const std::string &filename) const
	write meta-info header More...

virtual Header *	cloneHeader (bool keepUuid=false) const

virtual void	copy (const PythonHeader &, bool keepUuid=false)

virtual void	copy (const carto::Object &, bool keepUuid=false)

virtual bool	isScalar () const

virtual bool	isString () const

virtual bool	isArray () const

virtual bool	isDynArray () const

virtual bool	isIterator () const

virtual bool	isDictionaryIterator () const

Public Member Functions inherited from carto::PointerObject< class >
	PointerObject (T &x, bool owner)

virtual	~PointerObject ()

virtual T &	getValue ()

virtual Object	clone () const

Public Member Functions inherited from carto::TypedObject< class >
	TypedObject ()

virtual	~TypedObject ()

const T &	getValue () const

virtual void	setValue (Object val)

virtual std::string	type () const

virtual double	getScalar () const

virtual void	setScalar (double)

virtual std::string	getString () const

virtual void	setString (const std::string &)

virtual bool	isContiguous () const

virtual bool	hasItem (int index) const

virtual Object	getArrayItem (int index) const

virtual void	setArrayItem (int, Object)

virtual size_t	size () const

virtual void	reserveArray (size_t)

virtual void	resizeArray (size_t)

virtual void	removeArrayItem (int)

virtual void	insertArrayItem (int, Object)

virtual bool	getProperty (const std::string &, Object &) const

virtual bool	isDictionary () const

virtual void	setProperty (const std::string &, Object)

virtual bool	removeProperty (const std::string &)

virtual bool	hasProperty (const std::string &) const

virtual void	clearProperties ()

virtual bool	isIterable () const

virtual Object	objectIterator () const

virtual bool	isValid () const

virtual Object	currentValue () const

virtual void	next ()

virtual bool	isKeyIterator () const

virtual Object	keyObject () const

virtual std::string	key () const

virtual bool	isIntKeyIterator () const

virtual long	intKey () const

virtual bool	isNone () const

virtual bool	operator== (const GenericObject &other) const

virtual bool	getProperty (const std::string &key, Object &value) const =0

Object	getProperty (const std::string &) const

Object	getProperty (Object key) const

bool	getProperty (const std::string &key, T &value) const

bool	getProperty (const std::string &key, Object &value) const

virtual void	setProperty (const std::string &key, Object value)=0

void	setProperty (const std::string &, const char *)

void	setProperty (const std::string &, const T &)

void	setProperty (const std::string &key, Object const &value)

Public Member Functions inherited from carto::GenericObject
virtual	~GenericObject ()

const T &	value () const

T &	value ()

bool	value (T &) const

void	setValue (const T &val)

T *	getInterface ()

const T *	getInterface () const

virtual bool	operator!= (const GenericObject &other) const

Public Member Functions inherited from carto::RCObject
	RCObject ()

	RCObject (const RCObject &)

RCObject &	operator= (const RCObject &)

virtual	~RCObject ()

Public Member Functions inherited from carto::StringInterface
virtual	~StringInterface ()

virtual bool	operator== (const StringInterface &other) const

virtual bool	operator!= (const StringInterface &other) const

Public Member Functions inherited from carto::Interface
virtual	~Interface ()

Public Member Functions inherited from carto::ScalarInterface
virtual	~ScalarInterface ()

virtual bool	operator== (const ScalarInterface &other) const

virtual bool	operator!= (const ScalarInterface &other) const

Public Member Functions inherited from carto::DynArrayInterface
virtual	~DynArrayInterface ()

Public Member Functions inherited from carto::ArrayInterface
virtual	~ArrayInterface ()

Public Member Functions inherited from carto::SizeInterface
virtual	~SizeInterface ()

Public Member Functions inherited from carto::IterableInterface
virtual	~IterableInterface ()

virtual bool	operator== (const IterableInterface &other) const

virtual bool	operator!= (const IterableInterface &other) const

Public Member Functions inherited from carto::DictionaryInterface
virtual	~DictionaryInterface ()

Object	getProperty (const std::string &) const

Object	getProperty (Object key) const

bool	getProperty (const std::string &key, T &value) const

void	setProperty (const std::string &, const char *)

void	setProperty (const std::string &, const T &)

virtual void	copyProperties (Object source)

virtual bool	operator== (const DictionaryInterface &other) const

virtual bool	operator!= (const DictionaryInterface &other) const

void	setProperty (const std::string &key, Object const &value)

bool	getProperty (const std::string &key, Object &value) const

Public Member Functions inherited from carto::IteratorInterface
virtual	~IteratorInterface ()

Public Member Functions inherited from carto::KeyIteratorInterface
virtual	~KeyIteratorInterface ()

Public Member Functions inherited from carto::DictionaryIteratorInterface
virtual	~DictionaryIteratorInterface ()

Public Member Functions inherited from carto::IntKeyIteratorInterface
virtual	~IntKeyIteratorInterface ()

Public Member Functions inherited from carto::NoneInterface
virtual	~NoneInterface ()

Public Member Functions inherited from aims::Header
virtual	~Header ()=0

virtual std::string	extension (const std::string &filename) const
	extension of given filename (including '.') More...

virtual std::string	removeExtension (const std::string &) const

Additional Inherited Members
Public Types inherited from carto::RCObject
typedef int	RefCounterType

Static Public Member Functions inherited from aims::PythonHeader
static carto::SyntaxSet *	syntax ()

static bool	writeMinf (const carto::Object &header, const std::string &filename)

static bool	writeMinf (carto::Object &header, const std::string &filename)

static void	copy (const carto::Object &src, carto::Object &dst, bool keepUuid=false)

static carto::Object	cloneHeader (const carto::Object &src, bool keepUuid=false)

Protected Member Functions inherited from carto::GenericObject
virtual Interface *	_getGenericInterface ()=0

virtual const void *	_getAddressOfValue () const=0

Detailed Description

Descriptor class for the .bck BUCKET file format header.

Definition at line 51 of file bckheader.h.

Constructor & Destructor Documentation

◆ BckHeader()

aims::BckHeader::BckHeader	(	const std::string &	name,
		const std::string &	type = `"UNKNOWN"`,
		float	sizex = `1`,
		float	sizey = `1`,
		float	sizez = `1`,
		float	sizet = `1`,
		uint	byteorder = `AIMS_MAGIC_NUMBER`,
		const std::string &	openmode = `"binar"`
	)

◆ ~BckHeader()

virtual aims::BckHeader::~BckHeader ( )

inlinevirtual

Definition at line 58 of file bckheader.h.

Member Function Documentation

◆ byteOrder()

uint aims::BckHeader::byteOrder ( ) const

inline

Definition at line 72 of file bckheader.h.

Referenced by aims::BckReader< T >::read(), and aims::BckMapReader< T >::read().

◆ dataType()

std::string aims::BckHeader::dataType ( ) const

inline

Definition at line 61 of file bckheader.h.

◆ dimT()

virtual int aims::BckHeader::dimT ( ) const

inlinevirtual

Definition at line 66 of file bckheader.h.

Referenced by aims::BckReader< T >::read(), and aims::BckMapReader< T >::read().

◆ dimX()

virtual int aims::BckHeader::dimX ( ) const

inlinevirtual

Definition at line 63 of file bckheader.h.

◆ dimY()

virtual int aims::BckHeader::dimY ( ) const

inlinevirtual

Definition at line 64 of file bckheader.h.

◆ dimZ()

virtual int aims::BckHeader::dimZ ( ) const

inlinevirtual

Definition at line 65 of file bckheader.h.

◆ extension()

virtual std::string aims::BckHeader::extension ( ) const

inlinevirtual

standard file format extension of specialized headers

Reimplemented from aims::Header.

Definition at line 76 of file bckheader.h.

◆ extensions()

virtual std::set<std::string> aims::BckHeader::extensions ( ) const

virtual

possible filename extensions for specialized formats

Reimplemented from aims::Header.

◆ filename()

std::string aims::BckHeader::filename ( ) const

Referenced by aims::BckReader< T >::read(), aims::BckMapReader< T >::read(), aims::BckWriter< T >::write(), and aims::BckMapWriter< T >::write().

◆ name()

std::string aims::BckHeader::name ( ) const

inline

Definition at line 60 of file bckheader.h.

◆ openMode()

std::string aims::BckHeader::openMode ( ) const

inline

Definition at line 73 of file bckheader.h.

Referenced by aims::BckReader< T >::read(), and aims::BckMapReader< T >::read().

◆ read()

void aims::BckHeader::read ( uint32_t * offset = 0 )

Referenced by aims::BckReader< T >::read(), and aims::BckMapReader< T >::read().

◆ sizeT()

virtual float aims::BckHeader::sizeT ( ) const

virtual

◆ sizeX()

virtual float aims::BckHeader::sizeX ( ) const

virtual

◆ sizeY()

virtual float aims::BckHeader::sizeY ( ) const

virtual

◆ sizeZ()

virtual float aims::BckHeader::sizeZ ( ) const

virtual

◆ write()

void aims::BckHeader::write ( )

Referenced by aims::BckWriter< T >::write(), and aims::BckMapWriter< T >::write().

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

aims/io/bckheader.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BckHeader()

◆ ~BckHeader()

Member Function Documentation

◆ byteOrder()

◆ dataType()

◆ dimT()

◆ dimX()

◆ dimY()

◆ dimZ()

◆ extension()

◆ extensions()

◆ filename()

◆ name()

◆ openMode()

◆ read()

◆ sizeT()

◆ sizeX()

◆ sizeY()

◆ sizeZ()

◆ write()