from::FD4::FD4FileCap Class Reference

Abstract file capsule class. More...

#include <resource.hpp>

Inheritance diagram for from::FD4::FD4FileCap:

Public Member Functions
FD4FileCapState	get_state () const noexcept
	Get the processing state.
void *	get_load_task () const noexcept
	Get the load task associated with the capsule.
bool	ready () const noexcept
	Has the file been fully processed?
virtual void	request_file_load (FD4FileLoadProcess *load_process)=0
	Request a file to be loaded with the specified load process.
virtual void	force_file_load ()=0
	Force the loading of the file capsule's associated resources.
Public Member Functions inherited from from::FD4::FD4ResCap
virtual void	set_debug (bool value) LIBER_INTERFACE
	Set the internal debugging state.
Public Member Functions inherited from from::FD4::FD4ResCapHolderItem
DLTX::FD4BasicHashString &	name ()
	Get the item name.
const DLTX::FD4BasicHashString &	name () const
	Get the item name (const).
FD4ResCapHolderItem *	next ()
	Get the next item in the hash table.
const FD4ResCapHolderItem *	next () const
	Get the next item in the hash table (const).
size_t &	ref_count ()
	Get the reference count of the item.
const size_t &	ref_count () const
	Get the reference count of the item (const).
Public Member Functions inherited from from::FD4::FD4ComponentBase
virtual LIBERAPI DLRF::DLRuntimeClass *	get_runtime_class () noexcept
	Get the runtime class object.

Detailed Description

Abstract file capsule class.

Member Function Documentation

force_file_load()

virtual void from::FD4::FD4FileCap::force_file_load ( )

pure virtual

Force the loading of the file capsule's associated resources.

Note

Does not work for all file capsule types.

get_load_task()

void * from::FD4::FD4FileCap::get_load_task ( ) const

inlinenoexcept

Get the load task associated with the capsule.

Returns

void*

get_state()

FD4FileCapState from::FD4::FD4FileCap::get_state ( ) const

inlinenoexcept

Get the processing state.

Returns

FD4FileCapState

ready()

bool from::FD4::FD4FileCap::ready ( ) const

inlinenoexcept

Has the file been fully processed?

Returns

true

false

request_file_load()

virtual void from::FD4::FD4FileCap::request_file_load ( FD4FileLoadProcess *  load_process )

pure virtual

Request a file to be loaded with the specified load process.

Parameters

load_process

the load process

---

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

• include/fd4/resource.hpp