XmlElement Class Reference

Class representing a node in an XML document. More...

#include "libxml_wrapper.h"

Public Member Functions
	XmlElement (xmlNodePtr node)
	Constructor for XmlElement.
	XmlElement (const XmlElement &)=default
	XmlElement (XmlElement &&) noexcept=default
XmlElement &	operator= (const XmlElement &)=default
XmlElement &	operator= (XmlElement &&) noexcept=default
	~XmlElement ()=default
std::string	name () const
	Get the name of the XML element.
std::string	getText () const
	Get the text content of the XML element.
void	setText (const std::string_view text) const
	Set the text content of the XML element.
void	setAttribute (const std::string_view name, const std::string_view value) const
	Set an attribute on the XML element.
XmlElement	addChild (const std::string_view name) const
	Add a child element to the current node.
XmlElement	childElement (const std::string_view name="", const unsigned index=0) const noexcept
	Retrieve a child element by name and index.
bool	isValid () const noexcept
	Check if the XML element is valid.
xmlNodePtr	getNode () const noexcept
	Get the underlying XML node pointer.

Static Public Member Functions
static XmlElement	create (const std::string_view name)
	Create a new XML element by name.
static std::string	getSafeAttribute (const XmlElement &element, const std::string_view name)
	Get the value of an attribute safely.
static std::optional< std::string >	getOptionalAttribute (const XmlElement &element, const std::string_view name)
	Get the value of an optional attribute.

Detailed Description

Class representing a node in an XML document.

This class encapsulates an XML element, allowing users to access and manipulate element names, attributes, content, and children. It uses libxml2 for all operations and provides simplified methods to interact with XML nodes.

Definition at line 152 of file libxml_wrapper.h.

Constructor & Destructor Documentation

XmlElement() [1/3]

XmlElement::XmlElement ( xmlNodePtr  node )

explicit

Constructor for XmlElement.

Parameters

node	The xmlNode pointer representing the XML element.

Definition at line 162 of file libxml_wrapper.h.

: _node(node) {}

XmlElement() [2/3]

XmlElement::XmlElement ( const XmlElement &  )

default

XmlElement() [3/3]

XmlElement::XmlElement ( XmlElement &&  )

defaultnoexcept

~XmlElement()

XmlElement::~XmlElement ( )

default

Member Function Documentation

addChild()

XmlElement XmlElement::addChild

(

const std::string_view

name

)

const

Add a child element to the current node.

Parameters

name	The name of the new child element.

Returns

The newly created XmlElement.

Definition at line 286 of file libxml_wrapper.h.

    {
        xmlNodePtr child = xml_detail::createNode(name);
        xmlAddChild(_node, child);
        return XmlElement(child);
    }

References xml_detail::createNode(), max, and name().

Here is the call graph for this function:

childElement()

XmlElement XmlElement::childElement ( const std::string_view  name = "", const unsigned  index = 0  ) const

noexcept

Retrieve a child element by name and index.

Parameters

name	The name of the child element (optional).
index	The index of the child to retrieve.

Returns

The child element or an invalid XmlElement if not found.

Definition at line 300 of file libxml_wrapper.h.

    {
        if (_node == nullptr)
        {
            return XmlElement(nullptr);
        }
        unsigned count = 0;
        for (auto* child = _node->children; child != nullptr; child = child->next)
        {
            if (child->type == XML_ELEMENT_NODE && (name.empty() || xml_detail::equals(child->name, name)))
            {
                if (count == index)
                {
                    return XmlElement(child);
                }
                ++count;
            }
        }
        return XmlElement(nullptr);
    }

References xml_detail::equals(), max, and name().

Referenced by serial::xml_parser_utils::parseCoordinateSystemParameter(), serial::xml_parser_utils::parseOptionalNumericParameters(), serial::xml_parser_utils::parseOriginParameter(), serial::xml_parser_utils::parseRotationAngleUnit(), serial::xml_parser_utils::parseWaveform(), serial::xml_parser_utils::setOptionalRealParameter(), and serial::xml_parser_utils::setOptionalUnsignedParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

static XmlElement XmlElement::create ( const std::string_view  name )

static

Create a new XML element by name.

Parameters

name	The name of the XML element.

Returns

The newly created XML element.

Definition at line 187 of file libxml_wrapper.h.

    {
        return XmlElement(xml_detail::createNode(name));
    }

References xml_detail::createNode(), and name().

Referenced by serial::world_to_xml_string().

Here is the call graph for this function:

Here is the caller graph for this function:

getNode()

xmlNodePtr XmlElement::getNode ( ) const

noexcept

Get the underlying XML node pointer.

Returns

The underlying XML node pointer.

Definition at line 333 of file libxml_wrapper.h.

{ return _node; }

getOptionalAttribute()

static std::optional< std::string > XmlElement::getOptionalAttribute ( const XmlElement &  element, const std::string_view  name  )

static

Get the value of an optional attribute.

Parameters

element	The XmlElement to retrieve the attribute from.
name	The name of the attribute.

Returns

The attribute value if present.

Definition at line 251 of file libxml_wrapper.h.

    {
        if (!element.isValid())
        {
            return std::nullopt;
        }
        const xml_detail::XmlCharBuffer xml_name(name);
        if (xmlChar* attr = xmlGetProp(element.getNode(), xml_name.c_str()))
        {
            std::string value = xml_detail::toString(attr);
            xmlFree(attr);
            return value;
        }
        return std::nullopt;
    }

References max, name(), and xml_detail::toString().

Referenced by serial::xml_parser_utils::get_attribute_bool(), serial::xml_parser_utils::parseMotionPath(), and serial::xml_parser_utils::parseOriginParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

getSafeAttribute()

static std::string XmlElement::getSafeAttribute ( const XmlElement &  element, const std::string_view  name  )

static

Get the value of an attribute safely.

Parameters

element	The XmlElement to retrieve the attribute from.
name	The name of the attribute.

Returns

The value of the attribute.

Exceptions

XmlException

if the attribute is not found.

Definition at line 228 of file libxml_wrapper.h.

    {
        std::string value;
        const xml_detail::XmlCharBuffer xml_name(name);
        if (xmlChar* attr = xmlGetProp(element.getNode(), xml_name.c_str()))
        {
            value = xml_detail::toString(attr);
            xmlFree(attr);
        }
        else
        {
            throw XmlException("Attribute not found: " + std::string(name));
        }
        return value;
    }

References max, name(), and xml_detail::toString().

Referenced by serial::xml_parser_utils::parseAntenna(), serial::xml_parser_utils::parseCoordinateSystemParameter(), serial::xml_parser_utils::parseMonostatic(), serial::xml_parser_utils::parseOriginParameter(), serial::xml_parser_utils::parsePlatform(), serial::xml_parser_utils::parseReceiver(), serial::xml_parser_utils::parseReceiverWithMode(), serial::xml_parser_utils::parseRotationPath(), serial::xml_parser_utils::parseSchedule(), serial::xml_parser_utils::parseTarget(), serial::xml_parser_utils::parseTiming(), serial::xml_parser_utils::parseTransmitter(), serial::xml_parser_utils::parseTransmitterWithMode(), serial::xml_parser_utils::parseUtmCoordinateSystem(), serial::xml_parser_utils::parseWaveform(), serial::xml_parser_utils::processParsedDocument(), and serial::xml_parser_utils::resolve_reference_id().

Here is the call graph for this function:

Here is the caller graph for this function:

getText()

std::string XmlElement::getText

(

)

const

Get the text content of the XML element.

Returns

The text content as a string.

Definition at line 197 of file libxml_wrapper.h.

    {
        if (_node == nullptr)
        {
            return "";
        }
        xmlChar* text = xmlNodeGetContent(_node);
        std::string result = xml_detail::toString(text);
        xmlFree(text);
        return result;
    }

References max, and xml_detail::toString().

Referenced by serial::xml_parser_utils::parseRotationAngleUnit().

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

bool XmlElement::isValid ( ) const

noexcept

Check if the XML element is valid.

Returns

True if the node is valid, otherwise false.

Definition at line 326 of file libxml_wrapper.h.

{ return _node != nullptr; }

Referenced by serial::xml_parser_utils::parseOptionalNumericParameters(), serial::xml_parser_utils::parseWaveform(), serial::xml_parser_utils::setOptionalRealParameter(), and serial::xml_parser_utils::setOptionalUnsignedParameter().

Here is the caller graph for this function:

name()

std::string XmlElement::name

(

)

const

Get the name of the XML element.

Returns

The name of the XML element.

Definition at line 179 of file libxml_wrapper.h.

{ return _node == nullptr ? "" : xml_detail::toString(_node->name); }

References xml_detail::toString().

Referenced by addChild(), childElement(), create(), getOptionalAttribute(), getSafeAttribute(), and setAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

XmlElement & XmlElement::operator= ( const XmlElement &  )

default

operator=() [2/2]

XmlElement & XmlElement::operator= ( XmlElement &&  )

defaultnoexcept

setAttribute()

void XmlElement::setAttribute	(	const std::string_view	name,
		const std::string_view	value
	)		const

Set an attribute on the XML element.

Parameters

name	The name of the attribute.
value	The value to set for the attribute.

Definition at line 273 of file libxml_wrapper.h.

    {
        const xml_detail::XmlCharBuffer xml_name(name);
        const xml_detail::XmlCharBuffer xml_value(value);
        xmlSetProp(_node, xml_name.c_str(), xml_value.c_str());
    }

References max, and name().

Referenced by serial::xml_serializer_utils::serializeWaveform().

Here is the call graph for this function:

Here is the caller graph for this function:

setText()

void XmlElement::setText

(

const std::string_view

text

)

const

Set the text content of the XML element.

Parameters

text	The text to set as the content of the node.

Definition at line 214 of file libxml_wrapper.h.

    {
        const xml_detail::XmlCharBuffer xml_text(text);
        xmlNodeSetContentLen(_node, xml_text.c_str(), xml_text.contentLength());
    }

References max.

---

The documentation for this class was generated from the following file:

• packages/libfers/src/serial/libxml_wrapper.h