parameter.h

// Copyright 2018-2019 Delft University of Technology
//
// 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.
 
#pragma once
 
#include <vector>
#include <string>
#include <memory>
 
#include "cerata/node.h"
 
namespace cerata {
class Parameter : public NormalNode {
 public:
  Parameter(std::string name, const std::shared_ptr<Type> &type, std::shared_ptr<Literal> default_value);
  std::shared_ptr<Object> Copy() const override;
  Node *value() const;
  Parameter *SetValue(const std::shared_ptr<Node> &value);
  void TraceValue(std::vector<Node *> *trace);
  Literal *default_value() { return default_value_.get(); }
 
  // TODO(johanpel): Work-around for parameters nodes that are size nodes of arrays.
  //  To prevent this, it requires a restructuring of node arrays.
  std::optional<NodeArray *> node_array_parent;
 
  std::shared_ptr<Literal> default_value_;
};
 
std::shared_ptr<Parameter> parameter(const std::string &name,
                                     const std::shared_ptr<Type> &type,
                                     std::shared_ptr<Literal> default_value = nullptr);
 
std::shared_ptr<Parameter> parameter(const std::string &name, int default_value);
 
std::shared_ptr<Parameter> parameter(const std::string &name);
 
std::shared_ptr<Parameter> parameter(const std::string &name, bool default_value);
 
std::shared_ptr<Parameter> parameter(const std::string &name, std::string default_value);
 
}  // namespace cerata