vtkSMStringVectorProperty.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMStringVectorProperty_h
#define vtkSMStringVectorProperty_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMVectorProperty.h"

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

class vtkStringList;
class vtkSMStateLocator;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMStringVectorProperty : public vtkSMVectorProperty
{
public:
  static vtkSMStringVectorProperty* New();
  vtkTypeMacro(vtkSMStringVectorProperty, vtkSMVectorProperty);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  unsigned int GetNumberOfElements() override;

  void SetNumberOfElements(unsigned int num) override;

  int SetElement(unsigned int idx, const char* value);

  int SetElements(const char* values[], unsigned int count);


  int SetElements(vtkStringList* newvalue);
  int SetElements(const std::vector<std::string>& newvalue);


  int SetUncheckedElements(const char* values[], unsigned int count);
  int SetUncheckedElements(const std::vector<std::string>& newvalue);

  int AppendElements(const std::vector<std::string>& newvalue);

  int AppendUncheckedElements(const std::vector<std::string>& newvalue);

  void GetElements(vtkStringList* list);


  const std::vector<std::string>& GetElements() const;
  const std::vector<std::string>& GetUncheckedElements() const;

  const char* GetElement(unsigned int idx);

  unsigned int GetElementIndex(const char* value, int& exists);


  void SetElementType(unsigned int idx, int type);
  int GetElementType(unsigned int idx);

  const char* GetUncheckedElement(unsigned int idx);

  void SetUncheckedElement(unsigned int idx, const char* value);


  void GetUncheckedElements(vtkStringList* list);
  int SetUncheckedElements(vtkStringList* list);

  unsigned int GetNumberOfUncheckedElements() override;

  enum ElementTypes
  {
    INT,
    DOUBLE,
    STRING
  };

  void Copy(vtkSMProperty* src) override;

  const char* GetDefaultValue(int idx);

  void ClearUncheckedElements() override;

  bool IsValueDefault() override;

  void ResetToXMLDefaults() override;

protected:
  vtkSMStringVectorProperty();
  ~vtkSMStringVectorProperty() override;

  void SetNumberOfUncheckedElements(unsigned int num) override;

  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;

  void WriteTo(vtkSMMessage*) override;

  void ReadFrom(const vtkSMMessage*, int msg_offset, vtkSMProxyLocator*) override;

  int LoadState(vtkPVXMLElement* element, vtkSMProxyLocator* loader) override;

  // Save concrete property values into the XML state property declaration
  void SaveStateValues(vtkPVXMLElement* propElement) override;

private:
  vtkSMStringVectorProperty(const vtkSMStringVectorProperty&) = delete;
  void operator=(const vtkSMStringVectorProperty&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
};

#endif