HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PRM_ParmMicroNode.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: PRM_ParmMicroNode.h (PRM Library, C++)
7  *
8  * COMMENTS: DEP_MicroNode subclass representing a PRM_Parm component
9  */
10 
11 #ifndef __PRM_PARMMICRONODE_H_INCLUDED__
12 #define __PRM_PARMMICRONODE_H_INCLUDED__
13 
14 #include "PRM_API.h"
15 #include <DEP/DEP_MicroNode.h>
16 #include <UT/UT_ValArray.h>
17 #include <SYS/SYS_Types.h>
18 #include <stddef.h>
19 
20 class PRM_Parm;
22 
23 
25 
26 
28 {
29 public:
31  : myParm(NULL)
32  , mySubIndex(-1)
33  {
34  }
35 
36  PRM_ParmMicroNode(PRM_Parm &parm, int sub_index)
37  {
38  init(parm, sub_index);
39  }
40 
41  void init(PRM_Parm &parm, int sub_index);
42 
43  virtual void clearInputs();
44 
45  virtual const char * className() const
46  { return "PRM_ParmMicroNode"; }
47 
48  virtual int64 getMemoryUsage(bool inclusive) const;
49 
50  virtual void dump(
51  std::ostream &os,
52  const char *prefix = 0,
53  int indent_level = 0) const;
54 
55  const PRM_Parm & ownerParm() const
56  { return *myParm; }
58  { return *myParm; }
59 
60  int parmIndex() const;
61  int subIndex() const
62  { return mySubIndex; }
63 
64 private:
65 
66  PRM_Parm * myParm;
67  int mySubIndex;
68 };
69 
70 #endif // __PRM_PARMMICRONODE_H_INCLUDED__
virtual int64 getMemoryUsage(bool inclusive) const
Obtain approximate memory usage.
PRM_ParmMicroNode(PRM_Parm &parm, int sub_index)
virtual const char * className() const
virtual void clearInputs()
Definition: DEP_MicroNode.h:71
long long int64
Definition: SYS_Types.h:107
PRM_Parm & ownerParm()
int subIndex() const
UT_ValArray< PRM_ParmMicroNode * > PRM_ParmMicroNodeList
const PRM_Parm & ownerParm() const
virtual void dump(std::ostream &os, const char *prefix=0, int indent_level=0) const
Dump contents to output stream, strictly for debugging purposes.
#define PRM_API
Definition: PRM_API.h:10