OpenPRA Documentation

scram::xml::detail::Indenter ​

Manages XML element indentation upon output. More...

#include <xml_stream.h>

Public Classes ​

Name
classIndentation <br>RAII class to manage the current indentation string.

Public Functions ​

Name
Indenter(bool indent =true)<br>Initializes the buffer with enough space characters.
Indentationoperator()(int num_chars)

Detailed Description ​

cpp
class scram::xml::detail::Indenter;

Manages XML element indentation upon output.

Note: The indentation is bounded by kMaxIndent. If indentation exceeds kMaxIndent, only kMaxIndent indentation will be produced w/o error.

Precondition: Indenter instance is not shared between XML Streams.

Public Functions Documentation ​

function Indenter ​

cpp
inline explicit Indenter(
    bool indent =true
)

Initializes the buffer with enough space characters.

Parameters:

  • indent Enable/disable indentation.

function operator() ​

cpp
inline Indentation operator()(
    int num_chars
)

Parameters:

  • num_chars The number of indentation characters.

Return: Indentation to produce the representative string.

Updated on 2025-11-11 at 16:51:08 +0000