ReadOnlySpecific

template <class Element, class ValueType> class ReadOnlySpecific

The ReadOnlySpecific class defines specific values for 'readOnly'-element.

Functions

Name	Description
initialValue	The initialValue method serves for setting up the initial value reported for this parameter.
defaultValue	The defaultValue method is the same as initialValue val : Initial value Return : reference to the Element for proper methods chaining
initialValueFromString	The initialValueFromString method enables setting up a default value in a form of a string.
archivePolicy	Set the archiving policy for this element.
commit	Registers this element into the Schema
observerAccess	The observerAccess method serves for setting up the required access level attribute to be OBSERVER.
operatorAccess	The operatorAccess method serves for setting up the required access level attribute to be OPERATOR.
expertAccess	The expertAccess method serves for setting up the required access level attribute to be EXPERT.

Function Details

archivePolicy

ReadOnlySpecific& archivePolicy(const Schema::ArchivePolicy& value)

Set the archiving policy for this element. Available settings are:

EVERY_EVENT, EVERY_100MS, EVERY_1S, EVERY_5S, EVERY_10S, EVERY_1MIN, EVERY_10MIN, NO_ARCHIVING

value :

Return :

commit

void commit()

Registers this element into the Schema

defaultValue

ReadOnlySpecific& defaultValue(const ValueType& initialValue)

The defaultValue method is the same as initialValue

val : Initial value

Return : reference to the Element for proper methods chaining

expertAccess

ReadOnlySpecific& expertAccess()

The expertAccess method serves for setting up the required access level attribute to be EXPERT.

Return : reference to the Element (to allow method's chaining)

initialValue

ReadOnlySpecific& initialValue(const ValueType& initialValue)

The initialValue method serves for setting up the initial value reported for this parameter.

val : Initial value

Return : reference to the Element for proper methods chaining

initialValueFromString

ReadOnlySpecific& initialValueFromString(const std::string& initialValue)

The initialValueFromString method enables setting up a default value in a form of a string. DEPRECATED! For vectors use list initialisation: initialValue({1, 2, 3})

defaultValue : A string representation of the default value

Return : reference to the Element for proper methods chaining

observerAccess

ReadOnlySpecific& observerAccess()

The observerAccess method serves for setting up the required access level attribute to be OBSERVER.

Return : reference to the Element (to allow method's chaining)

operatorAccess

ReadOnlySpecific& operatorAccess()

The operatorAccess method serves for setting up the required access level attribute to be OPERATOR.

Return : reference to the Element (to allow method's chaining)