domain.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 <memory>
#include <string>
#include <utility>
 
#include "cerata/utils.h"
 
namespace cerata {
 
class Node;
 
struct ClockDomain : public Named {
  explicit ClockDomain(std::string name);
  static std::shared_ptr<ClockDomain> Make(const std::string &name) { return std::make_shared<ClockDomain>(name); }
  // TODO(johanpel): add other properties
};
 
std::shared_ptr<ClockDomain> default_domain();
 
class Synchronous {
 public:
  explicit Synchronous(std::shared_ptr<ClockDomain> domain) : domain_(std::move(domain)) {}
  [[nodiscard]] std::shared_ptr<ClockDomain> domain() const { return domain_; }
  void SetDomain(std::shared_ptr<ClockDomain> domain) { domain_ = std::move(domain); }
 protected:
  std::shared_ptr<ClockDomain> domain_;
};
 
std::optional<std::shared_ptr<ClockDomain>> GetDomain(const Node& node);
 
}  // namespace cerata