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

A class that encapsulates a type for a PhysicsForce. More...

#include <omPhysicsForceType.h>

Public Member Functions

 ForceType (const Type &newType)
 Create a ForceType object with the specified internal type. More...
 
 ForceType (const Char *string)
 Create a ForceType object with the specified string type. More...
 
 ForceType (const UTF8String &newTypeString)
 Create a ForceType object with the specified string type. More...
 
Bool operator== (const ForceType &other) const
 Return whether or not this shape type is equal to another. More...
 
Bool operator!= (const ForceType &other) const
 Return whether or not this shape type is not equal to another. More...
 
ForceTypeID getID () const
 Return an integer identifying this shape type. More...
 
Hash getHashCode () const
 Return a hash code for this shape type. More...
 
 operator const UTF8String & () const
 Get a string representing the implementation-defined name of this type. More...
 
const UTF8String & toString () const
 Get a string representing the implementation-defined name of this type. More...
 
const UTF8String & getName () const
 Get a string representing the implementation-defined name of this type. More...
 
template<>
const ForceTypeof ()
 Specialize the force type template for this type. More...
 
template<>
const ForceTypeof ()
 Specialize the force type template for this type. More...
 
template<>
const ForceTypeof ()
 Specialize the force type template for this type. More...
 

Static Public Member Functions

template<typename T >
static const ForceTypeof ()
 Return a ForceType object for the specified type template parameter. More...
 

Public Attributes

Hash hashCode
 A hash code for this shape type. More...
 
UTF8String type
 A string object representing the internal type for this ForceType. More...
 

Detailed Description

A class that encapsulates a type for a PhysicsForce.

Constructor & Destructor Documentation

om::physics::forces::ForceType::ForceType ( const Type newType)
inline

Create a ForceType object with the specified internal type.

om::physics::forces::ForceType::ForceType ( const Char string)
inline

Create a ForceType object with the specified string type.

om::physics::forces::ForceType::ForceType ( const UTF8String &  newTypeString)
inline

Create a ForceType object with the specified string type.

Member Function Documentation

template<typename T >
static const ForceType& om::physics::forces::ForceType::of ( )
inlinestatic

Return a ForceType object for the specified type template parameter.

Bool om::physics::forces::ForceType::operator== ( const ForceType other) const
inline

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

Bool om::physics::forces::ForceType::operator!= ( const ForceType other) const
inline

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

ForceTypeID om::physics::forces::ForceType::getID ( ) const
inline

Return an integer identifying this shape type.

This ID is a 32-bit integer that is generated by hashing the string generated for a type template parameter. While the posibility of ID collisions is very low, duplicates are nonetheless a possibility.

Hash om::physics::forces::ForceType::getHashCode ( ) const
inline

Return a hash code for this shape type.

om::physics::forces::ForceType::operator const UTF8String & ( ) const
inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::physics::forces::ForceType::toString ( ) const
inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::physics::forces::ForceType::getName ( ) const
inline

Get a string representing the implementation-defined name of this type.

template<>
const ForceType& om::physics::forces::ForceType::of ( )
inline

Specialize the force type template for this type.

template<>
const ForceType& om::physics::forces::ForceType::of ( )
inline

Specialize the force type template for this type.

template<>
const ForceType& om::physics::forces::ForceType::of ( )
inline

Specialize the force type template for this type.

Member Data Documentation

Hash om::physics::forces::ForceType::hashCode

A hash code for this shape type.

UTF8String om::physics::forces::ForceType::type

A string object representing the internal type for this ForceType.


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