This is a null resource, it can be used in places where a resource is required but it is not wanted. More...

Inheritance diagram for Null:

Public Member Functions
virtual GID::Type	GetGID () const override
	01010000h, (System, Folder) More...

Public Member Functions inherited from Base
	Base ()
	Default constructor. More...

const Containers::Collection< Base >::ConstIterator	begin () const
	Allows easy iteration through range based fors. More...

const Containers::Collection< Base >::ConstIterator	cbegin () const
	Beginning of children. More...

const Containers::Collection< Base >::ConstIterator	cend () const
	End of children. More...

bool	DeleteResource ()
	Safely deletes the resource. More...

virtual void	Discard ()
	This function shall discard any transitional data which is not vital after Prepare function is issued. More...

const Containers::Collection< Base >::ConstIterator	end () const
	Allows easy iteration through range based fors. More...

virtual SGuid	GetGuid () const
	Returns the guid of the object. More...

const std::string &	GetName () const
	Returns the name of this object. More...

Base &	GetParent () const
	Returns the parent. If no parent set, this function throws std::runtime_error. More...

Base *	GetParentPtr () const
	Returns the pointer to the parent. This function may return nullptr. More...

const Base &	GetRoot () const
	Returns the root of this resource. More...

bool	HasParent () const
	Returns whether this object has a parent. More...

virtual bool	IsEqual (const SGuid &guid) const
	This function tests whether this object has the given SGuid. More...

virtual void	Prepare ()
	This function shall prepare this resource to be used after resource is loaded. More...

virtual void	Resolve (File &file)
	This function shall resolve links or similar constructs. More...

void	Save (Writer &writer)
	Saves this object into the given writer. The writer should be open prior to this call. More...

virtual void	SetGuid (SGuid guid)
	Changes the guid of the object. More...

virtual void	SetName (const std::string &name)
	Sets the name of the object. More...

Static Public Member Functions
static Null *	LoadResource (std::weak_ptr< File > file, std::shared_ptr< Reader > reader, unsigned long size)
	This function loads a line resource from the file. More...

static void	SaveThis (Writer &writer)

Protected Member Functions
virtual void	save (Writer &writer) const override

Protected Member Functions inherited from Base
virtual	~Base ()
	Destructor, Always children gets destroyed first. More...

void	destroychildren ()
	Destroys the children of this resource. More...

void	setparenttonullptr (Base &base)
	Sets the parent of an object to nullptr, provides access. More...

Additional Inherited Members
Public Attributes inherited from Base
const Containers::Collection< Base > &	Children
	The children this object have. More...

unsigned long	refcount
	INTERNAL, Reference count, used in linking mechanism. More...

Protected Attributes inherited from Base
Containers::Collection< Base >	children
	Child objects that this resource object have. More...

SGuid	guid
	SGuid to identify this resource object. More...

std::string	name
	Name of this resource object, may not be loaded. More...

Base *	parent
	Immediate parent of this resource. More...

const Base *	root
	Root of this resource. More...

Detailed Description

This is a null resource, it can be used in places where a resource is required but it is not wanted.

This object only saves its GID and size, nothing else.

Member Function Documentation

◆ GetGID()

virtual GID::Type GetGID ( ) const

overridevirtual

01010000h, (System, Folder)

Implements Base.

References Gorgon::Resource::GID::Null.

◆ LoadResource()

Null * LoadResource	(	std::weak_ptr< File >	file,
		std::shared_ptr< Reader >	reader,
		unsigned long	size
	)

static

This function loads a line resource from the file.

References Gorgon::Resource::GID::Null.

◆ save()

void save ( Writer & writer ) const

overrideprotectedvirtual

Implements Base.

References Gorgon::Resource::GID::Null, Writer::WriteChunkSize(), and Writer::WriteGID().

◆ SaveThis()

void SaveThis ( Writer & writer )

static

References Gorgon::Resource::GID::Null, Writer::WriteChunkSize(), and Writer::WriteGID().

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

Gorgon/Resource/Null.h
Gorgon/Resource/Null.cpp

Public Member Functions

Static Public Member Functions