protocols.hpp

/*
Author: Nels Frazier
Copyright (C) 2025 Lynker
------------------------------------------------------------------------
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
------------------------------------------------------------------------
Version 0.2.1
Fix NgenBmiProtocols constructor to initialize protocols map when model is null
Fix run() to return the expected<void, ProtocolError> returned by the wrapped call
 
Version 0.2
Enumerate protocol types/names
The container now holds a single model pointer and passes it to each protocol
per the updated (v0.2) protocol interface
Keep protocols in a map for dynamic access by enumeration name
add operator<< for Protocol enum
 
Version 0.1
Container and management for abstract BMI protocols
*/
#pragma once
 
#include "protocol.hpp"
#include <nonstd/expected.hpp>
#include <unordered_map>
 
namespace models {
namespace bmi {
namespace protocols {
 
enum class Protocol { MASS_BALANCE, SERIALIZATION, DESERIALIZATION };
 
auto operator<<(std::ostream& os, Protocol p) -> std::ostream&;
 
class NgenBmiProtocols {
  public:
    NgenBmiProtocols();
 
    NgenBmiProtocols(
        std::shared_ptr<models::bmi::Bmi_Adapter> model,
        const geojson::PropertyMap& properties
    );
 
    auto run(const Protocol& protocol_name, const Context& ctx) const
        -> expected<void, ProtocolError>;
 
  private:
    std::shared_ptr<models::bmi::Bmi_Adapter> model;
    std::unordered_map<Protocol, std::unique_ptr<NgenBmiProtocol>> protocols;
};
 
} // namespace protocols
} // namespace bmi
} // namespace models