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

A class that opaquely stores a reference to a resource. More...

#include <omOpaqueResource.h>

Public Member Functions

 OpaqueResource ()
 Create a new opaque resource which doesn't point to a valid resource. More...
 
 OpaqueResource (void *newData, ResourceID *newID)
 Create a new opaque resource for the specified data and resource type. More...
 
template<typename T >
 OpaqueResource (const Resource< T > &newResource)
 Create a new opaque resource for the specified resource. More...
 
void * getData () const
 Return an opaque pointer to the resource object data. More...
 
void setData (void *newData)
 Set an opaque pointer to the resource object data. More...
 
ResourceIDgetID () const
 Return a pointer to an object describing the ID for the resource. More...
 
void setID (ResourceID *newID)
 Set a pointer to an object describing the ID for the resource. More...
 
Bool isSet () const
 Return whether or not this opaque resource's data and ID are both valid and non-NULL. More...
 
Bool isNull () const
 Return whether or not this opaque resource's data or ID are NULL. More...
 
Bool operator== (const OpaqueResource &other) const
 Return whether or not this opaque resource is equal to another. More...
 
Bool operator!= (const OpaqueResource &other) const
 Return whether or not this opaque resource is not equal to another. More...
 

Detailed Description

A class that opaquely stores a reference to a resource.

Constructor & Destructor Documentation

om::resources::OpaqueResource::OpaqueResource ( )
inline

Create a new opaque resource which doesn't point to a valid resource.

om::resources::OpaqueResource::OpaqueResource ( void *  newData,
ResourceID newID 
)
inline

Create a new opaque resource for the specified data and resource type.

template<typename T >
om::resources::OpaqueResource::OpaqueResource ( const Resource< T > &  newResource)
inline

Create a new opaque resource for the specified resource.

Member Function Documentation

void* om::resources::OpaqueResource::getData ( ) const
inline

Return an opaque pointer to the resource object data.

void om::resources::OpaqueResource::setData ( void *  newData)
inline

Set an opaque pointer to the resource object data.

ResourceID* om::resources::OpaqueResource::getID ( ) const
inline

Return a pointer to an object describing the ID for the resource.

void om::resources::OpaqueResource::setID ( ResourceID newID)
inline

Set a pointer to an object describing the ID for the resource.

Bool om::resources::OpaqueResource::isSet ( ) const
inline

Return whether or not this opaque resource's data and ID are both valid and non-NULL.

Bool om::resources::OpaqueResource::isNull ( ) const
inline

Return whether or not this opaque resource's data or ID are NULL.

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

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

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

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


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