Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion BHoMAnalytics_Adapter/BHoMAnalyticsAdapter.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -39,7 +39,7 @@
/**** Constructors ****/
/***************************************************/

public BHoMAnalyticsAdapter()

Check warning on line 42 in BHoMAnalytics_Adapter/BHoMAnalyticsAdapter.cs

View check run for this annotation

BHoMBot-CI / beta-documentation-compliance

BHoMAnalytics_Adapter/BHoMAnalyticsAdapter.cs#L42

Adapter constructor must contain a Description attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/HasDescriptionAttribute Method must contain an Output or MultiOutput attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/HasOutputAttribute
{

}
Expand Down Expand Up @@ -108,3 +108,4 @@




2 changes: 1 addition & 1 deletion BHoMAnalytics_Adapter/BHoMAnalytics_Adapter.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Description>https://github.com/BHoM/BHoMAnalytics_Toolkit</Description>
<FileVersion>9.0.0.0</FileVersion>
<FileVersion>9.1.0.0</FileVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<RootNamespace>BH.Adapter.BHoMAnalytics</RootNamespace>
<OutputPath>..\Build\</OutputPath>
Expand Down
2 changes: 1 addition & 1 deletion BHoMAnalytics_Engine/BHoMAnalytics_Engine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Description>https://github.com/BHoM/BHoMAnalytics_Toolkit</Description>
<FileVersion>9.0.0.0</FileVersion>
<FileVersion>9.1.0.0</FileVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<BaseOutputPath>..\Build\</BaseOutputPath>
<RootNamespace>BH.Engine.BHoMAnalytics</RootNamespace>
Expand Down
6 changes: 5 additions & 1 deletion BHoMAnalytics_Engine/Compute/CollectUsageData.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -29,6 +29,7 @@
using System.Text;
using System.Threading.Tasks;
using BH.oM.Base.Attributes;
using System.ComponentModel;

namespace BH.Engine.BHoMAnalytics
{
Expand All @@ -38,6 +39,8 @@ public static partial class Compute
/**** Public Methods ****/
/***************************************************/

[Description("Collects BHoM usage data from log files in C:\\ProgramData\\BHoM\\Logs, deserialises each entry, \n" +
"and returns a summarised list of usage entries.")]
[Input("deleteProcessedFiles", "Whether the method should delete processed log files or not.")]
[Output("entries", "The list of processed usage entries.")]
public static List<UsageEntry> CollectUsageData(bool deleteProcessedFiles = false)
Expand Down Expand Up @@ -107,3 +110,4 @@ public static List<UsageEntry> CollectUsageData(bool deleteProcessedFiles = fals




6 changes: 5 additions & 1 deletion BHoMAnalytics_Engine/Compute/SummariseUsageData.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -29,6 +29,7 @@
using System.Text;
using System.Threading.Tasks;
using BH.oM.Base.Attributes;
using System.ComponentModel;

namespace BH.Engine.BHoMAnalytics
{
Expand All @@ -38,6 +39,8 @@ public static partial class Compute
/**** Public Methods ****/
/***************************************************/

[Description("Summarises a list of raw usage log entries by grouping them by file and caller, \n" +
"consolidating repeated calls into aggregated UsageEntry objects.")]
[Input("logEntries", "The list of logged usage entries to summarise.")]
[Output("usageEntries", "A list of summarised usage entries.")]
public static List<UsageEntry> SummariseUsageData(this List<UsageLogEntry> logEntries)
Expand Down Expand Up @@ -86,3 +89,4 @@ public static List<UsageEntry> SummariseUsageData(this List<UsageLogEntry> logEn




3 changes: 2 additions & 1 deletion BHoMAnalytics_Engine/Create/ToolkitSettings.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -58,3 +58,4 @@ public static ToolkitSettings ToolkitSettings(string serverAddress, string datab




2 changes: 1 addition & 1 deletion BHoMAnalytics_oM/BHoMAnalytics_oM.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Description>https://github.com/BHoM/BHoMAnalytics_Toolkit</Description>
<FileVersion>9.0.0.0</FileVersion>
<FileVersion>9.1.0.0</FileVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<RootNamespace>BH.oM.BHoMAnalytics</RootNamespace>
<OutputPath>..\Build\</OutputPath>
Expand Down
3 changes: 2 additions & 1 deletion BHoMAnalytics_oM/Enums/ItemType.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -43,3 +43,4 @@ public enum ItemType




3 changes: 2 additions & 1 deletion BHoMAnalytics_oM/ToolkitSettings.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -77,3 +77,4 @@ public ToolkitSettings(string serverAddress, string databaseName, string collect




3 changes: 2 additions & 1 deletion BHoMAnalytics_oM/UsageEntry.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -76,3 +76,4 @@ public class UsageEntry : BHoMObject




3 changes: 2 additions & 1 deletion BHoMAnalytics_oM/WebUsageEntry.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
* Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
Expand Down Expand Up @@ -68,3 +68,4 @@ public class WebUsageEntry : BHoMObject