openDAQ
Open data acquisition platform
DataRuleBuilderPtr Class Reference

Configuration component of Data rule objects. Contains setter methods that allow for Data rule parameter configuration, and a build method that builds the Data rule. More...

Inherits ObjectPtr< IDataRuleBuilder >.

Detailed Description

Configuration component of Data rule objects. Contains setter methods that allow for Data rule parameter configuration, and a build method that builds the Data rule.

Public Member Functions

daq::DataRulePtr build () const
 Builds and returns a Data rule object using the currently set values of the Builder. More...
 
DataRuleBuilderPtr setType (daq::DataRuleType type) const
 Sets the type of the data rule. More...
 
daq::DataRuleType getType () const
 Gets the type of the data rule. More...
 
DataRuleBuilderPtr setParameters (const daq::DictPtr< daq::IString, daq::IBaseObject > &parameters) const
 Sets a dictionary of string-object key-value pairs representing the parameters used to evaluate the rule. More...
 
daq::DictPtr< daq::IString, daq::IBaseObject > getParameters () const
 Gets a dictionary of string-object key-value pairs representing the parameters used to evaluate the rule. More...
 
DataRuleBuilderPtr addParameter (const daq::StringPtr &name, const daq::BaseObjectPtr &parameter) const
 Adds a string-object pair parameter to the Dictionary of Data rule parameters. More...
 
DataRuleBuilderPtr removeParameter (const daq::StringPtr &name) const
 Removes the parameter with the given name from the Dictionary of Data rule parameters.
 

Member Function Documentation

◆ addParameter()

DataRuleBuilderPtr addParameter ( const daq::StringPtr &  name,
const daq::BaseObjectPtr &  parameter 
) const
inline

Adds a string-object pair parameter to the Dictionary of Data rule parameters.

Parameters
nameThe string-type name of the parameter.
parameterThe object-type parameter.

◆ build()

daq::DataRulePtr build ( ) const
inline

Builds and returns a Data rule object using the currently set values of the Builder.

Returns
The built Data rule.

◆ getParameters()

daq::DictPtr<daq::IString, daq::IBaseObject> getParameters ( ) const
inline

Gets a dictionary of string-object key-value pairs representing the parameters used to evaluate the rule.

Returns
The dictionary containing the rule parameter members.

◆ getType()

daq::DataRuleType getType ( ) const
inline

Gets the type of the data rule.

Returns
The type of the data rule.

◆ setParameters()

DataRuleBuilderPtr setParameters ( const daq::DictPtr< daq::IString, daq::IBaseObject > &  parameters) const
inline

Sets a dictionary of string-object key-value pairs representing the parameters used to evaluate the rule.

Parameters
parametersThe dictionary containing the rule parameter members.

◆ setType()

DataRuleBuilderPtr setType ( daq::DataRuleType  type) const
inline

Sets the type of the data rule.

Parameters
typeThe type of the data rule.