k3d::ipipeline Class Reference

Abstract interface for maintaining a collection of dependencies among properties ... a "pipeline". More...

#include <ipipeline.h>

Inheritance diagram for k3d::ipipeline:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::pair< iproperty
*, iproperty * > 
dependency_t
 Defines a dependency between two properties.
typedef std::map< iproperty
*, iproperty * > 
dependencies_t
 Defines a set of dependencies between properties - the map key is the dependent property and must not be NULL. The map value is the property it depends upon, and may be NULL.
typedef sigc::signal< void,
const dependencies_t & > 
dependency_signal_t
 Defines a signal that will be emitted whenever a set of dependencies are altered.

Public Member Functions

virtual void set_dependencies (dependencies_t &Dependencies, ihint *Hint=0)=0
 Updates dependencies between a set of properties.
virtual ipropertydependency (iproperty &Target)=0
 Returns the dependency for a given property - may return NULL for no dependency.
virtual const dependencies_tdependencies ()=0
 Returns the set of all dependencies between properties.
virtual dependency_signal_tdependency_signal ()=0

Protected Member Functions

 ipipeline ()
 ipipeline (const ipipeline &Other)
ipipelineoperator= (const ipipeline &)
virtual ~ipipeline ()

Detailed Description

Abstract interface for maintaining a collection of dependencies among properties ... a "pipeline".


Member Typedef Documentation

Defines a set of dependencies between properties - the map key is the dependent property and must not be NULL. The map value is the property it depends upon, and may be NULL.

typedef sigc::signal<void, const dependencies_t&> k3d::ipipeline::dependency_signal_t

Defines a signal that will be emitted whenever a set of dependencies are altered.

Defines a dependency between two properties.


Constructor & Destructor Documentation

k3d::ipipeline::ipipeline (  )  [inline, protected]
k3d::ipipeline::ipipeline ( const ipipeline Other  )  [inline, protected]
virtual k3d::ipipeline::~ipipeline (  )  [inline, protected, virtual]

Member Function Documentation

virtual const dependencies_t& k3d::ipipeline::dependencies (  )  [pure virtual]

Returns the set of all dependencies between properties.

Implemented in k3d::pipeline.

Referenced by k3d::detail::skip_node().

virtual iproperty* k3d::ipipeline::dependency ( iproperty Target  )  [pure virtual]
virtual dependency_signal_t& k3d::ipipeline::dependency_signal (  )  [pure virtual]

Implemented in k3d::pipeline.

ipipeline& k3d::ipipeline::operator= ( const ipipeline  )  [inline, protected]
virtual void k3d::ipipeline::set_dependencies ( dependencies_t Dependencies,
ihint Hint = 0 
) [pure virtual]

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

Generated on Mon Mar 21 07:41:56 2011 for K-3D by doxygen 1.6.3