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

A class that represents the sub type of a generic resource. More...

#include <omResourceSubType.h>

Public Member Functions

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

Static Public Attributes

static const ResourceSubType UNDEFINED
 An undefined resource sub type for when no sub type is specified. More...
 

Detailed Description

A class that represents the sub type of a generic resource.

An resource sub type is defined by a unique string.

Constructor & Destructor Documentation

om::resources::ResourceSubType::ResourceSubType ( )
inline

Create a new resource sub type with an UNDEFINED sub type string.

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

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

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

Create a new resource sub type with the specified sub type string.

Member Function Documentation

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

Return a string representing the name of this resource sub type.

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

Return whether or not this resource sub type is equal to another.

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

Return whether or not this resource sub type is equal to another.

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

Return an integer hash code for this resource sub type.

Member Data Documentation

const ResourceSubType om::resources::ResourceSubType::UNDEFINED
static

An undefined resource sub type for when no sub type is specified.


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