dox/Filtering/vtkKWEObjectTreeNodeBase.h

Go to the documentation of this file.

//=============================================================================
//   This file is part of VTKEdge. See vtkedge.org for more information.
//
//   Copyright (c) 2010 Kitware, Inc.
//
//   VTKEdge may be used under the terms of the BSD License
//   Please see the file Copyright.txt in the root directory of
//   VTKEdge for further information.
//
//   Alternatively, you may see: 
//
//   http://www.vtkedge.org/vtkedge/project/license.html
//
//
//   For custom extensions, consulting services, or training for
//   this or any other Kitware supported open source project, please
//   contact Kitware at sales@kitware.com.
//
//
//=============================================================================
#ifndef __vtkKWEObjectTreeNodeBase_h
#define __vtkKWEObjectTreeNodeBase_h

#include "vtkKWESerializableObject.h"
#include "vtkSmartPointer.h"
#include "VTKEdgeConfigure.h" // include configuration header

class vtkInformation;
class vtkInformationIntegerKey;
class vtkInformationObjectBaseKey;
class vtkInformationStringKey;
class vtkKWEObjectTreePropertyBase;
class vtkKWEObjectTreeNodeBaseChildren;
class vtkKWEObjectTreeNodeIterator;
class vtkKWESerializer;

class VTKEdge_FILTERING_EXPORT vtkKWEObjectTreeNodeBase : public vtkKWESerializableObject
{
public:
  static vtkKWEObjectTreeNodeBase* New();
  vtkTypeRevisionMacro(vtkKWEObjectTreeNodeBase, vtkKWESerializableObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual void SetNodeObject(vtkObject *object);
  vtkGetObjectMacro(NodeObject, vtkObject);

  virtual unsigned int GetNumberOfChildren();

  virtual int AddChild(vtkKWEObjectTreeNodeBase *childNode);

  virtual int InsertChild(unsigned int index, vtkKWEObjectTreeNodeBase *childNode);

  int RemoveChild(vtkKWEObjectTreeNodeBase *childNode);

  int RemoveChild(unsigned int index);

  vtkKWEObjectTreeNodeBase *GetChild(unsigned int index);


  vtkGetObjectMacro(Parent, vtkKWEObjectTreeNodeBase);

  virtual bool IsDescendant(vtkKWEObjectTreeNodeBase *testNode);

  int AddProperty(vtkKWEObjectTreePropertyBase *nodeProperty);

  void GetAllProperties(vtkInformation *allProperties);


  vtkKWEObjectTreePropertyBase* GetProperty(vtkInformationObjectBaseKey *propertyKey,
    bool &inheritedProperty, bool includeInheritance = false);

  int RemoveProperty(vtkInformationObjectBaseKey *propertyKey);

  int RemoveProperty(vtkKWEObjectTreePropertyBase *nodeProperty);

  void RemoveAllProperties();

  int GetNumberOfProperties();

  virtual void Modified();

  virtual unsigned long GetMTime();


  vtkGetMacro(TreeModifiedTime, unsigned long);


  virtual bool IsEqualTo(vtkKWEObjectTreeNodeBase *testNode,
    bool checkDescendants, bool canBeSuperset = false,
    bool considerInheritedProperties = false);

  virtual void Serialize(vtkKWESerializer*);


  const char *GetName();
  void SetName(const char *name);

  const char *GetUUID();

  void SetUUID(const char *uuid);

  int CreateUUID();

  void ClearUUID();

  //BTX
  // might expand to have a third state, where node is inactive, but the
  // subtree is not.
  enum NodeStates
    {
    ACTIVE_STATE,
    INACTIVE_STATE
    };
  //ETX
  void SetStateToActive()
    { this->SetState(ACTIVE_STATE); }
  void SetStateToInactive()
    { this->SetState(INACTIVE_STATE); }
  void SetState(int nodeState);
  int GetState();
  const char *GetStateAsString();


  void InheritPropertiesOn()
    { this->SetInheritProperties(true); }
  void InheritPropertiesOff()
    { this->SetInheritProperties(false); }
  bool CanInheritProperties()
    { return this->GetInheritProperties(); }
  bool GetInheritProperties();
  void SetInheritProperties(bool inheritState);

  static vtkInformationStringKey* NAME();
  static vtkInformationStringKey* UUID();
  static vtkInformationIntegerKey* STATE();
  static vtkInformationIntegerKey* INHERIT_PROPERTIES();


protected:
  vtkKWEObjectTreeNodeBase();
  virtual ~vtkKWEObjectTreeNodeBase();

  void SetParent(vtkKWEObjectTreeNodeBase *parent);


  friend class vtkKWEObjectTreeNodeIterator;
  void AddChildren(vtkKWEObjectTreeNodeIterator *iterator);


  friend class vtkKWEObjectTreePropertyBase;
  virtual void UpdateTreeModifiedTime(unsigned long treeTime);

  void AddInheritedProperties(vtkInformation *allProperties);

  int GetNumberOfInformationEntries(vtkInformation *infoObject);

  vtkKWEObjectTreeNodeBaseChildren *Children;

  vtkKWEObjectTreeNodeBase *Parent;

  vtkInformation *Properties;

  vtkInformation *Attributes;

  unsigned long TreeModifiedTime;

  vtkObject *NodeObject;

  virtual void SerializeObject(vtkKWESerializer*);

private:
  vtkKWEObjectTreeNodeBase(const vtkKWEObjectTreeNodeBase&); // Not implemented.
  void operator=(const vtkKWEObjectTreeNodeBase&); // Not implemented.

  bool RemoveAllPropertiesInternal();
};

#endif