Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
om::resources::ResourceCategory Class Reference

A class that represents the category of a generic resource. More...

#include <omResourceCategory.h>

Public Member Functions

 ResourceCategory ()
 Create a new resource category with an UNDEFINED category string. More...
 
 ResourceCategory (const Char *newName)
 Create a new resource category with the specified constant NULL-terminated category string. More...
 
 ResourceCategory (const data::UTF8String &newName)
 Create a new resource category with the specified category string. More...
 
const data::UTF8StringgetName () const
 Return a string representing the name of this resource category. More...
 
Bool operator== (const ResourceCategory &other) const
 Return whether or not this resource category is equal to another. More...
 
Bool operator!= (const ResourceCategory &other) const
 Return whether or not this resource category is equal to another. More...
 
Hash getHashCode () const
 Return an integer hash code for this resource category. More...
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 
template<>
const ResourceCategoryof ()
 

Static Public Member Functions

template<typename DataType >
static const ResourceCategoryof ()
 

Static Public Attributes

static const ResourceCategory UNDEFINED
 An undefined resource category for when no category is specified. More...
 
static const ResourceCategory GRAPHICS
 A resource category corresponding to graphics data types. More...
 
static const ResourceCategory PHYSICS
 A resource category corresponding to physics data types. More...
 
static const ResourceCategory SOUND
 A resource category corresponding to sound data types. More...
 
static const ResourceCategory TEXT
 A resource category corresponding to textual or string data types. More...
 
static const ResourceCategory MATH
 A resource category corresponding to math data types. More...
 

Detailed Description

A class that represents the category of a generic resource.

An resource category is defined by a unique string.

Constructor & Destructor Documentation

om::resources::ResourceCategory::ResourceCategory ( )
inline

Create a new resource category with an UNDEFINED category string.

om::resources::ResourceCategory::ResourceCategory ( const Char newName)
inline

Create a new resource category with the specified constant NULL-terminated category string.

om::resources::ResourceCategory::ResourceCategory ( const data::UTF8String newName)
inline

Create a new resource category with the specified category string.

Member Function Documentation

const data::UTF8String& om::resources::ResourceCategory::getName ( ) const
inline

Return a string representing the name of this resource category.

Bool om::resources::ResourceCategory::operator== ( const ResourceCategory other) const
inline

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

Bool om::resources::ResourceCategory::operator!= ( const ResourceCategory other) const
inline

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

Hash om::resources::ResourceCategory::getHashCode ( ) const
inline

Return an integer hash code for this resource category.

template<typename DataType >
static const ResourceCategory& om::resources::ResourceCategory::of ( )
inlinestatic
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline
template<>
const ResourceCategory& om::resources::ResourceCategory::of ( )
inline

Member Data Documentation

const ResourceCategory om::resources::ResourceCategory::UNDEFINED
static

An undefined resource category for when no category is specified.

const ResourceCategory om::resources::ResourceCategory::GRAPHICS
static

A resource category corresponding to graphics data types.

const ResourceCategory om::resources::ResourceCategory::PHYSICS
static

A resource category corresponding to physics data types.

const ResourceCategory om::resources::ResourceCategory::SOUND
static

A resource category corresponding to sound data types.

const ResourceCategory om::resources::ResourceCategory::TEXT
static

A resource category corresponding to textual or string data types.

const ResourceCategory om::resources::ResourceCategory::MATH
static

A resource category corresponding to math data types.


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