BH.oM.Structure.Requests.IStructuralResultRequest¶
Interface structure¶
Implemented interfaces and base types¶
The IStructuralResultRequest is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Data.Requests.IResultRequest
- BH.oM.Data.Requests.IRequest
- BH.oM.Base.IObject
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Adapters.ETABS.Requests.PierAndSpandrelForceRequest
- BH.oM.Adapters.SAP2000.Requests.SteelUtilisationRequest
- BH.oM.Structure.Requests.BarResultRequest
- BH.oM.Structure.Requests.GlobalResultRequest
- BH.oM.Structure.Requests.MeshResultRequest
- BH.oM.Structure.Requests.NodeResultRequest
Properties¶
Defining properties¶
The following properties are defined on the interface
Name | Type | Description | Quantity |
---|---|---|---|
Modes | List<string> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
Discipline | Nullable<Discipline> | Gets discipline enforced by the Request. If the result is different than defaultDiscipline and neither of two is Undefined, null is returned (the result discipline is conflicting with defaultDiscipline). | - | Revit_Engine |
IFilterDescription | string | Returns a description of the filter represented by the given IRequest. | - | Revit_Engine |
Code and Schema¶
C# implementation¶
C#
public interface IStructuralResultRequest : BH.oM.Data.Requests.IResultRequest, BH.oM.Data.Requests.IRequest, BH.oM.Base.IObject
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/Requests/IStructuralResultRequest.json"
}
The JSON Schema is available on github here: