discipline.h

Go to the documentation of this file.

/*
    Philote C++ Bindings
 
    Copyright 2022-2025 Christopher A. Lupp
 
    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.
 
    This work has been cleared for public release, distribution unlimited, case
    number: AFRL-2023-5716.
 
    The views expressed are those of the authors and do not reflect the
    official guidance or position of the United States Government, the
    Department of Defense or of the United States Air Force.
 
    Statement from DoD: The Appearance of external hyperlinks does not
    constitute endorsement by the United States Department of Defense (DoD) of
    the linked websites, of the information, products, or services contained
    therein. The DoD does not exercise any editorial, security, or other
    control over the information you may find at these locations.
*/
#pragma once
 
#include <google/protobuf/struct.pb.h>
 
#include <map>
#include <memory>
#include <variable.h>
 
#include <data.pb.h>
#include <disciplines.grpc.pb.h>
 
namespace philote
{
    // forward declaration
    class DisciplineServer;
 
    class Discipline : public std::enable_shared_from_this<Discipline>
    {
    public:
        Discipline();
 
        ~Discipline() noexcept;
 
        std::map<std::string, std::string> &options_list();
 
        std::vector<philote::VariableMetaData> &var_meta() { return var_meta_; }
        const std::vector<philote::VariableMetaData> &var_meta() const noexcept { return var_meta_; }
 
        std::vector<philote::PartialsMetaData> &partials_meta() { return partials_meta_; }
        const std::vector<philote::PartialsMetaData> &partials_meta() const noexcept { return partials_meta_; }
 
        philote::DisciplineProperties &properties();
 
        philote::StreamOptions &stream_opts() { return stream_opts_; }
        const philote::StreamOptions &stream_opts() const noexcept { return stream_opts_; }
 
        void AddInput(const std::string &name,
                      const std::vector<int64_t> &shape,
                      const std::string &units);
 
        void AddOutput(const std::string &name,
                       const std::vector<int64_t> &shape,
                       const std::string &units);
 
        void DeclarePartials(const std::string &f, const std::string &x);
 
        void AddOption(const std::string &name, const std::string &type);
 
        virtual void Initialize();
 
        virtual void Configure();
 
        virtual void SetOptions(const google::protobuf::Struct &options_struct);
 
        virtual void Setup();
 
        virtual void SetupPartials();
 
        void SetContext(grpc::ServerContext* context) const noexcept;
 
        void ClearContext() const noexcept;
 
        bool IsCancelled() const noexcept;
 
    protected:
        std::vector<int64_t> ComputePartialShape(const std::string &f,
                                                  const std::string &x,
                                                  bool allow_output_as_x);
 
        std::map<std::string, std::string> options_list_;
 
        std::vector<philote::VariableMetaData> var_meta_;
 
        std::vector<philote::PartialsMetaData> partials_meta_;
 
        philote::DisciplineProperties properties_;
 
        philote::StreamOptions stream_opts_;
 
        mutable grpc::ServerContext* current_context_ = nullptr;
    };
 
}