aimsdata  5.1.2
Neuroimaging data handling
aims::PlyHeader Class Reference

#include <aims/io/plyheader.h>

Inheritance diagram for aims::PlyHeader:
Collaboration diagram for aims::PlyHeader:

Public Member Functions

 PlyHeader (const std::string &filename)
 
virtual ~PlyHeader ()
 
virtual bool read (uint32_t *offset=0)
 Reads the header, and if offset is not null, sets the file offset to the data field. More...
 
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...
 
- 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 PythonHeaderoperator= (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 HeadercloneHeader (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 &)
 
RCObjectoperator= (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::SyntaxSetsyntax ()
 
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

Definition at line 42 of file plyheader.h.

Constructor & Destructor Documentation

◆ PlyHeader()

aims::PlyHeader::PlyHeader ( const std::string &  filename)

◆ ~PlyHeader()

virtual aims::PlyHeader::~PlyHeader ( )
virtual

Member Function Documentation

◆ extension()

virtual std::string aims::PlyHeader::extension ( ) const
inlinevirtual

standard file format extension of specialized headers

Reimplemented from aims::Header.

Definition at line 52 of file plyheader.h.

Referenced by aims::PlyWriter< D, T >::write().

◆ extensions()

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

possible filename extensions for specialized formats

Reimplemented from aims::Header.

◆ filename()

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

◆ read()

virtual bool aims::PlyHeader::read ( uint32_t *  offset = 0)
virtual

Reads the header, and if offset is not null, sets the file offset to the data field.

Referenced by aims::PlyReader< D, T >::read().


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