bio::DpyHeader Class Reference

The descriptor class of the header. More...

#include <brainrat/io/dpyheader.h>

Inheritance diagram for bio::DpyHeader:

Collaboration diagram for bio::DpyHeader:

Public Member Functions
	DpyHeader (const string &name="", const string &type="PYTHON", int x=1, int y=1, int z=1, int t=1, float sx=1, float sy=1, float sz=1, float st=1)
virtual	~DpyHeader ()
int	dimX () const
int	dimY () const
int	dimZ () const
int	dimT () const
float	sizeX () const
float	sizeY () const
float	sizeZ () const
float	sizeT () const
string	dataType () const
	Get type of items ("Dictionary") More...
void	setType (const string &t)
string	name ()
	Get the file name of the header. More...
void	setName (string name)
vector< string >	possibleDataTypes () const
virtual string	extension () const
virtual set< string >	extensions () const
void	read ()

Detailed Description

The descriptor class of the header.

The programmer can either read an existing header, or write a new one.

Definition at line 27 of file dpyheader.h.

Constructor & Destructor Documentation

DpyHeader()

bio::DpyHeader::DpyHeader ( const string &  name = "", const string &  type = "PYTHON", int  x = 1, int  y = 1, int  z = 1, int  t = 1, float  sx = 1, float  sy = 1, float  sz = 1, float  st = 1  )

inline

Definition at line 30 of file dpyheader.h.

~DpyHeader()

virtual bio::DpyHeader::~DpyHeader ( )

inlinevirtual

Definition at line 37 of file dpyheader.h.

Member Function Documentation

dataType()

string bio::DpyHeader::dataType ( ) const

inline

Get type of items ("Dictionary")

Definition at line 50 of file dpyheader.h.

dimT()

int bio::DpyHeader::dimT ( ) const

inline

Definition at line 42 of file dpyheader.h.

dimX()

int bio::DpyHeader::dimX ( ) const

inline

Definition at line 39 of file dpyheader.h.

dimY()

int bio::DpyHeader::dimY ( ) const

inline

Definition at line 40 of file dpyheader.h.

dimZ()

int bio::DpyHeader::dimZ ( ) const

inline

Definition at line 41 of file dpyheader.h.

extension()

virtual string bio::DpyHeader::extension ( ) const

inlinevirtual

Definition at line 57 of file dpyheader.h.

Referenced by bio::DpyWriter::write().

extensions()

virtual set<string> bio::DpyHeader::extensions ( ) const

virtual

name()

string bio::DpyHeader::name ( void  )

inline

Get the file name of the header.

Definition at line 53 of file dpyheader.h.

possibleDataTypes()

vector<string> bio::DpyHeader::possibleDataTypes

(

)

const

read()

void bio::DpyHeader::read

(

)

Referenced by bio::DpyReader::read().

setName()

void bio::DpyHeader::setName ( string  name )

inline

Definition at line 54 of file dpyheader.h.

Referenced by bio::DpyWriter::write().

setType()

void bio::DpyHeader::setType

(

const string &

t

)

sizeT()

float bio::DpyHeader::sizeT ( ) const

inline

Definition at line 47 of file dpyheader.h.

sizeX()

float bio::DpyHeader::sizeX ( ) const

inline

Definition at line 44 of file dpyheader.h.

sizeY()

float bio::DpyHeader::sizeY ( ) const

inline

Definition at line 45 of file dpyheader.h.

sizeZ()

float bio::DpyHeader::sizeZ ( ) const

inline

Definition at line 46 of file dpyheader.h.

---

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

• brainrat/io/dpyheader.h