OpenDAFF C++ API  v1.7
Directional Audio File Format
Public Member Functions | List of all members
DAFFProperties Class Referenceabstract

Properties of a DAFF file that uses regular sphere grids (or parts of a regular grid) More...

#include <DAFFProperties.h>

Inheritance diagram for DAFFProperties:
DAFFPropertiesImpl DAFFReaderImpl

Public Member Functions

virtual ~DAFFProperties ()
 Destructor. More...
 
virtual int getFileFormatVersion () const =0
 Returns the DAFF version of the file format. More...
 
virtual int getContentType () const =0
 Returns the content type. More...
 
virtual int getQuantization () const =0
 Returns the quantization of the data elements. More...
 
virtual int getNumberOfChannels () const =0
 Returns the number of channels. More...
 
virtual int getNumberOfRecords () const =0
 Returns the overall number of records. More...
 
virtual std::string getChannelLabel (int iChannel) const =0
 Returns the label of a channel. More...
 
virtual int getAlphaPoints () const =0
 
virtual float getAlphaResolution () const =0
 
virtual float getAlphaStart () const =0
 
virtual float getAlphaEnd () const =0
 
virtual float getAlphaSpan () const =0
 
virtual int getBetaPoints () const =0
 
virtual float getBetaResolution () const =0
 
virtual float getBetaStart () const =0
 
virtual float getBetaEnd () const =0
 
virtual float getBetaSpan () const =0
 
virtual void getDefaultOrientation (DAFFOrientationYPR &o) const =0
 Returns the default orientation as stored in the file. More...
 
virtual void setDefaultOrientation ()=0
 Sets/alters the default orientation manually. More...
 
virtual void getOrientation (DAFFOrientationYPR &o) const =0
 Returns the current orientation of the object view. More...
 
virtual void setOrientation (const DAFFOrientationYPR &o)=0
 Sets the current orientation of the object view. More...
 
virtual bool coversFullAlphaRange () const =0
 Indicates whether the data covers the full alpha range [0°, 360°) More...
 
virtual bool coversFullBetaRange () const =0
 Indicates whether the data covers the full beta range [0°, 180°]. More...
 
virtual bool coversFullSphere () const =0
 Indicates whether the data covers the full sphere. More...
 

Detailed Description

Properties of a DAFF file that uses regular sphere grids (or parts of a regular grid)

Definition at line 18 of file DAFFProperties.h.

Constructor & Destructor Documentation

virtual DAFFProperties::~DAFFProperties ( )
inlinevirtual

Destructor.

Definition at line 22 of file DAFFProperties.h.

Member Function Documentation

virtual bool DAFFProperties::coversFullAlphaRange ( ) const
pure virtual

Indicates whether the data covers the full alpha range [0°, 360°)

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual bool DAFFProperties::coversFullBetaRange ( ) const
pure virtual

Indicates whether the data covers the full beta range [0°, 180°].

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual bool DAFFProperties::coversFullSphere ( ) const
pure virtual

Indicates whether the data covers the full sphere.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getAlphaEnd ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getAlphaPoints ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getAlphaResolution ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getAlphaSpan ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getAlphaStart ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getBetaEnd ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getBetaPoints ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getBetaResolution ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getBetaSpan ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual float DAFFProperties::getBetaStart ( ) const
pure virtual

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual std::string DAFFProperties::getChannelLabel ( int  iChannel) const
pure virtual

Returns the label of a channel.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getContentType ( ) const
pure virtual

Returns the content type.

Returns
Content type, one of

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual void DAFFProperties::getDefaultOrientation ( DAFFOrientationYPR o) const
pure virtual

Returns the default orientation as stored in the file.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getFileFormatVersion ( ) const
pure virtual

Returns the DAFF version of the file format.

Returns
File format version number (i.e. 170)

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getNumberOfChannels ( ) const
pure virtual

Returns the number of channels.

Returns
Number of chanels

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getNumberOfRecords ( ) const
pure virtual

Returns the overall number of records.

Returns
Total number of data records (multi channel data sets)

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual void DAFFProperties::getOrientation ( DAFFOrientationYPR o) const
pure virtual

Returns the current orientation of the object view.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual int DAFFProperties::getQuantization ( ) const
pure virtual

Returns the quantization of the data elements.

Returns
Sample quantization, one of

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual void DAFFProperties::setDefaultOrientation ( )
pure virtual

Sets/alters the default orientation manually.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.

virtual void DAFFProperties::setOrientation ( const DAFFOrientationYPR o)
pure virtual

Sets the current orientation of the object view.

Implemented in DAFFPropertiesImpl, and DAFFReaderImpl.


The documentation for this class was generated from the following file:
OpenDAFF is a project from the Institute of Technical Acoustics, RWTH Aachen University, Germany.