BH.oM.Data.Requests.IRequest¶
Interface structure¶
Implemented interfaces and base types¶
The IRequest is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IObject
Interfaces implementing this interface¶
The following interfaces are implementing this interface:
- BH.oM.Data.Requests.ILogicalRequest
- BH.oM.Data.Requests.IResultRequest
- BH.oM.Adapters.File.IDirectoryRequest
- BH.oM.Adapters.File.IFileRequest
- BH.oM.Adapters.File.IFilingRequest
- BH.oM.Adapters.File.IResourceRequest
- BH.oM.Adapters.File.ISortableRequest
- BH.oM.Structure.Requests.IStructuralResultRequest
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Data.Requests.BatchRequest
- BH.oM.Data.Requests.CustomRequest
- BH.oM.Data.Requests.FilterRequest
- BH.oM.Data.Requests.LogicalAndRequest
- BH.oM.Data.Requests.LogicalNotRequest
- BH.oM.Data.Requests.LogicalOrRequest
- BH.oM.Data.Requests.SelectionRequest
- BH.oM.Adapters.ETABS.Requests.PierAndSpandrelForceRequest
- BH.oM.Adapters.Excel.CellContentsRequest
- BH.oM.Adapters.Excel.CellValuesRequest
- BH.oM.Adapters.Excel.ObjectRequest
- BH.oM.Adapters.Excel.WorksheetsRequest
- BH.oM.Adapters.File.DirectoryRequest
- BH.oM.Adapters.File.FileContentRequest
- BH.oM.Adapters.File.FileDirRequest
- BH.oM.Adapters.File.FileRequest
- BH.oM.Adapters.File.RemoveRequest
- BH.oM.Adapters.HTTP.GetRequest
- BH.oM.Adapters.Mongo.Requests.CollectionNames
- BH.oM.Adapters.Revit.Requests.ConditionRequest
- BH.oM.Adapters.Revit.Requests.EnergyAnalysisModelRequest
- BH.oM.Adapters.Revit.Requests.FilterActiveView
- BH.oM.Adapters.Revit.Requests.FilterByActiveWorkset
- BH.oM.Adapters.Revit.Requests.FilterByCategory
- BH.oM.Adapters.Revit.Requests.FilterByDBTypeName
- BH.oM.Adapters.Revit.Requests.FilterByElementIds
- BH.oM.Adapters.Revit.Requests.FilterByFamilyAndTypeName
- BH.oM.Adapters.Revit.Requests.FilterByFamilyType
- BH.oM.Adapters.Revit.Requests.FilterByLink
- BH.oM.Adapters.Revit.Requests.FilterByParameterExistence
- BH.oM.Adapters.Revit.Requests.FilterByScopeBox
- BH.oM.Adapters.Revit.Requests.FilterBySelectionSet
- BH.oM.Adapters.Revit.Requests.FilterByUniqueIds
- BH.oM.Adapters.Revit.Requests.FilterByUsage
- BH.oM.Adapters.Revit.Requests.FilterByViewSpecific
- BH.oM.Adapters.Revit.Requests.FilterByVisibleInActiveView
- BH.oM.Adapters.Revit.Requests.FilterByVisibleInView
- BH.oM.Adapters.Revit.Requests.FilterByWorkset
- BH.oM.Adapters.Revit.Requests.FilterEverything
- BH.oM.Adapters.Revit.Requests.FilterFamilyByName
- BH.oM.Adapters.Revit.Requests.FilterFamilyTypeByName
- BH.oM.Adapters.Revit.Requests.FilterLinkInstance
- BH.oM.Adapters.Revit.Requests.FilterMemberElements
- BH.oM.Adapters.Revit.Requests.FilterModelElements
- BH.oM.Adapters.Revit.Requests.FilterTypesOfFamily
- BH.oM.Adapters.Revit.Requests.FilterViewByName
- BH.oM.Adapters.Revit.Requests.FilterViewsByTemplate
- BH.oM.Adapters.Revit.Requests.FilterViewsByType
- BH.oM.Adapters.Revit.Requests.FilterViewTemplateByName
- BH.oM.Adapters.SAP2000.Requests.SteelUtilisationRequest
- BH.oM.Adapters.SQL.CustomRequest
- BH.oM.Adapters.SQL.TableRequest
- BH.oM.Structure.Requests.BarResultRequest
- BH.oM.Structure.Requests.GlobalResultRequest
- BH.oM.Structure.Requests.MeshResultRequest
- BH.oM.Structure.Requests.NodeResultRequest
Properties¶
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¶
Assembly: Data_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/Data_oM/Requests/IRequest.json"
}
The JSON Schema is available on github here: