OMQ::UserApi::QorusConfigurationItemProvider Class Reference

Base class for object providing configuration items. More...

Inheritance diagram for OMQ::UserApi::QorusConfigurationItemProvider:

Public Member Methods
final *hash< string, hash< ConfigItemInfo > >	getConfigItems ()
	Method to return local configuration items. More...
*hash< string, hash< ConfigItemInfo > >	getConfigItemsImpl ()
	Method to return local configuration items; this method should be overridden by child classes to provide item configuration. More...

Detailed Description

Base class for object providing configuration items.

Member Function Documentation

getConfigItems()

final *hash< string, hash< ConfigItemInfo > > OMQ::UserApi::QorusConfigurationItemProvider::getConfigItems

(

)

Method to return local configuration items.

Returns

a hash of local configuration items

This is executed by oload when the object is loaded. The base class implementation returns no value.

Note

• If any configuration items have an invalid type, an error is raised
• Child classes should override getConfigItemsImpl(); this method cannot be overridden

getConfigItemsImpl()

*hash< string, hash< ConfigItemInfo > > OMQ::UserApi::QorusConfigurationItemProvider::getConfigItemsImpl

(

)

Method to return local configuration items; this method should be overridden by child classes to provide item configuration.

Returns

a hash of local configuration items

This is executed by getConfigItems() by oload: Data Loading Tool and Schema Manager when the object is loaded into the system. The base class implementation is empty and returns no value.

Note

If any configuration items have an invalid type, an error is raised

---

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

• QorusConfigurationItemProvider.qc