Jamoma API  0.6.0.a19
NoneDataspace.h
Go to the documentation of this file.
1 /** @file
2  *
3  * @ingroup foundationDataspaceLib
4  *
5  * @brief The #NoneDataspace is a dataspace unit for situations where no dataspace conversions are desired or relevant. It contains only one unit, the #NoneUnit, and that unit does not perform any conversions.
6  *
7  * @details The neutral unit of the angle dataspace is none.
8  *
9  * @authors Tim Place, Nils Peters, Trond Lossius, ...
10  *
11  * @copyright Copyright © 2007 by Nils Peters @n
12  * This code is licensed under the terms of the "New BSD License" @n
13  * http://creativecommons.org/licenses/BSD/
14  */
15 
16 
17 #ifndef __NONE_DATASPACE_H__
18 #define __NONE_DATASPACE_H__
19 
20 #include "TTDataspace.h"
21 
22 
23 /** Base class for the none dataspace, used when support for dataspace convertions are not desired or relevant.
24  */
25 class NoneDataspace : public TTDataObjectBase, public TTDataspace {
27 };
28 
29 
30 /** This, the only unit of the #NoneDataspace performs no conversions, leaving values untouched.
31  *
32  * @details This unit is denoted as "none".
33  */
34 class NoneUnit : public TTDataObjectBase, public TTDataspaceUnit {
36 
37 public:
38 
39  /** Convertion from none to neutral unit leaves the value untouched.
40  @param input Input value described using no dataspace unit.
41  @param output Returned (untouched) value.
42  */
43  void convertToNeutral(const TTValue& input, TTValue& output);
44 
45  /** Convertion from neutral unit to the "none" unit leaves the value untouched.
46  @param input Input value.
47  @param output Returned (untouched) value.
48  */
49  void convertFromNeutral(const TTValue& input, TTValue& output);
50 };
51 
52 
53 #endif // __NONE_DATASPACE_H__
void convertToNeutral(const TTValue &input, TTValue &output)
Convertion from none to neutral unit leaves the value untouched.
This, the only unit of the NoneDataspace performs no conversions, leaving values untouched.
Definition: NoneDataspace.h:34
TTDataObjectBase is the base class for all data generating and processing objects.
#define TTCLASS_SETUP(className)
TODO Doxygen: need more comments here.
Definition: TTFoundation.h:54
Specification for the base class of each DataspaceUnit.
Base class for the none dataspace, used when support for dataspace convertions are not desired or rel...
Definition: NoneDataspace.h:25
void convertFromNeutral(const TTValue &input, TTValue &output)
Convertion from neutral unit to the "none" unit leaves the value untouched.
Specification for TTDataspace, the base class of each dataspace.
Base class for each dataspace.
Definition: TTDataspace.h:30
[doxygenAppendixC_copyExample]
Definition: TTValue.h:34