4.5 sdds::LayoutEditor

• name:
  sdds::LayoutEditor
• description:
  Copy an existing layout and rename, drop, replace, or add parameter, array, column, and associate definitions. Data is not transformed by the editor; page transformations must be made separately.
• synopsis:
  explicit sdds::LayoutEditor(sdds::Layout layout);  
  LayoutEditor &renameParameter(std::string_view name, std::string newName);  
  LayoutEditor &renameArray(std::string_view name, std::string newName);  
  LayoutEditor &renameColumn(std::string_view name, std::string newName);  
  LayoutEditor &renameAssociate(std::string_view name, std::string newName);  
  LayoutEditor &dropParameter(std::string_view name);  
  LayoutEditor &dropArray(std::string_view name);  
  LayoutEditor &dropColumn(std::string_view name);  
  LayoutEditor &dropAssociate(std::string_view name);  
  LayoutEditor &replaceParameter(std::string_view name,  
                                 sdds::ParameterDefinition definition);  
  LayoutEditor &replaceArray(std::string_view name,  
                             sdds::ArrayDefinition definition);  
  LayoutEditor &replaceColumn(std::string_view name,  
                              sdds::ColumnDefinition definition);  
  LayoutEditor &replaceAssociate(std::string_view name,  
                                 sdds::AssociateDefinition definition);  
  LayoutEditor &addParameter(sdds::ParameterDefinition definition);  
  LayoutEditor &addArray(sdds::ArrayDefinition definition);  
  LayoutEditor &addColumn(sdds::ColumnDefinition definition);  
  LayoutEditor &addAssociate(sdds::AssociateDefinition definition);  
  const sdds::Layout &layout() const noexcept;  
  sdds::Layout build() const;

• arguments:
  • name — Existing definition name.
  • newName — Replacement name.
  • definition — New or replacement definition.
• return value:
  Editing methods return the editor for chaining. layout returns the working layout and build returns a validated copy.
• exceptions:
  An sdds::Error-derived exception if a source definition is absent or the resulting layout is invalid.
• see also:
  Sections 4.4 and 4.22.