IMP logo
IMP Reference Guide  develop.e1fe35f,2019/09/16
The Integrative Modeling Platform
IMP::RestraintInfo Class Reference

Report key:value information on restraints. More...

#include <IMP/RestraintInfo.h>

+ Inheritance diagram for IMP::RestraintInfo:

Detailed Description

Report key:value information on restraints.

These objects are typically returned by Restraint::get_static_info() or Restraint::get_dynamic_info() and are used to report information about a Restraint instance as a set of key:value pairs. The primary purpose is to allow restraints to be written to files, such as RMF.

Definition at line 24 of file RestraintInfo.h.

Public Member Functions

 RestraintInfo (std::string name="RestraintInfo %1%")
 
void add_filename (std::string key, std::string value)
 Add a filename value referenced by the given key. More...
 
void add_filenames (std::string key, Strings value)
 Add a list of filename values referenced by the given key. More...
 
void add_float (std::string key, double value)
 Add a float value referenced by the given key. More...
 
void add_floats (std::string key, Floats value)
 Add a list of Float values referenced by the given key. More...
 
void add_int (std::string key, int value)
 Add an int value referenced by the given key. More...
 
void add_string (std::string key, std::string value)
 Add a string value referenced by the given key. More...
 
std::string get_filename_key (unsigned i) const
 Get the key for the ith filename mapping. More...
 
std::string get_filename_value (unsigned i) const
 Get the value for the ith filename mapping. More...
 
std::string get_filenames_key (unsigned i) const
 Get the key for the ith filenames mapping. More...
 
Strings get_filenames_value (unsigned i) const
 Get the value for the ith filenames mapping. More...
 
std::string get_float_key (unsigned i) const
 Get the key for the ith float mapping. More...
 
double get_float_value (unsigned i) const
 Get the value for the ith float mapping. More...
 
std::string get_floats_key (unsigned i) const
 Get the key for the ith Floats mapping. More...
 
Floats get_floats_value (unsigned i) const
 Get the value for the ith Floats mapping. More...
 
std::string get_int_key (unsigned i) const
 Get the key for the ith int mapping. More...
 
int get_int_value (unsigned i) const
 Get the value for the ith int mapping. More...
 
unsigned get_number_of_filename () const
 Get the number of filename that have been added. More...
 
unsigned get_number_of_filenames () const
 Get the number of filenames that have been added. More...
 
unsigned get_number_of_float () const
 Get the number of float that have been added. More...
 
unsigned get_number_of_floats () const
 Get the number of Floats that have been added. More...
 
unsigned get_number_of_int () const
 Get the number of int that have been added. More...
 
unsigned get_number_of_string () const
 Get the number of string that have been added. More...
 
std::string get_string_key (unsigned i) const
 Get the key for the ith string mapping. More...
 
std::string get_string_value (unsigned i) const
 Get the value for the ith string mapping. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

void IMP::RestraintInfo::add_filename ( std::string  key,
std::string  value 
)

Add a filename value referenced by the given key.

Filenames are treated similarly to strings but the caller is expected to make them absolute paths before adding them here. When written to file they may be converted to paths relative to the file.

void IMP::RestraintInfo::add_filenames ( std::string  key,
Strings  value 
)

Add a list of filename values referenced by the given key.

Filenames are treated similarly to strings but the caller is expected to make them absolute paths before adding them here. When written to file they may be converted to paths relative to the file.

void IMP::RestraintInfo::add_float ( std::string  key,
double  value 
)

Add a float value referenced by the given key.

void IMP::RestraintInfo::add_floats ( std::string  key,
Floats  value 
)

Add a list of Float values referenced by the given key.

void IMP::RestraintInfo::add_int ( std::string  key,
int  value 
)

Add an int value referenced by the given key.

void IMP::RestraintInfo::add_string ( std::string  key,
std::string  value 
)

Add a string value referenced by the given key.

std::string IMP::RestraintInfo::get_filename_key ( unsigned  i) const

Get the key for the ith filename mapping.

Definition at line 81 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_filename_value ( unsigned  i) const

Get the value for the ith filename mapping.

Definition at line 84 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_filenames_key ( unsigned  i) const

Get the key for the ith filenames mapping.

Definition at line 113 of file RestraintInfo.h.

Strings IMP::RestraintInfo::get_filenames_value ( unsigned  i) const

Get the value for the ith filenames mapping.

Definition at line 118 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_float_key ( unsigned  i) const

Get the key for the ith float mapping.

Definition at line 49 of file RestraintInfo.h.

double IMP::RestraintInfo::get_float_value ( unsigned  i) const

Get the value for the ith float mapping.

Definition at line 52 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_floats_key ( unsigned  i) const

Get the key for the ith Floats mapping.

Definition at line 95 of file RestraintInfo.h.

Floats IMP::RestraintInfo::get_floats_value ( unsigned  i) const

Get the value for the ith Floats mapping.

Definition at line 98 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_int_key ( unsigned  i) const

Get the key for the ith int mapping.

Definition at line 35 of file RestraintInfo.h.

int IMP::RestraintInfo::get_int_value ( unsigned  i) const

Get the value for the ith int mapping.

Definition at line 38 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_filename ( ) const

Get the number of filename that have been added.

Definition at line 78 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_filenames ( ) const

Get the number of filenames that have been added.

Definition at line 110 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_float ( ) const

Get the number of float that have been added.

Definition at line 46 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_floats ( ) const

Get the number of Floats that have been added.

Definition at line 92 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_int ( ) const

Get the number of int that have been added.

Definition at line 32 of file RestraintInfo.h.

unsigned IMP::RestraintInfo::get_number_of_string ( ) const

Get the number of string that have been added.

Definition at line 60 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_string_key ( unsigned  i) const

Get the key for the ith string mapping.

Definition at line 63 of file RestraintInfo.h.

std::string IMP::RestraintInfo::get_string_value ( unsigned  i) const

Get the value for the ith string mapping.

Definition at line 66 of file RestraintInfo.h.

virtual ::IMP::VersionInfo IMP::RestraintInfo::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 122 of file RestraintInfo.h.


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