om::resources::ResourceFormat Class Reference

An enum class that specifies a storage format for a resource and its attributes. More...

#include <omResourceFormat.h>

Public Member Functions
	ResourceFormat ()
	Create an UNDEFINED resource format. More...
	ResourceFormat (const data::UTF8String &newName)
	Create a new resource format with the specified resource format name and no extensions. More...
	ResourceFormat (const data::UTF8String &newName, const data::UTF8String &newExtension)
	Create a new resource format with the specified resource format name and extension. More...
	ResourceFormat (const data::UTF8String &newName, const data::UTF8String &newExtension1, const data::UTF8String &newExtension2)
	Create a new resource format with the specified resource format name and extensions. More...
	ResourceFormat (const data::UTF8String &newName, const data::UTF8String &newExtension1, const data::UTF8String &newExtension2, const data::UTF8String &newExtension3)
	Create a new resource format with the specified resource format name and extensions. More...
const data::UTF8String &	getName () const
	Return the unique name string for this resource format. More...
void	setName (const data::UTF8String &newName)
	Set the unique name string for this resource format. More...
Size	getExtensionCount () const
	Return the number of possible extensions that this resource format has. More...
const data::UTF8String &	getExtension (Index index) const
	Return the file extension at the given index that can be used for this format. More...
Bool	hasExtension (const data::UTF8String &newExtension) const
	Return whether or not the specified string is a valid extension for this format. More...
void	addExtension (const data::UTF8String &newExtension)
	Add a new extension to this resource format. More...
void	clearExtensions ()
	Clear all extensions from this resource format. More...
Hash	getHashCode () const
	Return an integer hash code for this resource format. More...
Bool	operator== (const ResourceFormat &other) const
	Return whether or not this resource format is equal to another. More...
Bool	operator!= (const ResourceFormat &other) const
	Return whether or not this resource format is equal to another. More...

Static Public Attributes
static const ResourceFormat	UNDEFINED
	The resource type to use for an undefined resource format. More...

Detailed Description

An enum class that specifies a storage format for a resource and its attributes.

Constructor & Destructor Documentation

om::resources::ResourceFormat::ResourceFormat

(

)

Create an UNDEFINED resource format.

om::resources::ResourceFormat::ResourceFormat

(

const data::UTF8String &

newName

)

Create a new resource format with the specified resource format name and no extensions.

om::resources::ResourceFormat::ResourceFormat	(	const data::UTF8String &	newName,
		const data::UTF8String &	newExtension
	)

Create a new resource format with the specified resource format name and extension.

om::resources::ResourceFormat::ResourceFormat	(	const data::UTF8String &	newName,
		const data::UTF8String &	newExtension1,
		const data::UTF8String &	newExtension2
	)

Create a new resource format with the specified resource format name and extensions.

om::resources::ResourceFormat::ResourceFormat	(	const data::UTF8String &	newName,
		const data::UTF8String &	newExtension1,
		const data::UTF8String &	newExtension2,
		const data::UTF8String &	newExtension3
	)

Create a new resource format with the specified resource format name and extensions.

Member Function Documentation

const data::UTF8String& om::resources::ResourceFormat::getName ( ) const

inline

Return the unique name string for this resource format.

void om::resources::ResourceFormat::setName ( const data::UTF8String &  newName )

inline

Set the unique name string for this resource format.

Size om::resources::ResourceFormat::getExtensionCount ( ) const

inline

Return the number of possible extensions that this resource format has.

const data::UTF8String& om::resources::ResourceFormat::getExtension ( Index  index ) const

inline

Return the file extension at the given index that can be used for this format.

Bool om::resources::ResourceFormat::hasExtension

(

const data::UTF8String &

newExtension

)

const

Return whether or not the specified string is a valid extension for this format.

void om::resources::ResourceFormat::addExtension

(

const data::UTF8String &

newExtension

)

Add a new extension to this resource format.

void om::resources::ResourceFormat::clearExtensions

(

)

Clear all extensions from this resource format.

Hash om::resources::ResourceFormat::getHashCode ( ) const

inline

Return an integer hash code for this resource format.

Bool om::resources::ResourceFormat::operator== ( const ResourceFormat &  other ) const

inline

Return whether or not this resource format is equal to another.

Bool om::resources::ResourceFormat::operator!= ( const ResourceFormat &  other ) const

inline

Return whether or not this resource format is equal to another.

Member Data Documentation

const ResourceFormat om::resources::ResourceFormat::UNDEFINED

static

The resource type to use for an undefined resource format.

---

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

• omResourceFormat.h