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

PCMInterface Class Reference

#include <PCMInterface.hh>

Inherits Singleton< PCMInterface >.

List of all members.


Detailed Description

Interface class for all PCM functionality.

The PCMInterface class is the main point of entry for PCM functionality. Usually, there will be one instance of this class (could be global, but not necessary) that other components in the system can use to access PCM functionality.

This class has an internal instance of ContactCatcher as well as a list of currently supported contact types. Note that contact types are contact primitives with a particular parameterization. The readConfig() method is provided to read a PCM configuration file and define these contact types as well as the surface/object pair data maintained by the contact catcher.


Public Member Functions

bool readConfig (const char *filename)
ContactFactoryfindContactType (const char *alias)
void add (DeBaseNode *n)
void remove (DeBaseNode *n)
void addContactType (const char *alias, const char *prim, char *params)
void addSurfacePair (const char *surfaceA, const char *surfaceB, const char *type)
void addObjectPair (const char *objectA, const char *objectB, const char *type)
void printContactTypes (void)
void printSurfacePairs (void)
void printObjectPairs (void)


Member Function Documentation

ContactFactory* PCMInterface::findContactType const char *  alias  ) 
 

This method queries the internal PCM database for a particular contact type. Contact types, identified with a string alias, are contact primitives with a particular parameterization and are defined in PCM configuration files.

bool PCMInterface::readConfig const char *  filename  ) 
 

This method processes the specified PCM configuration file. This configuation file can be used to create contact types (contact primitives with a specific parameterization) and associate surface and object pairs with contact types.


SimLib Reference Documentation