Skip to content

BH.oM.Structure.Loads.IElementLoad<T>

Base load interface used by all element type loads, such as Bar, Node and Panel loads.

Interface structure

Generic parameters

The IElementLoad contains the following generic paramters:

T

Constrained by the following arguments:

Implemented interfaces and base types

The IElementLoad`1 is inheriting from the following base type(s) and implements the following interfaces:

Classes implementing this interface

The following classes are implementing this interface:

Properties

Defining properties

The following properties are defined on the interface

Name Type Description Quantity
Objects BHoMGroup<T> The group of objects that the load should be applied to. For most analysis packages the objects added here need to be pulled from the analysis package before being assigned to the load. -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
IsNull bool Checks if a Load is null and outputs relevant error message. - Structure_Engine
IVisualize IEnumerable<IGeometry> Draws arrows representing the load. Visualisation will depend on the load type. - Structure_Engine

Code and Schema

C# implementation

C#
public interface IElementLoad`1 : BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Structure.Loads.ILoad

Assembly: Structure_oM.dll

The C# interface 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/Structure_oM/Loads/IElementLoad`1.json"
}

The JSON Schema is available on github here:

  • [IElementLoad1.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Structure_oM/Loads/IElementLoad1.json)