Generated on Fri Mar 20 15:56:47 2015 for Gecode by doxygen 1.6.3

Gecode::SharedHandle Class Reference
[Support for shared objects and handles]

The shared handle. More...

#include <core.hpp>

List of all members.

Classes

class  Object
 The shared object. More...

Public Member Functions

 SharedHandle (void)
 Create shared handle with no object pointing to.
 SharedHandle (SharedHandle::Object *so)
 Create shared handle that points to shared object so.
 SharedHandle (const SharedHandle &sh)
 Copy constructor maintaining reference count.
SharedHandleoperator= (const SharedHandle &sh)
 Assignment operator maintaining reference count.
void update (Space &home, bool share, SharedHandle &sh)
 Updating during cloning.
 ~SharedHandle (void)
 Destructor that maintains reference count.

Protected Member Functions

SharedHandle::Objectobject (void) const
 Access to the shared object.
void object (SharedHandle::Object *n)
 Modify shared object.

Detailed Description

The shared handle.

A shared handle provides access to an object that lives outside a space, and is shared between entities that possibly reside inside different spaces. The handle has an update mechanism that supports updates with and without sharing. An update without sharing makes sure that a single copy of the object is created when the space is copied.

This is the base class that all shared handles must inherit from.

Definition at line 79 of file core.hpp.


Constructor & Destructor Documentation

Gecode::SharedHandle::SharedHandle ( void   )  [inline]

Create shared handle with no object pointing to.

Definition at line 2639 of file core.hpp.

Gecode::SharedHandle::SharedHandle ( SharedHandle::Object so  )  [inline]

Create shared handle that points to shared object so.

Definition at line 2641 of file core.hpp.

Gecode::SharedHandle::SharedHandle ( const SharedHandle sh  )  [inline]

Copy constructor maintaining reference count.

Definition at line 2645 of file core.hpp.

Gecode::SharedHandle::~SharedHandle ( void   )  [inline]

Destructor that maintains reference count.

Definition at line 2672 of file core.hpp.


Member Function Documentation

SharedHandle & Gecode::SharedHandle::operator= ( const SharedHandle sh  )  [inline]

Assignment operator maintaining reference count.

Definition at line 2649 of file core.hpp.

void Gecode::SharedHandle::update ( Space home,
bool  share,
SharedHandle sh 
) [inline]

Updating during cloning.

Definition at line 2656 of file core.hpp.

SharedHandle::Object * Gecode::SharedHandle::object ( void   )  const [inline, protected]

Access to the shared object.

Definition at line 2619 of file core.hpp.

void Gecode::SharedHandle::object ( SharedHandle::Object n  )  [inline, protected]

Modify shared object.

Definition at line 2633 of file core.hpp.


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