BH.oM.Programming.ClusterContent¶
Content of a Cluster syntax node.
Class structure¶
Implemented interfaces and base types¶
The ClusterContent is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
InternalNodes | List<INode> | - | - |
NodeGroups | List<NodeGroup> | - | - |
Inputs | List<DataParam> | - | - |
Outputs | List<ReceiverParam> | - | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
CustomData | Dictionary<string, object> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
Body | List<StatementSyntax> | Get the C# statement syntax corresponding to the content of a cluster. | - | CSharp_Engine |
DataTypePerParam | Dictionary<Guid, Type> | Collect the data type for each parameter of each syntax node inside the cluster. | - | Programming_Engine |
ReturnType | TypeSyntax | Get the C# type syntax corresponding to the first output of a cluster content. | - | CSharp_Engine |
Code and Schema¶
C# implementation¶
Assembly: Programming_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Programming_oM/ClusterContent.json"
}
The JSON Schema is available on github here: