active::serialise::Unknown Class Reference

#include <Unknown.h>

Inheritance diagram for active::serialise::Unknown:

Collaboration diagram for active::serialise::Unknown:

Public Member Functions
virtual bool	fillInventory (Inventory &inventory) const
virtual Cargo::Unique	getCargo (const Inventory::Item &item) const
Public Member Functions inherited from active::serialise::Package
bool	isRoot () const
virtual bool	isAttributeFirst () const
virtual void	setDefault ()
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 ()

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

A package for dealing with unknown/unwanted cargo

Member Function Documentation

fillInventory()

virtual bool active::serialise::Unknown::fillInventory ( Inventory & inventory ) const

inlinevirtual

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.

getCargo()

virtual Cargo::Unique active::serialise::Unknown::getCargo ( const Inventory::Item & item ) const

inlinevirtual

Get the specified cargo

Parameters

item	The inventory item to retrieve

Returns

The requested cargo (nullptr on failure)

Implements active::serialise::Cargo.

---

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

• /Users/rwessel/Documents/Development/ActiveLib/Active/Serialise/Package/Unknown.h