active::serialise::xml::XMLProlog Class Reference

#include <XMLProlog.h>

Inheritance diagram for active::serialise::xml::XMLProlog:

Collaboration diagram for active::serialise::xml::XMLProlog:

Public Member Functions
virtual bool	fillInventory (Inventory &inventory) const override
virtual Cargo::Unique	getCargo (const Inventory::Item &item) const override
virtual void	setDefault () override
Public Member Functions inherited from active::serialise::Package
bool	isRoot () const
virtual bool	isAttributeFirst () const
virtual bool	insert (Cargo::Unique &&cargo, const Inventory::Item &item)
virtual bool	read (const utility::String &source)
void	setRoot (bool state)
virtual bool	finaliseAttributes ()
Public Member Functions inherited from active::serialise::Cargo
	Cargo ()
	Cargo (const Cargo &source)
virtual	~Cargo ()=default
virtual void	clear ()
virtual bool	validate ()

Public Attributes
utility::String	version = "1.0"
	XML version.
utility::TextEncoding	encoding = utility::TextEncoding::UTF8
	Text encoding type.

Static Public Attributes
static utility::String	tag = "xml"
	The prolog tag.

Additional Inherited Members
Public Types inherited from active::serialise::Package
using	Unique = std::unique_ptr<Package>
	Unique pointer.
using	Shared = std::shared_ptr<Package>
	Shared pointer.
Public Types inherited from active::serialise::Cargo
using	Unique = std::unique_ptr<Cargo>
	Unique pointer.
using	Shared = std::shared_ptr<Cargo>
	Shared pointer.
using	size_type = std::string::size_type
	Class size type.
using	sizeOption = std::optional<size_type>
	Optional size type (used to indicate an unspecified or non-existant position)

Detailed Description

XML prolog class

Used at the head of XML content to establish content standards, e.g. version and encoding

Member Function Documentation

fillInventory()

bool XMLProlog::fillInventory ( Inventory & inventory ) const

overridevirtual

Fill an inventory with the package items

Parameters

inventory

The inventory to receive the package items

Returns

True if the package has added items to the inventory

Implements active::serialise::Cargo.

Here is the call graph for this function:

getCargo()

Cargo::Unique XMLProlog::getCargo ( const Inventory::Item & item ) const

overridevirtual

Get the specified cargo

Parameters

item	The inventory item to retrieve

Returns

The requested cargo (nullptr on failure)

Implements active::serialise::Cargo.

setDefault()

void XMLProlog::setDefault ( )

overridevirtual

Set to the default package content

Reimplemented from active::serialise::Package.

---

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

• /Users/rwessel/Documents/Development/ActiveLib/Active/Serialise/XML/Package/XMLProlog.h
• /Users/rwessel/Documents/Development/ActiveLib/Active/Serialise/XML/Package/XMLProlog.cpp