vtkDataArraySelection: update docs and make methods `const`

Minor cleanup to vtkDataArraySelection to make obviously `const` methods
as `const`.

Also updated docs to clarify which methods call `this->Modified()` and
which ones don't.

Common/Core/vtkDataArraySelection.cxx

@@ -105,7 +105,7 @@ void vtkDataArraySelection::SetArraySetting(const char* name, int setting)
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::ArrayIsEnabled(const char* name)
+int vtkDataArraySelection::ArrayIsEnabled(const char* name) const
 {
   auto iter = this->Internal->Find(name);
   if (iter != this->Internal->Arrays.end())
@@ -118,7 +118,7 @@ int vtkDataArraySelection::ArrayIsEnabled(const char* name)
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::ArrayExists(const char* name)
+int vtkDataArraySelection::ArrayExists(const char* name) const
 {
   // Check if there is a specific entry for this array.
   return this->Internal->Find(name) != this->Internal->Arrays.end() ? 1 : 0;
@@ -165,13 +165,13 @@ void vtkDataArraySelection::DisableAllArrays()
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::GetNumberOfArrays()
+int vtkDataArraySelection::GetNumberOfArrays() const
 {
   return static_cast<int>(this->Internal->Arrays.size());
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::GetNumberOfArraysEnabled()
+int vtkDataArraySelection::GetNumberOfArraysEnabled() const
 {
   int numArrays = 0;
   for (const auto& apair : this->Internal->Arrays)
@@ -183,7 +183,7 @@ int vtkDataArraySelection::GetNumberOfArraysEnabled()
 }
 
 //----------------------------------------------------------------------------
-const char* vtkDataArraySelection::GetArrayName(int index)
+const char* vtkDataArraySelection::GetArrayName(int index) const
 {
   try
   {
@@ -196,7 +196,7 @@ const char* vtkDataArraySelection::GetArrayName(int index)
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::GetArrayIndex(const char* name)
+int vtkDataArraySelection::GetArrayIndex(const char* name) const
 {
   auto iter = this->Internal->Find(name);
   if (iter != this->Internal->Arrays.end())
@@ -208,7 +208,7 @@ int vtkDataArraySelection::GetArrayIndex(const char* name)
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::GetEnabledArrayIndex(const char* name)
+int vtkDataArraySelection::GetEnabledArrayIndex(const char* name) const
 {
   int index = 0;
   for (const auto& apair : this->Internal->Arrays)
@@ -226,7 +226,7 @@ int vtkDataArraySelection::GetEnabledArrayIndex(const char* name)
 }
 
 //----------------------------------------------------------------------------
-int vtkDataArraySelection::GetArraySetting(int index)
+int vtkDataArraySelection::GetArraySetting(int index) const
 {
   if (index >= 0 && index < this->GetNumberOfArrays())
   {

Common/Core/vtkDataArraySelection.h

@@ -41,12 +41,18 @@ public:
   /**
    * Enable the array with the given name.  Creates a new entry if
    * none exists.
+   *
+   * This method will call `this->Modified()` if the enable state for the
+   * array changed.
    */
   void EnableArray(const char* name);
 
   /**
    * Disable the array with the given name.  Creates a new entry if
    * none exists.
+   *
+   * This method will call `this->Modified()` if the enable state for the
+   * array changed.
    */
   void DisableArray(const char* name);
 
@@ -54,58 +60,64 @@ public:
    * Return whether the array with the given name is enabled.  If
    * there is no entry, the array is assumed to be disabled.
    */
-  int ArrayIsEnabled(const char* name);
+  int ArrayIsEnabled(const char* name) const;
 
   /**
    * Return whether the array with the given name exists.
    */
-  int ArrayExists(const char* name);
+  int ArrayExists(const char* name) const;
 
   /**
    * Enable all arrays that currently have an entry.
+   *
+   * This method will call `this->Modified()` if the enable state for any of the known
+   * arrays is changed.
    */
   void EnableAllArrays();
 
   /**
    * Disable all arrays that currently have an entry.
+   *
+   * This method will call `this->Modified()` if the enable state for any of the known
+   * arrays is changed.
    */
   void DisableAllArrays();
 
   /**
    * Get the number of arrays that currently have an entry.
    */
-  int GetNumberOfArrays();
+  int GetNumberOfArrays() const;
 
   /**
    * Get the number of arrays that are enabled.
    */
-  int GetNumberOfArraysEnabled();
+  int GetNumberOfArraysEnabled() const;
 
   /**
    * Get the name of the array entry at the given index.
    */
-  const char* GetArrayName(int index);
+  const char* GetArrayName(int index) const;
 
   /**
    * Get an index of the array with the given name.
    */
-  int GetArrayIndex(const char *name);
+  int GetArrayIndex(const char *name) const;
 
   /**
    * Get the index of an array with the given name among those
    * that are enabled.  Returns -1 if the array is not enabled.
    */
-  int GetEnabledArrayIndex(const char* name);
+  int GetEnabledArrayIndex(const char* name) const;
 
   /**
    * Get whether the array at the given index is enabled.
    */
-  int GetArraySetting(int index);
+  int GetArraySetting(int index) const;
 
   /**
    * Get whether the array is enabled/disable using its name.
    */
-  int GetArraySetting(const char* name)
+  int GetArraySetting(const char* name) const
   {
     return this->GetArraySetting(this->GetArrayIndex(name));
   }
@@ -113,11 +125,16 @@ public:
   /**
    * Set array setting given the name. If the array doesn't exist, it will be
    * added.
+   *
+   * This method will call `this->Modified()` if the enable state for the
+   * array changed.
    */
   void SetArraySetting(const char* name, int status);
 
   /**
    * Remove all array entries.
+   *
+   * This method will call `this->Modified()` if the arrays were cleared.
    */
   void RemoveAllArrays();
 
@@ -128,16 +145,25 @@ public:
    * by default. The state can also be passed as the second argument.
    * This method should be called only by the filter owning this
    * object.
+   *
+   * This method **does not** call `this->Modified()`.
+   *
+   * Also note for arrays already known to this instance (i.e.
+   * `this->ArrayExists(name) == true`, this method has no effect.
    */
   int AddArray(const char* name, bool state=true);
 
   /**
    * Remove an array setting given its index.
+   *
+   * This method **does not** call `this->Modified()`.
    */
   void RemoveArrayByIndex(int index);
 
   /**
    * Remove an array setting given its name.
+   *
+   * This method **does not** call `this->Modified()`.
    */
   void RemoveArrayByName(const char* name);
 
@@ -151,6 +177,8 @@ public:
    * should be called only by the filter owning this object.  The
    * signature with the default must have a different name due to a
    * bug in the Borland C++ 5.5 compiler.
+   *
+   * This method **does not** call `this->Modified()`.
    */
   void SetArrays(const char* const* names, int numArrays);
   void SetArraysWithDefault(const char* const* names, int numArrays,
@@ -159,6 +187,8 @@ public:
 
   /**
    * Copy the selections from the given vtkDataArraySelection instance.
+   *
+   * This method will call `this->Modified()` if the array selections changed.
    */
   void CopySelections(vtkDataArraySelection* selections);
 
@@ -167,6 +197,8 @@ public:
    * exist in `this` but exist in `other`, they will get added to `this` with
    * the same array setting as in `other`. Array settings for arrays already in
    * `this` are left unchanged.
+   *
+   * This method will call `this->Modified()` if the array selections changed.
    */
   void Union(vtkDataArraySelection* other);