The base interface for all resource objects.
More...
#include <murl_resource_i_object.h>
The base interface for all resource objects.
◆ GetObjectInterface() [1/2]
virtual IObject* Murl::Resource::IObject::GetObjectInterface |
( |
| ) |
|
|
pure virtual |
◆ GetObjectInterface() [2/2]
virtual const IObject* Murl::Resource::IObject::GetObjectInterface |
( |
| ) |
const |
|
pure virtual |
◆ GetCreator()
virtual const IObjectFactory* Murl::Resource::IObject::GetCreator |
( |
| ) |
const |
|
pure virtual |
Get the object factory used to create this object.
- Returns
- The object factory.
◆ SetParentPackage()
virtual Bool Murl::Resource::IObject::SetParentPackage |
( |
const IPackage * |
parentPackage | ) |
|
|
pure virtual |
Set the optional package this object belongs to.
- Parameters
-
parentPackage | The containing package, or null for removing. |
- Returns
- true if successful.
◆ GetParentPackage()
virtual const IPackage* Murl::Resource::IObject::GetParentPackage |
( |
| ) |
const |
|
pure virtual |
Get the optional package this object belongs to.
- Returns
- The containing package, or null if the object is not contained in a package.
◆ Init()
virtual Bool Murl::Resource::IObject::Init |
( |
| ) |
|
|
pure virtual |
Initialize this object.
- Returns
- true if successful.
◆ DeInit()
virtual Bool Murl::Resource::IObject::DeInit |
( |
| ) |
|
|
pure virtual |
De-initialize this object.
- Returns
- true if successful.
◆ CreateBinary()
virtual Bool Murl::Resource::IObject::CreateBinary |
( |
Data & |
data | ) |
const |
|
pure virtual |
Create a binary representation from the object.
- Parameters
-
data | A reference to a Data object receiving the binary. |
- Returns
- true if successful.
◆ GetId()
virtual const String& Murl::Resource::IObject::GetId |
( |
| ) |
const |
|
pure virtual |
Get the object's ID.
- Returns
- The object ID.
◆ GetResourceType()
Get the object's actual resource type.
- Returns
- The resource type.
◆ GetFileType()
Get the type of file this resource object was constructed from.
- Returns
- The file type.
◆ GetFileCategory()
Get the optional file category containing the file this resource was constructed from.
- Returns
- The file category, or IEnums::FILE_CATEGORY_DEFAULT if the resource was constructed directly from memory.
◆ GetFileName()
virtual const String& Murl::Resource::IObject::GetFileName |
( |
| ) |
const |
|
pure virtual |
Get the optional file name this resource was constructed from, relative to the file category returned via GetFileCategory().
- Returns
- The file name, or an empty string if the resource was constructed directly from memory.
◆ GetParameters()
virtual Bool Murl::Resource::IObject::GetParameters |
( |
IAttributes * |
params | ) |
const |
|
pure virtual |
Fill a given IAttributes object with the actual parameters used during creation.
- Parameters
-
params | An attributes object receiving the parameters. |
- Returns
- true if successful.
◆ GetValidationResults()
Fill a given array with possible error or warning results from validating given parameters.
- Parameters
-
results | An array of result objects. |
- Returns
- true if successful.
◆ GetFileDependencies()
virtual Bool Murl::Resource::IObject::GetFileDependencies |
( |
Array< String > & |
fileNames | ) |
const |
|
pure virtual |
Fill a given string array with names of files the resource depends on.
- Parameters
-
fileNames | A string array receiving the dependency file names. |
- Returns
- true if successful.
◆ TakeDataOwnership()
virtual Bool Murl::Resource::IObject::TakeDataOwnership |
( |
| ) |
|
|
pure virtual |
Take ownership of the data buffer used to create the resource.
After taking ownership, the resource object will delete the underlying data when the resource itself is deleted. The caller must ensure that the given data is not deallocated in a different place.
- Returns
- true if successful.
The documentation for this interface was generated from the following file: