Return metadata for underlying collections when generating plots

[Tom-Kingstone]

NOTE: Depends on

Issues addressed by this PR

Closes #217
Closes #219
Closes #221
Closes #222
Closes #228

Added metadata gathering methods that provide various important data for an underlying collection/object, and created oM objects that reflect the python metadata dictionaries, along with convert methods in the adapter.

Also fixed an issue where prevailing() did not return the correct wind direction due to calm wind speeds not being incorrectly taken into account.

relevant objects have attribute NoAutoConstructor, as they should not be created by anything other than the adapter.

Test files

TestPlotCommands.zip
Test each of the commands, vary inputs to

Changelog

• Updated plot Execute methods to return PlotInformation instead of a string for the following commands:
  • HeatPlotCommand
  • WindroseCommand
  • UTCIHeatPlotCommand
  • DiurnalPlotCommand
  • SunPathPlotCommand

Additional comments

The solar optimisation method will not be being updated like this, as there are about to be changes to the underlying methods, so they will be done afterwards.

[CKBoulter]

Tested using provided testing file. Successful. Approved!

[Tom-Kingstone]

@BHoMBot check core
@BHoMBot check compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check core
• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[bhombot-ci]

@Tom-Kingstone fix requested for copyright headers.

The errors with the copyright headers on the CS (.cs) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

Each CS (.cs) file that does not have the current copyright header will have it applied. The current copyright header can be examined here.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix copyright headers ref. 27271951370

[Tom-Kingstone]

@BHoMBot fix copyright headers ref. 27271951370

[bhombot-ci]

@Tom-Kingstone I have queued up your request to fix copyright headers. There are 0 requests in the queue ahead of you.

[bhombot-ci]

@Tom-Kingstone I am now going to fix the copyright compliance in accordance with the annotations previously made.

[bhombot-ci]

@Tom-Kingstone to confirm I have now resolved the copyright compliance and pushed a commit to this Pull Request.

[Tom-Kingstone]

@BHoMBot check core
@BHoMBot check compliance

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check core
• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[Tom-Kingstone]

@BHoMBot check versioning

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check versioning

There are 8 requests in the queue ahead of you.

[Tom-Kingstone]

@BHoMBot check versioning

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check versioning

[jamesramsden-bh]

Code reviewed and tested with supplied test script. A few minor bugs now addressed as per commit history, now all fine.

[jamesramsden-bh]

@BHoMBot check required

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[jamesramsden-bh]

@BHoMBot check compliance

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[jamesramsden-bh]

@BHoMBot check unit-tests

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check unit-tests

[jamesramsden-bh]

@BHoMBot check ready-to-merge

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check ready-to-merge

[jamesramsden-bh]

@BHoMBot check required

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[Tom-Kingstone]

@BHoMBot check compliance
@BHoMBot check unit-tests

[bhombot-ci]

@Tom-Kingstone to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance
• check unit-tests

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[jamesramsden-bh]

Fixes have now been tested and working.

[jamesramsden-bh]

@BHoMBot check ready-to-merge

[bhombot-ci]

@jamesramsden-bh to confirm, the following actions are now queued:

• check ready-to-merge