IMP logo
Functions

IMP::cgal Namespace Reference


Detailed Description

This module provides IMP wrappers for various algorithms implemented in CGAL.

The module should not be used directly by users. Instead IMP.algebra and IMP.core functionality will be improved when CGAL is available. The main purpose of this module is to allow certain CGAL code to be built with different build flags than the rest of IMP. Specifically, CGAL needs IEEE floating point specs to be followed exactly.

Author(s)

Daniel Russel

Version

SVN 8931

License:

LGPL. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Functions

std::string get_data_path (std::string file_name)
 Return the path to installed data for this module.
std::string get_example_path (std::string file_name)
 Return the path to installed example data for this module.
std::string get_module_name ()
const VersionInfoget_module_version_info ()

Function Documentation

std::string IMP::cgal::get_data_path ( std::string  file_name)

Return the path to installed data for this module.

Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data directory of module "mymodule", do something like

    std::ifstream in(IMP::mymodule::get_data_path("data_library"));

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.

std::string IMP::cgal::get_example_path ( std::string  file_name)

Return the path to installed example data for this module.

Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb located in the examples directory of the IMP::atom module, do

    IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb", model));

This will ensure that the code works when IMP is installed or used via the tools/imppy.sh script.


Generated on Thu Mar 24 2011 02:01:45 for IMP by doxygen 1.7.3