Urho3D::XMLArchiveBase< BlockType, IsInputBool > Class Template Reference
Base archive for XML serialization. More...
#include <Urho3D/Resource/XMLArchive.h>
Inheritance diagram for Urho3D::XMLArchiveBase< BlockType, IsInputBool >:
Public Member Functions | |
Archive implementation | |
| ea::string_view | GetName () const |
| Return name of the archive if applicable. | |
 Public Member Functions inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, true > | |
| bool | IsInput () const final |
| bool | IsHumanReadable () const final |
| bool | IsUnorderedAccessSupportedInCurrentBlock () const final |
| bool | HasElementOrBlock (const char *name) const final |
| ea::string | GetCurrentBlockPath () const final |
| Return current string stack. | |
| void | EndBlock () noexcept override |
| End archive block. May postpone ArchiveException until later. | |
| Public Member Functions inherited from Urho3D::ArchiveBase | |
| Context * | GetContext () final |
| Get context. | |
| unsigned | GetChecksum () override |
| Return a checksum if applicable. | |
| bool | IsEOF () const final |
| Whether the archive can no longer be serialized. | |
| void | Flush () final |
| Flush all pending events. Should be called at least once before destructor. | |
| unsigned | SerializeVersion (unsigned version) final |
| Serialize version number. 0 is invalid version. | |
| ArchiveException | IOFailureException (ea::string_view elementName) const |
| ArchiveException | DuplicateElementException (ea::string_view elementName) const |
| ArchiveException | ElementNotFoundException (ea::string_view elementName) const |
| ArchiveException | ElementNotFoundException (ea::string_view elementName, unsigned elementIndex) const |
| ArchiveException | UnexpectedElementValueException (ea::string_view elementName) const |
| ArchiveException | UnexpectedEOFException (ea::string_view elementName) const |
| Public Member Functions inherited from Urho3D::Archive | |
| virtual void | BeginBlock (const char *name, unsigned &sizeHint, bool safe, ArchiveBlockType type)=0 |
| ArchiveBlock | OpenBlock (const char *name, unsigned sizeHint, bool safe, ArchiveBlockType type) |
| virtual void | Serialize (const char *name, bool &value)=0 |
| virtual void | Serialize (const char *name, signed char &value)=0 |
| virtual void | Serialize (const char *name, unsigned char &value)=0 |
| virtual void | Serialize (const char *name, short &value)=0 |
| virtual void | Serialize (const char *name, unsigned short &value)=0 |
| virtual void | Serialize (const char *name, int &value)=0 |
| virtual void | Serialize (const char *name, unsigned int &value)=0 |
| virtual void | Serialize (const char *name, long long &value)=0 |
| virtual void | Serialize (const char *name, unsigned long long &value)=0 |
| virtual void | Serialize (const char *name, float &value)=0 |
| virtual void | Serialize (const char *name, double &value)=0 |
| virtual void | Serialize (const char *name, ea::string &value)=0 |
| virtual void | SerializeBytes (const char *name, void *bytes, unsigned size)=0 |
| Serialize bytes. Size is not encoded and should be provided externally! | |
| virtual void | SerializeVLE (const char *name, unsigned &value)=0 |
| Serialize Variable Length Encoded unsigned integer, up to 29 significant bits. | |
| ArchiveBlock | OpenSequentialBlock (const char *name) |
| Open Sequential block. Will be automatically closed when returned object is destroyed. | |
| ArchiveBlock | OpenUnorderedBlock (const char *name) |
| Open Unordered block. Will be automatically closed when returned object is destroyed. | |
| ArchiveBlock | OpenArrayBlock (const char *name, unsigned sizeHint=0) |
| Open Array block. Will be automatically closed when returned object is destroyed. | |
| ArchiveBlock | OpenSafeSequentialBlock (const char *name) |
| Open safe Sequential block. Will be automatically closed when returned object is destroyed. | |
| ArchiveBlock | OpenSafeUnorderedBlock (const char *name) |
| Open safe Unordered block. Will be automatically closed when returned object is destroyed. | |
Protected Member Functions | |
| XMLArchiveBase (Context *context, XMLElement element, const XMLFile *xmlFile, bool serializeRootName) | |
| Protected Member Functions inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, true > | |
| Block & | GetCurrentBlock () |
| const Block & | GetCurrentBlock () const |
| void | CheckIfRootBlockOpen () const |
| void | CheckBeforeBlock (const char *elementName) |
| void | CheckBeforeElement (const char *elementName) |
| ArchiveBase (Context *context) | |
| Protected Member Functions inherited from Urho3D::ArchiveBase | |
| ArchiveBase (Context *context) | |
| void | SetDelayedException (std::exception_ptr ptr) |
| void | FlushDelayedException () |
| void | CheckIfNotEOF (ea::string_view elementName) const |
| void | CheckBlockOrElementName (ea::string_view elementName) const |
| void | CloseArchive () |
| void | ReadBytesFromHexString (ea::string_view elementName, const ea::string &string, void *bytes, unsigned size) |
| Protected Member Functions inherited from Urho3D::MovableNonCopyable | |
| MovableNonCopyable (MovableNonCopyable &&other)=default | |
| MovableNonCopyable & | operator= (MovableNonCopyable &&other)=default |
| MovableNonCopyable (const MovableNonCopyable &other)=delete | |
| MovableNonCopyable & | operator= (const MovableNonCopyable &other)=delete |
Protected Attributes | |
| XMLElement | rootElement_ {} |
| const bool | serializeRootName_ {} |
| Protected Attributes inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, true > | |
| ea::vector< Block > | stack_ |
Private Attributes | |
| const XMLFile * | xmlFile_ {} |
| XML file. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Urho3D::Archive | |
| static bool | ValidateName (ea::string_view name) |
| Validate element or block name. | |
| Protected Types inherited from Urho3D::ArchiveBaseT< BlockType, IsInputBool, true > | |
| using | Block = BlockType |
| Static Protected Attributes inherited from Urho3D::ArchiveBase | |
| static constexpr const char * | rootBlockName = "Root" |
| static constexpr const char * | versionElementName = "Version" |
Detailed Description
template<class BlockType, bool IsInputBool>
class Urho3D::XMLArchiveBase< BlockType, IsInputBool >
class Urho3D::XMLArchiveBase< BlockType, IsInputBool >
Base archive for XML serialization.
Member Function Documentation
◆ GetName()
template<class BlockType , bool IsInputBool>
|
inlinevirtual |
Return name of the archive if applicable.
Reimplemented from Urho3D::ArchiveBase.
The documentation for this class was generated from the following file:
- Urho3D/Resource/XMLArchive.h