Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BHoM_Engine: Add and Query Fragments #1185

Merged
merged 5 commits into from
Sep 14, 2019
Merged
Show file tree
Hide file tree
Changes from 3 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
2 changes: 2 additions & 0 deletions BHoM_Engine/BHoM_Engine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,12 @@
<Compile Include="Create\BHoMGroup.cs" />
<Compile Include="Create\RandomObject.cs" />
<Compile Include="Create\CustomObject.cs" />
<Compile Include="Modify\AddFragment.cs" />
<Compile Include="Objects\EqualityComparers\BHoMGuidComparer.cs" />
<Compile Include="Objects\EqualityComparers\BHoMObjectNameComparer.cs" />
<Compile Include="Objects\EqualityComparers\BHoMObjectNameOrToStringComparer.cs" />
<Compile Include="Objects\IterFunction.cs" />
<Compile Include="Query\FindFragment.cs" />
<Compile Include="Query\DeepClone.cs" />
<Compile Include="Query\FilterByType.cs" />
<Compile Include="Query\Geometry.cs" />
Expand Down
50 changes: 50 additions & 0 deletions BHoM_Engine/Modify/AddFragment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2019, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
*
*
* The BHoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3.0 of the License, or
* (at your option) any later version.
*
* The BHoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
*/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using BH.oM.Base;
using BH.oM.Reflection.Attributes;
using System.ComponentModel;

namespace BH.Engine.Base
{
public static partial class Modify
{
[Description("Appends a Fragment Property to a given BHoM Object")]
[Input("iBHoMObject", "Any object implementing the IBHoMObject interface that can have fragment properties appended to it")]
[Input("fragment", "Any fragment object implementing the IBHoMFragment interface to append to the object")]
[Output("iBHoMObject", "The BHoM object with the added fragment")]
public static IBHoMObject AddFragment(this IBHoMObject iBHoMObject, IBHoMFragment fragment)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per the discussion on #1184 I would like to see an optional bool (set to false initially) that allows users to replace fragments if they already exist.
Similarly, if the input is false, we should check if the fragment exists and return an error if it does. See discussion on #1184 for more info.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing on this method, You will need to clone the object to be changed as well as its list before modifying it. Either use the DeepClone method in the BHoMEngine, or shallow clone the object, and copy the fragment list. Right now, the incoming objects will be changed, changing things upstream in an visual programming workflow.

{
if (iBHoMObject == null) return null;
IBHoMObject o = iBHoMObject.DeepClone();
o.Fragments = new List<IBHoMFragment>(iBHoMObject.Fragments);
o.Fragments.Add(fragment);
return o;
}
}
}
49 changes: 49 additions & 0 deletions BHoM_Engine/Query/FindFragment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* This file is part of the Buildings and Habitats object Model (BHoM)
* Copyright (c) 2015 - 2019, the respective contributors. All rights reserved.
*
* Each contributor holds copyright over their respective contributions.
* The project versioning (Git) records all such contribution source information.
*
*
* The BHoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3.0 of the License, or
* (at your option) any later version.
*
* The BHoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
*/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using BH.oM.Base;
using BH.oM.Reflection.Attributes;
using System.ComponentModel;

namespace BH.Engine.Base
{
public static partial class Query
{
/***************************************************/
/**** Public Methods ****/
/***************************************************/

[Description("Returns an instance of a BHoM Fragment if it exists on the object")]
[Input("iBHoMObject", "A generic IBHoMObject object")]
[Input("fragmentType", "The type of fragment to be queried and returned")]
[Output("fragment", "The instance of that Fragment if it exists on the object, null otherwise")]
public static T FindFragment<T>(this IBHoMObject iBHoMObject, Type fragmentType)
{
return (T)System.Convert.ChangeType(iBHoMObject.Fragments.Where(x => x.GetType() == fragmentType).FirstOrDefault(), fragmentType);
}
}
}