Group Class
Represents a group in a GroupDataSet that can be used to organize other groups and features into a tree structure.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CETactical assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CETactical assembly)
Thread safety: Any members defined in this class are, in general, not thread safe. Show
Syntax
public class Group : EngineObjectRemarks
Group elements are used to organize features into tree structures and they provide properties that can be used to filter which features are returned when reading a GroupDataSet. They also have their own set of attributes, accessed through the Attributes property, that child features and child groups will inherit when they are returned by a GroupDataSet.
Note
The only way to instantiate a Group is by calling GroupDataSet.CreateGroup.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Group
Platforms
Windows, Linux, Android
Group Members
The Group type has the following members.
Properties
| Name | Description |
|---|---|
| Attributes | Gets the AttributeSet associated with the Group. |
| DataSet | Gets the GroupDataSet the Group belongs to. |
| Id | Gets the identity of the Group. |
| IsDisposed | Gets a value that tells whether the current Group has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Group represents. Inherited from EngineObject |
| Parent | Gets the Group that is the parent of the current Group. |
| ShowChildren | Gets or sets a value that determines whether child elements of the Group will be returned when the GroupDataSet the group belongs to is being read. |
Methods
| Name | Description |
|---|---|
| Clear | Removes all groups and features from the Group. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| GetChildFeatures | Returns all features that are direct children of the current Group. |
| GetChildGroups | Returns all groups that are direct children of the current Group. |
| Insert | Overloaded. Inserts a Feature as a child feature of the current Group. |
| Remove | Overloaded. Removes the specified Feature from the collection of child features. |