Jamoma API  0.6.0.a19
Public Member Functions | Public Attributes | List of all members
TTDataspaceUnit Class Referenceabstract

Specification for the base class of each DataspaceUnit. More...

#include <TTDataspaceUnit.h>

+ Inheritance diagram for TTDataspaceUnit:
+ Collaboration diagram for TTDataspaceUnit:

Public Member Functions

 TTDataspaceUnit (TTValue arguments)
 Constructor. More...
 
virtual ~TTDataspaceUnit ()
 Destructor.
 
virtual void convertToNeutral (const TTValue &input, TTValue &output)=0
 Converts from an actual unit to a 'neutral' unit that can be interpreted by other units within this dataspace. More...
 
virtual void convertFromNeutral (const TTValue &input, TTValue &output)=0
 Converts from a neutral unit back to an actual unit. More...
 

Public Attributes

TTSymbol name
 Name of this unit.
 

Detailed Description

Specification for the base class of each DataspaceUnit.

A DataspaceUnit converts back and forth between a specific unit and a neutral unit, and is used by DataspaceLib to do a conversion.

Definition at line 27 of file TTDataspaceUnit.h.

Constructor & Destructor Documentation

TTDataspaceUnit::TTDataspaceUnit ( TTValue  arguments)

Constructor.

Must be passed the name of this DataspaceUnit as a TTSymbolPtr.

Parameters
argumentsArguments passed to the class when created.

Definition at line 20 of file TTDataspaceUnit.cpp.

References name.

Member Function Documentation

virtual void TTDataspaceUnit::convertFromNeutral ( const TTValue &  input,
TTValue &  output 
)
pure virtual

Converts from a neutral unit back to an actual unit.

This must be defined by a sub-class.

Parameters
inputInput value described using the neutral unit.
outputReturned value, converted to the unit of this class.

Implemented in SpeedUnit, SecondUnit, SampleUnit, MillisecondUnit, MidiPitchUnit, CylindricalUnit, RGB8Unit, MelUnit, OpenGlUnit, MeterPerSecondUnit, RGBUnit, MeterUnit, FrequencyUnit, PolarUnit, KnotUnit, HSVUnit, DecibelUnit, AxisUnit, CentUnit, FootUnit, SphericalUnit, FootPerSecondUnit, KelvinUnit, HSLUnit, DegreeUnit, MidiGainUnit, EulerUnit, BpmUnit, InchUnit, Cartesian2DUnit, KilometerPerHourUnit, FahrenheitUnit, CMYUnit, RadianUnit, QuaternionUnit, BarkUnit, CentimeterUnit, LinearAmplitudeUnit, Cartesian3DUnit, MilesPerHourUnit, CelsiusUnit, and NoneUnit.

Referenced by TTDataspace::convert().

virtual void TTDataspaceUnit::convertToNeutral ( const TTValue &  input,
TTValue &  output 
)
pure virtual

Converts from an actual unit to a 'neutral' unit that can be interpreted by other units within this dataspace.

This must be defined by a sub-class.

Parameters
inputInput value to be converted .
outputReturned value, converted to the neutral unit of the dataspace.

Implemented in SpeedUnit, SecondUnit, SampleUnit, MillisecondUnit, MidiPitchUnit, CylindricalUnit, RGB8Unit, MelUnit, OpenGlUnit, MeterPerSecondUnit, RGBUnit, MeterUnit, FrequencyUnit, PolarUnit, KnotUnit, HSVUnit, DecibelUnit, AxisUnit, CentUnit, FootUnit, SphericalUnit, FootPerSecondUnit, KelvinUnit, HSLUnit, DegreeUnit, MidiGainUnit, EulerUnit, BpmUnit, InchUnit, Cartesian2DUnit, KilometerPerHourUnit, FahrenheitUnit, CMYUnit, RadianUnit, QuaternionUnit, BarkUnit, CentimeterUnit, LinearAmplitudeUnit, Cartesian3DUnit, MilesPerHourUnit, CelsiusUnit, and NoneUnit.

Referenced by TTDataspace::convert().

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