CATCH
 All Classes Functions
Public Member Functions | List of all members
Catch::CatContext Class Reference

Public Member Functions

 CatContext (std::string IPSI_IP)
 
CAT_RESULT loadJtFile (std::string filePath)
 
CAT_RESULT CatContext::init (int simulationMaxNumObjects, double simulationTimeStep, double simulationResolution)
 
CAT_RESULT run ()
 

Constructor & Destructor Documentation

Catch::CatContext::CatContext ( std::string  IPSI_IP)

Public constructor

This constructor is reponsible of constructing all other modules within the CATCH Library. CatIPSI requires an IP adress upon construction, so this information is required upon instantiation of this object.

Parameters
IPSI_IPthe IP address of IPSI server in string form

Member Function Documentation

CAT_RESULT Catch::CatContext::CatContext::init ( int  simulationMaxNumObjects,
double  simulationTimeStep,
double  simulationResolution 
)

Intializes all CATCH submodules.

Parameters
simulationMaxNumObjectsthe maximum number of objects that IPSI should be prepared to receive
simulationTimeStepthe timestep (in seconds) that IPSI will use for the simulation of the scene
simulationResolutionthe voxel size of the the simulation, in meters
Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatContext::loadJtFile ( std::string  filePath)

Intiates the loading of JT assembly files into the physics scene

Parameters
filePathis a string containing the file path where the JT file to be loaded into the physcis scene is located
Returns
Error code denoting if the method completed successfully
CAT_RESULT Catch::CatContext::run ( )

Initiates the primary control loop of CATCH.

Returns
Error code denoting if the method completed successfully