Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

amire::component::ConfigurationPropertyExport Class Reference

List of all members.

Public Member Functions

 ConfigurationPropertyExport ()
virtual ~ConfigurationPropertyExport ()
virtual osg::ref_ptr< amire::property::StructPropertynewConfigurationProperty (const osg::ref_ptr< const ComposedComponent > &composedComponent) const
virtual void updateConfigurationProperty (const osg::ref_ptr< const ComposedComponent > &composedComponent, const osg::ref_ptr< amire::property::StructProperty > &configuration) const
virtual void updateComponents (const osg::ref_ptr< ComposedComponent > &composedComponent, const osg::ref_ptr< const amire::property::StructProperty > &configuration) const
virtual std::string getName () const
const std::string & getLibrary () const
void setLibrary (const std::string &libraryName)

Detailed Description

A ConfigurationPropertyExport implements a strategy to export the configuration properties of component instances from a composed component. The registration is initialized by the dynamically linked component library. The default export strategy is to export all configuration properties. Therefore, a new structured property type is created for each composed component prototype. This structured property ensures the seperatation of configuration properties by using the component's name as field name of its configuration property. Hence, a specific configration property inside a composed component can be accessed from the exported configuration property by using the name of the composed component. All virtual method have to be implemented for a new export strategy;


Constructor & Destructor Documentation

amire::component::ConfigurationPropertyExport::ConfigurationPropertyExport  ) 
 

virtual amire::component::ConfigurationPropertyExport::~ConfigurationPropertyExport  )  [virtual]
 


Member Function Documentation

const std::string& amire::component::ConfigurationPropertyExport::getLibrary  )  const
 

Returns the name of the component library, which provides this export strategy.

virtual std::string amire::component::ConfigurationPropertyExport::getName  )  const [virtual]
 

Returns the name of the configuration property export strategy.

virtual osg::ref_ptr<amire::property::StructProperty> amire::component::ConfigurationPropertyExport::newConfigurationProperty const osg::ref_ptr< const ComposedComponent > &  composedComponent  )  const [virtual]
 

Creates a new configuration property, which represents configuration properties of components inside the given composed component (or parts of them). The export may not cover all configuration properties, but it represents a strategy to configure the whole component network inside the composed component. This method is called by a composed component to create a new configuration property for itself.

void amire::component::ConfigurationPropertyExport::setLibrary const std::string &  libraryName  ) 
 

Sets the name of the component library, which provides this export strategy. This method is for internal use only.

virtual void amire::component::ConfigurationPropertyExport::updateComponents const osg::ref_ptr< ComposedComponent > &  composedComponent,
const osg::ref_ptr< const amire::property::StructProperty > &  configuration
const [virtual]
 

This method is called by the component manager to update the given component's inside the composed component with the values provided by the given configuration property (which is conform to the export strategy).

virtual void amire::component::ConfigurationPropertyExport::updateConfigurationProperty const osg::ref_ptr< const ComposedComponent > &  composedComponent,
const osg::ref_ptr< amire::property::StructProperty > &  configuration
const [virtual]
 

This method is called by the component manager to update the given configuration property (which is conform to the export strategy) with the values of the component's (which are inside the composed component) configuration property. Therefore, the export strategy have to be used to update the values.


The documentation for this class was generated from the following file:
Generated on Tue May 20 17:23:57 2003 for AMIRE-Framework by doxygen1.3