Skip to content

Commit

Permalink
Add input parameters and add ToBeRemoved for PanelToFEMesh that has s…
Browse files Browse the repository at this point in the history
…ince been replaced in Structure_Engine
  • Loading branch information
peterjamesnugent committed Mar 21, 2024
1 parent ff156ec commit d51aee1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
6 changes: 3 additions & 3 deletions MidasCivil_Engine/Compute/CombineTextFiles.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ public static partial class Compute
/**** Public Methods ****/
/***************************************************/

[Description("Combines all text files specified by type in to a single MidasCivilText (MCT) to be loaded in to MidasCivil")]
[Input("filePath", "The same filepath used for the adapter (pointing to an mcb file)")]
[Description("Combines all text files specified by type in to a single MidasCivilText (MCT) to be loaded in to MidasCivil.")]
[Input("filePath", "The same filepath used for the adapter (pointing to an mcb file).")]
[Input("types", "BHoM object types to specify the text files to be combined. A null value will combine all text files.")]
[Input("active", "Execute the method")]
[Input("active", "Execute the method.")]
[Output("success", "Was the execution successful?")]

public static bool CombineTextFiles(string filePath, List<Type> types = null, bool active = false)
Expand Down
2 changes: 2 additions & 0 deletions MidasCivil_Engine/Compute/FEMeshToPanel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
using BH.oM.Geometry;
using System.Collections.Generic;
using System.Linq;
using BH.oM.Base.Attributes;

namespace BH.Engine.Adapters.MidasCivil
{
Expand All @@ -35,6 +36,7 @@ public static partial class Compute
/**** Public Methods ****/
/***************************************************/

[ToBeRemoved("4.2","Method was replaced in 4.2 by BH.Engine.Structure.Convert.FEMeshToPanel.")]
public static Panel FEMeshToPanel(FEMesh mesh)
{
List<Polyline> polylines = new List<Polyline>();
Expand Down
12 changes: 10 additions & 2 deletions MidasCivil_Engine/Create/Metadata.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,18 @@ public static partial class Create
/***************************************************/

[Description("Creates a Metadata object from a variety of inputs.")]
[Input("projectNumber", "Unique number for the project.")]
[Input("projectName", "The name of the project.")]
[Input("location", "Where the project is based.")]
[Input("description", "A short description of the project and model.")]
[Input("discipline", "The discipline responsible for the model.")]
[Input("client", "Unique identifier for the client.")]
[Input("designStage", "The design stage for the project.")]
[Input("projectLead", "The project leader for the project.")]
[Input("revision", "The revision for the model.")]
[Input("author", "The model author/creator.")]
[Input("creationDate", "The creation date of the model inputted as yyyy-MM-dd. This will default to the current date if no date is provided.")]
[Input("email", "Contact email for the project.")]
[Input("description", "Brief description for the project and the model.")]
[Input("discipline", "The discipline responsible for the model.")]
[Input("reviews", "A list of reviews containing reviewers, their comments and the date of review.")]
[Output("A summary of relevant information for the model.")]
public static Metadata Metadata(string projectNumber = "", string projectName = "", string location = "", string client = "",
Expand Down

0 comments on commit d51aee1

Please sign in to comment.