CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

scfInterface< T > Class Template Reference
[Shared Class Facility (SCF)]

Interface query class. More...

#include <scf.h>

List of all members.

Static Public Methods

int GetVersion ()
 Retrieve the interface's current version number which was specified with SCF_VERSION().

scfInterfaceID GetID ()
 Retrieve the interface's identifier.

char const * GetName ()
 Retrieve the interface's name as a string.


Detailed Description

template<class T>
class scfInterface< T >

Interface query class.

This template class allows you to query static information about SCF interfaces, such as an interface's current version number. For example, to find out the version number of the iFooBar SCF interface, you would invoke scfInterface<iFooBar>::GetVersion().

Definition at line 773 of file scf.h.


Member Function Documentation

template<class T>
scfInterfaceID scfInterface< T >::GetID   [inline, static]
 

Retrieve the interface's identifier.

This is a unique identifier by which SCF recognizes the interface. Although human's prefer to identify interfaces symbolically via name, SCF perfers to identify them, for performance reasons, by scfInterfaceID, which is typically a small integer.

Definition at line 794 of file scf.h.

References scfInterfaceID.

template<class T>
char const* scfInterface< T >::GetName   [inline, static]
 

Retrieve the interface's name as a string.

Definition at line 804 of file scf.h.

template<class T>
int scfInterface< T >::GetVersion   [inline, static]
 

Retrieve the interface's current version number which was specified with SCF_VERSION().

Definition at line 780 of file scf.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18