Rename Renderer to AuthoringRenderer

Reduces ambiguity

Author: rsjbailey

include/adm/elements/authoring_information.hpp

@@ -67,24 +67,25 @@ namespace adm {
    * @brief Class representation of the renderer sub-element of an
    * authoringInformation element (BS.2076-3 Tables A1-52 / A1-53).
    */
-  class Renderer : private detail::RendererBase,
-                   private detail::AddWrapperMethods<Renderer> {
+  class AuthoringRenderer
+      : private detail::RendererBase,
+        private detail::AddWrapperMethods<AuthoringRenderer> {
    public:
     using tag = RendererTag;
 
     template <typename... Parameters>
-    explicit Renderer(RendererUri uri, Parameters... namedArgs) {
+    explicit AuthoringRenderer(RendererUri uri, Parameters... namedArgs) {
       this->set(std::move(uri));
       detail::setNamedOptionHelper(this, std::move(namedArgs)...);
     }
 
     using detail::RendererBase::add;
     using detail::RendererBase::remove;
     using detail::RendererBase::set;
-    using detail::AddWrapperMethods<Renderer>::get;
-    using detail::AddWrapperMethods<Renderer>::has;
-    using detail::AddWrapperMethods<Renderer>::isDefault;
-    using detail::AddWrapperMethods<Renderer>::unset;
+    using detail::AddWrapperMethods<AuthoringRenderer>::get;
+    using detail::AddWrapperMethods<AuthoringRenderer>::has;
+    using detail::AddWrapperMethods<AuthoringRenderer>::isDefault;
+    using detail::AddWrapperMethods<AuthoringRenderer>::unset;
 
     /// @brief Convert to LoudnessRenderer preserving all shared parameters.
     ADM_EXPORT LoudnessRenderer toLoudnessRenderer() const;
@@ -97,12 +98,13 @@ namespace adm {
     using detail::RendererBase::isDefault;
     using detail::RendererBase::unset;
 
-    friend class detail::AddWrapperMethods<Renderer>;
+    friend class detail::AddWrapperMethods<AuthoringRenderer>;
   };
 
-  ADD_TRAIT(Renderer, RendererTag);
+  ADD_TRAIT(AuthoringRenderer, RendererTag);
 
-  inline bool operator==(const Renderer &a, const Renderer &b) {
+  inline bool operator==(const AuthoringRenderer &a,
+                         const AuthoringRenderer &b) {
     if (!detail::optionalsEqual<RendererUri, RendererName, RendererVersion,
                                 CoordinateMode>(a, b)) {
       return false;
@@ -120,12 +122,13 @@ namespace adm {
     return a.get<RendererPackFormatIdRefs>() ==
            b.get<RendererPackFormatIdRefs>();
   }
-  inline bool operator!=(const Renderer &a, const Renderer &b) {
+  inline bool operator!=(const AuthoringRenderer &a,
+                         const AuthoringRenderer &b) {
     return !(a == b);
   }
 
   /// @brief Vector of Renderer
-  using Renderers = std::vector<Renderer>;
+  using Renderers = std::vector<AuthoringRenderer>;
   ADD_TRAIT(Renderers, RenderersTag);
 
   /// @brief Tag for AuthoringInformation class

include/adm/elements/loudness_metadata.hpp

@@ -12,7 +12,7 @@
 
 namespace adm {
 
-  class Renderer;
+  class AuthoringRenderer;
 
   /// @brief Tag for NamedType ::LoudnessMethod
   struct loudnessMethodTag {};
@@ -121,7 +121,7 @@ namespace adm {
     /// @brief LoudnessRenderer setter
     ADM_EXPORT void set(LoudnessRenderer renderer);
     /// @brief Renderer setter (converted to LoudnessRenderer)
-    ADM_EXPORT void set(Renderer renderer);
+    ADM_EXPORT void set(AuthoringRenderer renderer);
 
     /**
      * @brief ADM parameter unset template

include/adm/elements/loudness_renderer.hpp

@@ -10,7 +10,7 @@
 
 namespace adm {
 
-  class Renderer;
+  class AuthoringRenderer;
 
   /// @brief Tag for LoudnessRenderer class
   struct LoudnessRendererTag {};
@@ -59,11 +59,13 @@ namespace adm {
     using detail::AddWrapperMethods<LoudnessRenderer>::unset;
 
     /// @brief Create a LoudnessRenderer from an authoring Renderer.
-    ADM_EXPORT static LoudnessRenderer fromRenderer(Renderer const& renderer);
+    ADM_EXPORT static LoudnessRenderer fromRenderer(
+        AuthoringRenderer const& renderer);
 
     /// @brief Convert to Renderer, using provided uri and explicitly dropping audioObjectIDRef values.
     /// uri is required as it is optional in a Loudness renderer but required in authoring renderer
-    ADM_EXPORT Renderer toRendererDroppingObjectRefs(RendererUri uri) const;
+    ADM_EXPORT AuthoringRenderer
+    toRendererDroppingObjectRefs(RendererUri uri) const;
 
     ADM_EXPORT void print(std::ostream& os) const;
 

include/adm/elements_fwd.hpp

@@ -48,7 +48,7 @@ namespace adm {
 
   class LoudnessMetadata;
   class LoudnessRenderer;
-  class Renderer;
+  class AuthoringRenderer;
   class AuthoringInformation;
   class AudioProgrammeReferenceScreen;
 }  // namespace adm

include/adm/private/document_parser.hpp

@@ -45,7 +45,7 @@ namespace adm {
     LoudnessMetadatas parseLoudnessMetadatas(const std::vector<NodePtr>& nodes);
     AudioProgrammeReferenceScreen parseAudioProgrammeReferenceScreen(
         NodePtr node);
-    Renderer parseRenderer(NodePtr node);
+    AuthoringRenderer parseAuthoringRenderer(NodePtr node);
     AuthoringInformation parseAuthoringInformation(NodePtr node);
     Label parseLabel(NodePtr node);
     AudioBlockFormatObjects parseAudioBlockFormatObjects(

src/document.cpp

@@ -149,7 +149,7 @@ namespace adm {
         bool renderersChanged = false;
         for (auto& renderer : renderers) {
           renderersChanged |=
-              pruneRendererRefs<Renderer, RendererPackFormatIdRefs>(
+              pruneRendererRefs<AuthoringRenderer, RendererPackFormatIdRefs>(
                   renderer,
                   removedPackFormat);
         }

src/elements/authoring_information.cpp

@@ -3,11 +3,11 @@
 
 namespace adm {
 
-  LoudnessRenderer Renderer::toLoudnessRenderer() const {
+  LoudnessRenderer AuthoringRenderer::toLoudnessRenderer() const {
     return LoudnessRenderer::fromRenderer(*this);
   }
 
-  void Renderer::print(std::ostream& os) const {
+  void AuthoringRenderer::print(std::ostream& os) const {
     os << "(";
     bool first = true;
     auto sep = [&]() {

src/elements/loudness_metadata.cpp

@@ -121,7 +121,7 @@ namespace adm {
   void LoudnessMetadata::set(LoudnessRenderer renderer) {
     renderer_ = std::move(renderer);
   }
-  void LoudnessMetadata::set(Renderer renderer) {
+  void LoudnessMetadata::set(AuthoringRenderer renderer) {
     renderer_ = renderer.toLoudnessRenderer();
   }
 

src/elements/loudness_renderer.cpp

@@ -3,7 +3,8 @@
 
 namespace adm {
 
-  LoudnessRenderer LoudnessRenderer::fromRenderer(Renderer const& renderer) {
+  LoudnessRenderer LoudnessRenderer::fromRenderer(
+      AuthoringRenderer const& renderer) {
     LoudnessRenderer loudnessRenderer;
     if (renderer.has<RendererUri>()) {
       loudnessRenderer.set(renderer.get<RendererUri>());
@@ -23,9 +24,9 @@ namespace adm {
     return loudnessRenderer;
   }
 
-  Renderer LoudnessRenderer::toRendererDroppingObjectRefs(
+  AuthoringRenderer LoudnessRenderer::toRendererDroppingObjectRefs(
       RendererUri uri) const {
-    Renderer renderer{std::move(uri)};
+    AuthoringRenderer renderer{std::move(uri)};
     if (has<RendererUri>()) {
       renderer.set(get<RendererUri>());
     }

src/private/document_parser.cpp

@@ -1403,9 +1403,9 @@ namespace adm {
       return screen;
     }
 
-    Renderer parseRenderer(NodePtr node) {
+    AuthoringRenderer parseAuthoringRenderer(NodePtr node) {
       auto uri = parseAttribute<RendererUri>(node, "uri");
-      Renderer renderer{uri};
+      AuthoringRenderer renderer{uri};
       setRendererCommonParameters(node, renderer);
       return renderer;
     }
@@ -1414,7 +1414,7 @@ namespace adm {
       AuthoringInformation info;
       Renderers renderers;
       for (auto& rendererNode : detail::findElements(node, "renderer")) {
-        renderers.push_back(parseRenderer(rendererNode));
+        renderers.push_back(parseAuthoringRenderer(rendererNode));
       }
       if (!renderers.empty()) {
         info.set(std::move(renderers));