open_scenario.hpp

Go to the documentation of this file.

// Copyright 2015 TIER IV, Inc. All rights reserved.
//
// 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.
 
#ifndef OPENSCENARIO_INTERPRETER__SYNTAX__OPEN_SCENARIO_HPP_
#define OPENSCENARIO_INTERPRETER__SYNTAX__OPEN_SCENARIO_HPP_
 
#include <boost/json.hpp>
#include <filesystem>
#include <openscenario_interpreter/scope.hpp>
#include <openscenario_interpreter/syntax/file_header.hpp>
#include <openscenario_interpreter/syntax/open_scenario_category.hpp>
#include <pugixml.hpp>
 
namespace openscenario_interpreter
{
inline namespace syntax
{
/* ---- OpenScenario -----------------------------------------------------------
 *
 *  <xsd:complexType name="OpenScenario">
 *    <xsd:sequence>
 *      <xsd:element name="FileHeader" type="FileHeader"/>
 *      <xsd:group ref="OpenScenarioCategory"/>
 *    </xsd:sequence>
 *  </xsd:complexType>
 *
 * -------------------------------------------------------------------------- */
struct OpenScenario : public Scope
{
  const std::filesystem::path pathname;  // for substitution syntax '$(dirname)'
 
  pugi::xml_document script;
 
  const FileHeader file_header;
 
  const OpenScenarioCategory category;
 
  std::size_t frame = 0;
 
  explicit OpenScenario(const std::filesystem::path &);
 
  auto evaluate() -> Object;
 
  auto load(const std::filesystem::path &) -> const pugi::xml_node &;
};
 
auto operator<<(boost::json::object &, const OpenScenario &) -> boost::json::object &;
}  // namespace syntax
}  // namespace openscenario_interpreter
 
#endif  // OPENSCENARIO_INTERPRETER__SYNTAX__OPEN_SCENARIO_HPP_