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

A class that represents the complete type of a resource object. More...

#include <omResourceTypeID.h>

Public Member Functions

 ResourceTypeID ()
 Create a new resource type ID with UNDEFINED category, type, and subtype. More...
 
 ResourceTypeID (const ResourceCategory &newCategory)
 Creata new resource type ID that selects any resource type belonging to the given category. More...
 
 ResourceTypeID (const ResourceType &newType)
 Creata new resource type ID that selects any subtype of the given resource type. More...
 
 ResourceTypeID (const ResourceType &newType, const ResourceSubType &newSubType)
 Creata new resource type ID that selects only a given subtype of the given resource type. More...
 
Bool operator== (const ResourceTypeID &other) const
 Return whether or not this resource type is equal to another. More...
 
Bool operator!= (const ResourceTypeID &other) const
 Return whether or not this resource type is equal to another. More...
 
Hash getHashCode () const
 Return an integer hash code for this resource type ID. More...
 

Public Attributes

ResourceCategory category
 The category that the resource type ID belongs to. More...
 
ResourceType type
 The resource type of the type ID. More...
 
ResourceSubType subType
 The subtype of the resource type ID. More...
 

Detailed Description

A class that represents the complete type of a resource object.

A type ID consists of a tuple of resource category, resource type, and resource subtype. If any of these is UNDEFINED, it reduces the specificity of the ID.

Constructor & Destructor Documentation

om::resources::ResourceTypeID::ResourceTypeID ( )
inline

Create a new resource type ID with UNDEFINED category, type, and subtype.

om::resources::ResourceTypeID::ResourceTypeID ( const ResourceCategory newCategory)
inline

Creata new resource type ID that selects any resource type belonging to the given category.

om::resources::ResourceTypeID::ResourceTypeID ( const ResourceType newType)
inline

Creata new resource type ID that selects any subtype of the given resource type.

om::resources::ResourceTypeID::ResourceTypeID ( const ResourceType newType,
const ResourceSubType newSubType 
)
inline

Creata new resource type ID that selects only a given subtype of the given resource type.

Member Function Documentation

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

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

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

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

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

Return an integer hash code for this resource type ID.

Member Data Documentation

ResourceCategory om::resources::ResourceTypeID::category

The category that the resource type ID belongs to.

ResourceType om::resources::ResourceTypeID::type

The resource type of the type ID.

ResourceSubType om::resources::ResourceTypeID::subType

The subtype of the resource type ID.


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