Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

ResourceAccessor< R > Class Template Reference

#include <ResourceAccessor.h>

Inheritance diagram for ResourceAccessor< R >:

List of all members.


Detailed Description

template<class R>
class ResourceAccessor< R >

A variation of MarkScope which allows you to forward access to the resource via the '->' operator, smart-pointer style.

Definition at line 9 of file ResourceAccessor.h.


Public Member Functions

 ResourceAccessor (R &r)
 constructor, for marking resources which require no data
 ResourceAccessor (R &r, Resource::Data &d)
 constructor, accepts data parameter to pass to Resource::useResource()
 ResourceAccessor (const ResourceAccessor &ra)
 copy constructor, marks resource used with default (empty) data
 ResourceAccessor (const ResourceAccessor &ra, Resource::Data &d)
 copy constructor, accepts additional data parameter to pass to Resource::useResource()
R & accessResource () const __attribute__((warn_unused_result))
 returns rsrc cast as R
R * operator-> ()
 smart pointer to the underlying Resource
const R * operator-> () const
 smart pointer to the underlying Resource
R & operator * ()
 smart pointer to the underlying Resource
const R & operator * () const
 smart pointer to the underlying Resource
R & operator[] (int i)
 smart pointer to the underlying Resource
const R & operator[] (int i) const
 smart pointer to the underlying Resource

Constructor & Destructor Documentation

template<class R>
ResourceAccessor< R >::ResourceAccessor ( R &  r  )  [inline]

constructor, for marking resources which require no data

Definition at line 12 of file ResourceAccessor.h.

template<class R>
ResourceAccessor< R >::ResourceAccessor ( R &  r,
Resource::Data d 
) [inline]

constructor, accepts data parameter to pass to Resource::useResource()

Definition at line 14 of file ResourceAccessor.h.

template<class R>
ResourceAccessor< R >::ResourceAccessor ( const ResourceAccessor< R > &  ra  )  [inline]

copy constructor, marks resource used with default (empty) data

Definition at line 16 of file ResourceAccessor.h.

template<class R>
ResourceAccessor< R >::ResourceAccessor ( const ResourceAccessor< R > &  ra,
Resource::Data d 
) [inline]

copy constructor, accepts additional data parameter to pass to Resource::useResource()

Definition at line 18 of file ResourceAccessor.h.


Member Function Documentation

template<class R>
R& ResourceAccessor< R >::accessResource (  )  const [inline]

returns rsrc cast as R

Definition at line 22 of file ResourceAccessor.h.

template<class R>
R* ResourceAccessor< R >::operator-> (  )  [inline]

smart pointer to the underlying Resource

Definition at line 31 of file ResourceAccessor.h.

template<class R>
const R* ResourceAccessor< R >::operator-> (  )  const [inline]

smart pointer to the underlying Resource

Definition at line 32 of file ResourceAccessor.h.

template<class R>
R& ResourceAccessor< R >::operator * (  )  [inline]

smart pointer to the underlying Resource

Definition at line 33 of file ResourceAccessor.h.

template<class R>
const R& ResourceAccessor< R >::operator * (  )  const [inline]

smart pointer to the underlying Resource

Definition at line 34 of file ResourceAccessor.h.

template<class R>
R& ResourceAccessor< R >::operator[] ( int  i  )  [inline]

smart pointer to the underlying Resource

Definition at line 35 of file ResourceAccessor.h.

template<class R>
const R& ResourceAccessor< R >::operator[] ( int  i  )  const [inline]

smart pointer to the underlying Resource

Definition at line 36 of file ResourceAccessor.h.


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:39 2007 by Doxygen 1.5.4