Jamoma API  0.6.0.a19
TTNodeInfo.h
Go to the documentation of this file.
1 /** @file
2  *
3  * @ingroup modularLibrary
4  *
5  * @brief TTNodeInfo provides priority, tag and description for a node.
6  *
7  * @details ...
8  *
9  * @authors Théo de la Hogue
10  *
11  * @copyright © 2014, Théo de la Hogue @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 __TT_NODEINFO_H__
18 #define __TT_NODEINFO_H__
19 
20 #include "TTModular.h"
21 
22 /** TTNodeInfo provides priority, tag and description for a node.
23  @details ...
24  */
25 class TTMODULAR_EXPORT TTNodeInfo : public TTObjectBase
26 {
28 
29 private:
30 
31  TTSymbol mDescription; ///< ATTRIBUTE: text to describe the role of this node
32  TTInt32 mPriority; ///< ATTRIBUTE: does this node have a priority over other nodes ?
33  TTValue mTags; ///< ATTRIBUTE: tag list for this node
34 
35  /** Setter for mDescription attribute
36  @param value new description value */
37  TTErr setDescription(const TTValue& value);
38 
39  /** Setter for mPriority attribute
40  @param value new priority value */
41  TTErr setPriority(const TTValue& value);
42 
43  /** Setter for mTags attribute
44  @param value new tag value */
45  TTErr setTags(const TTValue& value);
46 
47  /** Notify observers of an attribute
48  @param attrName the name of the attribute to notify
49  @param value the value to send to observers */
50  TTErr notifyObservers(TTSymbol attrName, const TTValue& value);
51 };
52 typedef TTNodeInfo* TTNodeInfoPtr;
53 
54 
55 #endif // __TT_NODEINFO_H__
TTNodeInfo provides priority, tag and description for a node.
Definition: TTNodeInfo.h:25
Base class for all first-class Jamoma objects.
Definition: TTObjectBase.h:109
#define TTCLASS_SETUP(className)
TODO Doxygen: need more comments here.
Definition: TTFoundation.h:54
The TTSymbol class is used to represent a string and efficiently pass and compare that string...
Definition: TTSymbol.h:26
std::int32_t TTInt32
32 bit signed integer
Definition: TTBase.h:177
TTErr
Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions a...
Definition: TTBase.h:342
the Modular Application Programming Interface
[doxygenAppendixC_copyExample]
Definition: TTValue.h:34