DigitalSpaces::DIAcceptConfiguration1 Struct Reference
[Interfaces, Generic Interfaces]

#include <Interfaces.h>

Inherits DigitalSpaces::DIObjectBase.

---

Detailed Description

DInterface used for configuring an implementation in a generic manner.

Almost all "Factory" implementations support this DInterface, both as a normal DInterface (so dss_cast<DIAcceptConfiguration1> or QueryInterface(&DIAcceptConfiguration1::DID) work), and other alternate DUID's that identify the type of configuration data being provided. This alternate DUID is the numeric string you see used in index.space files in <configuration> tags.

As a general rule, this DInterface was designed to allow the Core to pass <configuration> data to a components factory. It is sometimes used to configure poorly implemented components during run time, but should not generally be used this way. Also we recommend having some way of retriving any data that can be set here, to allow implementation of DIStoreConfiguration1.

See also:

DIAcceptSettingMap

Public Member Functions
bool	ParseConfiguration (DIXMLNode1 *)
	Provide configuration data to the implementation.

---

Member Function Documentation

bool DigitalSpaces::DIAcceptConfiguration1::ParseConfiguration

(

DIXMLNode1 *

)

Provide configuration data to the implementation.

Parameters:

DIXMLNode1

The root node of the configuation. When being configured by the core, this is the <configuration> node. The pointer to this configuration data should not be stored, as it will not exist after the function is returned. Any useful information should be read out and stored.

Returns:

Should return false if the information was not parsed. This does not indicate an error condition, just that the information was not useful.

Note:

Most implementations do not use the return value, as the current Core implementation discards the returned value.

As a general rule, all information that can be set with this function should be configurable with functions at run time.

---

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

• CoreInterfaces/Interfaces.h