vtkPVXMLElement.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkPVXMLElement.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkPVXMLElement_h
#define vtkPVXMLElement_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsCoreModule.h" // needed for export macro

#include <string> // for std::string

class vtkCollection;
class vtkPVXMLParser;

struct vtkPVXMLElementInternals;

class VTKPVVTKEXTENSIONSCORE_EXPORT vtkPVXMLElement : public vtkObject
{
public:
  vtkTypeMacro(vtkPVXMLElement, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkPVXMLElement* New();


  vtkSetStringMacro(Name);
  vtkGetStringMacro(Name);


  vtkGetStringMacro(Id);

  const char* GetAttribute(const char* name) { return this->GetAttributeOrDefault(name, NULL); }

  const char* GetAttributeOrEmpty(const char* name)
  {
    return this->GetAttributeOrDefault(name, "");
  }

  const char* GetAttributeOrDefault(const char* name, const char* notFound);

  const char* GetCharacterData();


  int GetScalarAttribute(const char* name, int* value);
  int GetScalarAttribute(const char* name, float* value);
  int GetScalarAttribute(const char* name, double* value);
#if defined(VTK_USE_64BIT_IDS)
  int GetScalarAttribute(const char* name, vtkIdType* value);
#endif



  int GetVectorAttribute(const char* name, int length, int* value);
  int GetVectorAttribute(const char* name, int length, float* value);
  int GetVectorAttribute(const char* name, int length, double* value);
#if defined(VTK_USE_64BIT_IDS)
  int GetVectorAttribute(const char* name, int length, vtkIdType* value);
#endif



  int GetCharacterDataAsVector(int length, int* value);
  int GetCharacterDataAsVector(int length, float* value);
  int GetCharacterDataAsVector(int length, double* value);
#if defined(VTK_USE_64BIT_IDS)
  int GetCharacterDataAsVector(int length, vtkIdType* value);
#endif


  vtkPVXMLElement* GetParent();

  unsigned int GetNumberOfNestedElements();

  vtkPVXMLElement* GetNestedElement(unsigned int index);

  vtkPVXMLElement* FindNestedElement(const char* id);

  vtkPVXMLElement* FindNestedElementByName(const char* name);

  void FindNestedElementByName(const char* name, vtkCollection* elements);

  void RemoveAllNestedElements();

  void RemoveNestedElement(vtkPVXMLElement*);

  void ReplaceNestedElement(vtkPVXMLElement* elementToReplace, vtkPVXMLElement* element);

  vtkPVXMLElement* LookupElement(const char* id);


  void AddAttribute(const char* attrName, const char* attrValue);
  void AddAttribute(const char* attrName, unsigned int attrValue);
  void AddAttribute(const char* attrName, double attrValue);
  void AddAttribute(const char* attrName, double attrValue, int precision);
  void AddAttribute(const char* attrName, int attrValue);
#if defined(VTK_USE_64BIT_IDS)
  void AddAttribute(const char* attrName, vtkIdType attrValue);
#endif


  void RemoveAttribute(const char* attrName);

  void SetAttribute(const char* attrName, const char* attrValue);


  void AddNestedElement(vtkPVXMLElement* element, int setPrent);
  void AddNestedElement(vtkPVXMLElement* element);


  void PrintXML(ostream& os, vtkIndent indent);
  void PrintXML();

  void Merge(vtkPVXMLElement* element, const char* attributeName);


  void GetElementsByName(const char* name, vtkCollection* elements);
  void GetElementsByName(const char* name, vtkCollection* elements, bool recursively);

  static std::string Encode(const char* plaintext);

  bool Equals(vtkPVXMLElement* other);

  void CopyTo(vtkPVXMLElement* other);

  void CopyAttributesTo(vtkPVXMLElement* other);

protected:
  vtkPVXMLElement();
  ~vtkPVXMLElement() override;

  vtkPVXMLElementInternals* Internal;

  char* Name;
  char* Id;

  // The parent of this element.
  vtkPVXMLElement* Parent;

  // Method used by vtkPVXMLParser to setup the element.
  vtkSetStringMacro(Id);
  void ReadXMLAttributes(const char** atts);
  void AddCharacterData(const char* data, int length);

  // Internal utility methods.
  vtkPVXMLElement* LookupElementInScope(const char* id);
  vtkPVXMLElement* LookupElementUpScope(const char* id);
  void SetParent(vtkPVXMLElement* parent);

  friend class vtkPVXMLParser;

private:
  vtkPVXMLElement(const vtkPVXMLElement&) = delete;
  void operator=(const vtkPVXMLElement&) = delete;
};

#endif