## On this page

  

 

 # FolderBuilder Class Reference

 Last update: 16.07.2025 

Represents a Folder Builder. [More...](#details)

Inheritance diagram for FolderBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_folder_builder.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 'None' [Remove](#a12f4e2916ea81a1db85709bc53d9d0fe) (self, \*args) Removes the specified feature object from the folder.   
  'bool' [Add](#a3edde4a5462dcfe792466658461faea7) (self, feature) Adds the specified feature object into the folder.   
  'bool' [Insert](#ac018548ba37f67d204490f4206c6ffe4) (self, feature, after=None) Inserts the specified feature object into the folder after another specified feature.   
  'bool' [IsCompatible](#a69d01418cd8ff56cad7fe5412477c828) (self, feature) Checks if the specified feature object is compatible with this folder.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [Category](#ad118727ac7e398ef5e18f05f5e47adeb) = property(fset=\_\_SetCategory) Gets or sets the category type of the folder.   
 str [Features](#a55f34dfc86771ae2333c08b4113d26b6) = property(fget=\_\_GetFeatures, fset=\_\_SetFeatures) Gets or sets features belonging to this folder.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') <a id="details" name="details"></a>## Detailed Description

Represents a Folder Builder.

The Folder Builder creates or edits Folder features.

To create a new instance of this class, use FeatureCollection.CreateFolderBuilder.



## Member Function Documentation

<a id="a3edde4a5462dcfe792466658461faea7" name="a3edde4a5462dcfe792466658461faea7"></a>## [◆ ](#a3edde4a5462dcfe792466658461faea7)Add()

  'bool' Add  (  *self*,     *feature* )

Adds the specified feature object into the folder.

Parameters \[in\]featurethe feature object.  
ReturnsTrue if successfully added into the folder; Otherwise, returns False. 



<a id="ac018548ba37f67d204490f4206c6ffe4" name="ac018548ba37f67d204490f4206c6ffe4"></a>## [◆ ](#ac018548ba37f67d204490f4206c6ffe4)Insert()

  'bool' Insert  (  *self*,     *feature*,     *after* = None )

Inserts the specified feature object into the folder after another specified feature.

Parameters \[in\]featurethe feature object to add.  
\[in\]aftera feature object after which the feature object should be insert.  
ReturnsTrue if successfully inserted into the folder; Otherwise, returns False. 



<a id="a69d01418cd8ff56cad7fe5412477c828" name="a69d01418cd8ff56cad7fe5412477c828"></a>## [◆ ](#a69d01418cd8ff56cad7fe5412477c828)IsCompatible()

  'bool' IsCompatible  (  *self*,     *feature* )

Checks if the specified feature object is compatible with this folder.

Parameters \[in\]featurethe feature object.  
ReturnsTrue if the specified feature object is compatible with this folder; Otherwise, returns False. 



<a id="a12f4e2916ea81a1db85709bc53d9d0fe" name="a12f4e2916ea81a1db85709bc53d9d0fe"></a>## [◆ ](#a12f4e2916ea81a1db85709bc53d9d0fe)Remove()

  'None' Remove  (  *self*,    \* *args* )

Removes the specified feature object from the folder.

The specified feature object must be a member of the folder to be removed from it.

Parameters \[in\]featurethe feature object.  




## Member Data Documentation

<a id="ad118727ac7e398ef5e18f05f5e47adeb" name="ad118727ac7e398ef5e18f05f5e47adeb"></a>## [◆ ](#ad118727ac7e398ef5e18f05f5e47adeb)Category

 str Category = property(fset=\_\_SetCategory)  static 

Gets or sets the category type of the folder.

The values are:   
 0 - None.  
 1 - Properties.  
 2 - Sources.  
 3 - Sensors.  
 4 - Simulations.

**Value type: Integer.**

 **The default value is None (0). A category type other than None (0) must be defined.**





<a id="a55f34dfc86771ae2333c08b4113d26b6" name="a55f34dfc86771ae2333c08b4113d26b6"></a>## [◆ ](#a55f34dfc86771ae2333c08b4113d26b6)Features

 str Features = property(fget=\_\_GetFeatures, fset=\_\_SetFeatures)  static 

Gets or sets features belonging to this folder.

The Features property takes and returns a list of feature objects.

**Value type**: List of Feature objects.

The default value is an empty list.





---

The documentation for this class was generated from the following file:- **SpeosNX\_2412.py**