Detailed Description

Common base class for heavy weight IMP objects.

Proxy of C++ IMP::Object class.

The base class for non value-type classes in IMP. Anything inheriting from Object has the following properties:

has embedded information about the module and version which can be accessed using Object::get_version_info(). This information can be used to log what version of software is used to compute a result.
it has a local logging level which can override the global one allowing fine grained logging control.
in Python, there is a method Class::get_from(Object *o) that attempts to cast o to an object of type Class and throws an exception if it fails.
the object keeps track of whether it has been been used. See the Object::set_was_used() method for an explanation.
It is reference counted

Types inheriting from Object should always be created using new in C++ and passed using pointers and stored using Pointer objects. Note that you have to be careful of cycles and so must use WeakPointer objects to break cycles. IMP_NEW() can help shorten creating a ref counted pointer. See Pointer for more information.

See example::ExampleObject for a simple example.

Reference counting is a technique for managing memory and automatically freeing memory (destroying objects) when it is no longer needed. In reference counting, each object has a reference count, which tracks how many different places are using the object. When this count goes to 0, the object is freed.

Python internally reference counts everything. C++, on the other hand, requires extra steps be taken to ensure that objects are reference counted properly.

In IMP, reference counting is done through the Pointer, PointerMember and Object classes. The former should be used instead of a raw C++ pointer when storing a pointer to any object inheriting from Object.

Any time one is using reference counting, one needs to be aware of cycles, since if, for example, object A contains an IMP::Pointer to object B and object B contains an Pointer to object A, their reference counts will never go to 0 even if both A and B are no longer used. To avoid this, use an WeakPointer in one of A or B.

Functions that create new objects should follow the following pattern

  ObjectType *create_object(arguments) {
     IMP_NEW(ObjectType, ret, (args));
     do_stuff;
     return ret.release();
   }

using Pointer::release() to safely return the new object without freeing it.

Definition at line 111 of file Object.h.

Public Member Functions
virtual void	clear_caches ()

CheckLevel	get_check_level () const

def	get_derived_object
	Return this object cast to the most derived subclass. More...

LogLevel	get_log_level () const

virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...

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

Protected Member Functions
	Object (std::string name)
	Construct an object with the given name. More...

virtual void	do_destroy ()

Names
All objects have names to aid in debugging and inspection of the state of the system. These names are not necessarily unique and should not be used to store data or as keys into a table. Use the address of the object instead since objects cannot be copied.
const std::string &	get_name () const

void	set_name (std::string name)

virtual std::string	get_type_name () const

Constructor & Destructor Documentation

IMP::Object::Object ( std::string name )

protected

Construct an object with the given name.

An instance of "%1%" in the string will be replaced by a unique index.

Member Function Documentation

virtual void IMP::Object::clear_caches ( )

virtual

Objects can have internal caches. This method resets them returning the object to its just-initialized state.

Reimplemented in IMP::core::ExcludedVolumeRestraint, and IMP::core::MinimumRestraint.

Definition at line 270 of file Object.h.

virtual void IMP::Object::do_destroy ( )

protectedvirtual

Override this method to take action on destruction.

Reimplemented in IMP::container::ExclusiveConsecutivePairContainer, and IMP::display::PymolWriter.

Definition at line 274 of file Object.h.

def IMP.Object.get_derived_object ( self )

Return this object cast to the most derived subclass.

Definition at line 839 of file __init__.py.

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

virtual

Get information about the module and version of the object.

Definition at line 206 of file Object.h.

void IMP::Object::set_check_level ( CheckLevel l )

Each object can be assigned a different check level too.

void IMP::Object::set_log_level ( LogLevel l )

Set the logging level used in this object.

Each object can be assigned a different log level in order to, for example, suppress messages for verbose and uninteresting objects. If set to DEFAULT, the global level as returned by IMP::get_log_level() is used, otherwise the local one is used. Methods in classes inheriting from Object should start with IMP_OBJECT_LOG to change the log level to the local one for this object and increase the current indent.

See Also: IMP::set_log_level(); IMP::get_log_level()

void IMP::Object::set_was_used ( bool tf ) const

IMP provides warnings when objects are never used before they are destroyed. Examples of use include adding an IMP::Restraint to an IMP::ScoringFunction. If an object is not properly marked as used, or your code is the one using it, call set_was_used(true) on the object.

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

Detailed Description

Public Member Functions

Protected Member Functions

Names

Constructor & Destructor Documentation

Member Function Documentation