[Developer] Adjust alfalfa_utility #5259
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,9 @@ | ||
| #include "AlfalfaComponent.hpp" | ||
|
|
||
| namespace openstudio { | ||
| namespace alfalfa { | ||
|
|
||
| AlfalfaComponent::AlfalfaComponent(const std::string& type, Capability capabilities) : type(type), capabilities(capabilities) {} | ||
|
There was a problem hiding this comment. this is fair, since it's just a uint under the hood There was a problem hiding this comment. yes, it's a POD type [1] that'll fit in a register. I tried adding a clang-tidy check for that in LLVM (and someone else did independently) but it never got in. [1] This may be an unsigned int, and it is on GCC for eg (cf https://gcc.godbolt.org/z/47z5z3bP8), but it's actually implementation defined per the cpp standards. |
||
|
|
||
| bool AlfalfaComponent::canInput() const { | ||
| return capabilities & Capability::Input; | ||
|
|
@@ -15,7 +14,7 @@ namespace alfalfa { | |
| } | ||
|
|
||
| bool AlfalfaComponent::operator==(const AlfalfaComponent& rhs) const { | ||
| return (type == rhs.type) && (capabilities == rhs.capabilities) && (parameters == rhs.parameters); | ||
| } | ||
|
|
||
| } // namespace alfalfa | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,6 @@ | |
| #define ALFALFA_COMPONENT_CONSTANT_HPP | ||
|
|
||
| #include "AlfalfaComponent.hpp" | ||
|
|
||
| #include "../UtilitiesAPI.hpp" | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,15 +4,21 @@ | |
| #include <boost/regex.hpp> | ||
| #include <fmt/format.h> | ||
|
|
||
| #include <memory> | ||
| #include <string_view> | ||
|
|
||
| namespace openstudio { | ||
| namespace alfalfa { | ||
|
|
||
| static constexpr std::string_view ID_VALID_CHARS_MSG = "IDs can only contain letters, numbers, and the following special characters _-[]():"; | ||
|
There was a problem hiding this comment. That makes sense to move this out of the class. Let me make sure I'm understanding this correctly. The purpose of using a There was a problem hiding this comment. this is a global static constexpr variable. I could omit the And so it initializes it in static storage (the see this short example: https://gcc.godbolt.org/z/o7veTMETP and if you want to learn more about constexpr, I suggest C++ weekly, the start of this episode maybe: https://www.youtube.com/watch?v=IDQ0ng8RIqs |
||
|
|
||
| namespace detail { | ||
| AlfalfaPoint_Impl::AlfalfaPoint_Impl() = default; | ||
| } // namespace detail | ||
|
|
||
| AlfalfaPoint::AlfalfaPoint() : m_impl(std::make_shared<detail::AlfalfaPoint_Impl>()) {} | ||
|
|
||
| AlfalfaPoint::AlfalfaPoint(const std::string& display_name) : m_impl(std::make_shared<detail::AlfalfaPoint_Impl>()) { | ||
| setDisplayName(display_name); | ||
| } | ||
|
|
||
|
|
@@ -65,7 +71,7 @@ namespace alfalfa { | |
| if (isValidId(id)) { | ||
| m_impl->m_id = id; | ||
| } else { | ||
| throw std::runtime_error(ID_VALID_CHARS_MSG.data()); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -74,7 +80,7 @@ namespace alfalfa { | |
| } | ||
|
|
||
| void AlfalfaPoint::setDisplayName(const std::string& display_name) { | ||
| if (display_name.empty()) { | ||
| throw std::runtime_error("Display name must have non-zero length"); | ||
| } | ||
| m_impl->m_display_name = display_name; | ||
|
|
@@ -97,36 +103,36 @@ namespace alfalfa { | |
| Json::Value AlfalfaPoint::toJSON() const { | ||
| Json::Value point; | ||
|
|
||
| if (auto id_ = id()) { | ||
|
There was a problem hiding this comment. oh cool, I didn't realize you can do assignment in the if There was a problem hiding this comment. boost::optional has an FYI, C++17 added init-statement to
|
||
| point["id"] = *id_; | ||
| } else { | ||
| throw std::runtime_error(fmt::format("Point requires a valid ID for export. {}", ID_VALID_CHARS_MSG)); | ||
| } | ||
| point["name"] = displayName(); | ||
| if (auto input_ = input()) { | ||
| point["input"]["type"] = input_->type; | ||
| point["input"]["parameters"] = input_->parameters; | ||
| } | ||
|
|
||
| if (auto output_ = output()) { | ||
| point["output"]["type"] = output_->type; | ||
| point["output"]["parameters"] = output_->parameters; | ||
| } | ||
|
|
||
| if (auto units_ = units()) { | ||
| point["units"] = *units_; | ||
| } | ||
|
|
||
| point["optional"] = optional(); | ||
|
|
||
| return point; | ||
| } | ||
|
|
||
| bool AlfalfaPoint::isValidId(const std::string& id) { | ||
| return !id.empty() && boost::regex_match(id, boost::regex(R"(^[A-Za-z0-9_\-\[\]:()]*$)")); | ||
| } | ||
|
|
||
| std::string AlfalfaPoint::toIdString(const std::string& str) { | ||
| return boost::regex_replace(str, boost::regex(" "), "_"); | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, what is the
json(...)jsona directive to?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing, it's an optional arbitrary string, at most 16 characters long. I like to use it, when this is a json thing I put json, when it's a sql query I put sql... etc.
(technically speaking you could configure your editor to pick that up and apply a different syntax highlighting based on it)
https://en.cppreference.com/w/cpp/language/string_literal