BH.oM.Structure.Requests.BarResultRequest¶
Request for extracting Bar results from an adapter.
Class structure¶
Implemented interfaces and base types¶
The BarResultRequest is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Structure.Requests.IStructuralResultRequest
- BH.oM.Data.Requests.IResultRequest
- BH.oM.Data.Requests.IRequest
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| ResultType | BarResultType | - | - |
| DivisionType | DivisionType | Defines which internal points results should be extracted for. For evenly distributed the bar is split into equal length segments, controlled by the divisions. For ExtremeValues the positions with extreme forces for any DOF will be included, which means you might get more/less values than stated in the Divisions. | - |
| Divisions | int | Defines how many points along the bar that results should be extracted for. | - |
| Cases | List<object> | Defines which cases and/or combinations that results should be extracted for. Can generally be set to either Loadcase or Loadcombination objects, or identifiers matching the software. If nothing is provided, results for all cases will be assumed. | - |
| Modes | List<string> | Defines for which modes results should be extracted. Only applicable for some casetypes. If nothing is provided, results for all modes will be assumed. | - |
| ObjectIds | List<object> | Defines which Bars that results should be extracted for. Can generally be set to either pulled Bar objects, or identifiers matching the software. If nothing is provided, results for all Bars will be assumed. | - |
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 class BarResultRequest : BH.oM.Structure.Requests.IStructuralResultRequest,
BH.oM.Data.Requests.IResultRequest,
BH.oM.Data.Requests.IRequest,
BH.oM.Base.IObject
Assembly: Structure_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/Structure_oM/Requests/BarResultRequest.json"
}
The JSON Schema is available on github here: