CPPGPGPU Library - Reference (Doxygen)

Main Page | General Use | Reference | Examples Info | Get/Download CPPGPGPU | SF.net Page

Node Class Reference

Basic node, these are like smart pointers to NodeObjects. More...

#include <Node.h>

List of all members.

Public Member Functions

 Node ()
 Node (NodeObject *nToInit)
 Node (const Node &nToCopy)
 ~Node ()
Nodeoperator= (const Node &rhs)
Nodeoperator= (NodeObject *rhs)
bool IsNull ()
 Returns true if this Node hasn't been assigned yet.
 operator NodeObject * ()
NodeObjectoperator * ()
NodeObjectGet ()
const NodeObjectGet () const
NodeObjectoperator-> ()
const NodeObjectoperator-> () const
bool operator== (const Node &rhs) const
 Perform a pointer-based comparison on the held NodeObjects to see if they're equal.
bool operator< (const Node &rhs) const
 Perform a pointer-based comparison.

Private Member Functions

void Hook (NodeObject *n)
 Hook self to a nodeobject.
void Unhook (NodeObject *n)
 Unhook self from a nodeobject. If no more are hooked, NodeObject will be deleted.

Private Attributes

NodeObjectThis
 Pointer to the actual NodeObject.


Detailed Description

Basic node, these are like smart pointers to NodeObjects.

You can use these to reference NodeObjects. These can be copied to make safe, shallow copies of NodeObjects. Once the last one of these references to any one NodeObject is destroyed, the NodeObject itself is destroyed.

Definition at line 27 of file Node.h.


Constructor & Destructor Documentation

Node::Node (  ) 

NODE HOLDER

Definition at line 13 of file Node.cpp.

Node::Node ( NodeObject nToInit  ) 

Definition at line 18 of file Node.cpp.

Node::Node ( const Node nToCopy  ) 

Definition at line 24 of file Node.cpp.

Node::~Node (  ) 

Definition at line 30 of file Node.cpp.


Member Function Documentation

Node & Node::operator= ( const Node rhs  ) 

Definition at line 35 of file Node.cpp.

Node & Node::operator= ( NodeObject rhs  ) 

Definition at line 43 of file Node.cpp.

bool Node::IsNull (  )  [inline]

Returns true if this Node hasn't been assigned yet.

Definition at line 39 of file Node.h.

Node::operator NodeObject * (  )  [inline]

Definition at line 40 of file Node.h.

NodeObject& Node::operator * (  )  [inline]

Definition at line 41 of file Node.h.

NodeObject* Node::Get (  )  [inline]

Definition at line 42 of file Node.h.

const NodeObject* Node::Get (  )  const [inline]

Definition at line 43 of file Node.h.

NodeObject* Node::operator-> (  )  [inline]

Definition at line 44 of file Node.h.

const NodeObject* Node::operator-> (  )  const [inline]

Definition at line 45 of file Node.h.

bool Node::operator== ( const Node rhs  )  const [inline]

Perform a pointer-based comparison on the held NodeObjects to see if they're equal.

Definition at line 48 of file Node.h.

bool Node::operator< ( const Node rhs  )  const [inline]

Perform a pointer-based comparison.

This should only be used on things like maps where you don't actually care which one is before or after another as long as they stay that way.

Definition at line 53 of file Node.h.

void Node::Hook ( NodeObject n  )  [private]

Hook self to a nodeobject.

Definition at line 51 of file Node.cpp.

void Node::Unhook ( NodeObject n  )  [private]

Unhook self from a nodeobject. If no more are hooked, NodeObject will be deleted.

Definition at line 60 of file Node.cpp.


Member Data Documentation

NodeObject* Node::This [private]

Pointer to the actual NodeObject.

Definition at line 62 of file Node.h.


The documentation for this class was generated from the following files:
© 2005-2007 Charles Lohr, Joshua Allen, David Chapman, Andrew Lohr. All material including documentation under the MIT/X11 license.