Skip to content

BH.oM.Inspection.Audit

An audit that covers all information associated with a single inspection. This includes issues, areas inspected, project information, construction progress, and distribution information.

Class structure

Implemented interfaces and base types

The Audit is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Title string Title of Audit (typically the project name or name of a specific scope of the project) -
Filename string Filename of Audit used to identify it when saved to reports or other formats -
AuditID string Unique ID of Audit provided by the Audit's source -
SiteVisitNumber int Site Visit Number of the Audit (this is a sequential number corresponding to the amount of audits conducted for this project up to this point) -
Client string Client for which the Audit is being recorded -
RevisionNumber int Revision Number of the Audit (typically 0, only used when the information related to a specific audit is revised) -
InspectionDate DateTime Date the Audit was conducted in local time. -
InspectionDateUtc DateTime Date the Audit was conducted in UTC time. -
IssueDate DateTime Date the Audit was issued in local time. -
IssueDateUtc DateTime Date the Audit was issued in UTC time. -
Author string Creator of the Audit -
ProjectNumber string Project Number of the Project the Audit is for -
JobLeader string Job leader of the Project the Audit is for -
Distribution List<string> List of people the Audit is distributed to -
Attendance List<string> List of people in attendance during audit -
VisitPurpose string Reason(s) for visit and audit -
AreasInspected List<string> List of areas inspected throughout the audit -
InstallationProgressObjects List<InstallationProgress> Installation progress objects from the audit (Each of these corresponds to the status of a specific area inspected) -
IssueNumbers List<string> Issues from audit. These are reference IssueNumbers to corresponding issues identified during the audit for various areas that need to be addressed, which can include supporting images of the work as applicable. -
Score string Score as a percentage. This represents the amount of issues / areas that have been resolved, and is an optional value not used by all audits. -

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> - -

Code and Schema

C# implementation

C#
public class Audit : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

Assembly: Inspection_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/Inspection_oM/Audit.json"
}

The JSON Schema is available on github here: