Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, PropertyBuilder, IPropertyBuilder, IString *, name) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates an Property builder object with only the name field configured. More...

IString IBoolean defaultValue	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, IntPropertyBuilder, IPropertyBuilder, IString , name, IInteger , defaultValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates an integer Property builder object with a specified name and default value. More...

IString IBoolean defaultValue IString IFloat defaultValue	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, StringPropertyBuilder, IPropertyBuilder, IString , name, IString , defaultValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a string Property builder object with a specified name and default value. More...

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, DictPropertyBuilder, IPropertyBuilder, IString , name, IDict , defaultValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a dictionary Property builder object with a specified name and default value. More...

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, ObjectPropertyBuilder, IPropertyBuilder, IString , name, IPropertyObject , defaultValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates an object-type Property builder object with a specified name and default value.. More...

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue IString IEvalValue referencedPropertyEval	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, FunctionPropertyBuilder, IPropertyBuilder, IString , name, ICallableInfo , callableInfo) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a function- or procedure-type Property builder object. Requires the a CallableInfo object to specify the argument type/count and function return type. More...

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue IString IEvalValue referencedPropertyEval IString IList IInteger defaultValue	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, SparseSelectionPropertyBuilder, IPropertyBuilder, IString , name, IDict , selectionValues, IInteger *, defaultValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a Selection Property builder object with a dictionary of selection values. The default value is an integer key into the provided dictionary. More...

PropertyBuilderPtr	PropertyBuilder (const StringPtr &name)
	Creates an Property builder object with only the name field configured. More...

PropertyPtr	BoolProperty (const StringPtr &name, const BooleanPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a boolean Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	BoolPropertyBuilder (const StringPtr &name, const BooleanPtr &defaultValue)
	Creates a boolean Property builder object with a specified name and default value. More...

PropertyPtr	IntProperty (const StringPtr &name, const IntegerPtr &defaultValue, const BooleanPtr &visible=true)
	Creates an integer Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	IntPropertyBuilder (const StringPtr &name, const IntegerPtr &defaultValue)
	Creates an integer Property builder object with a specified name and default value. More...

PropertyPtr	FloatProperty (const StringPtr &name, const FloatPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a floating point value Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	FloatPropertyBuilder (const StringPtr &name, const FloatPtr &defaultValue)
	Creates a floating point value Property builder object with a specified name and default value. More...

PropertyPtr	StringProperty (const StringPtr &name, const StringPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a string Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	StringPropertyBuilder (const StringPtr &name, const StringPtr &defaultValue)
	Creates a string Property builder object with a specified name and default value. More...

PropertyPtr	ListProperty (const StringPtr &name, const ListPtr< IBaseObject > &defaultValue, const BooleanPtr &visible=true)
	Creates a list Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	ListPropertyBuilder (const StringPtr &name, const ListPtr< IBaseObject > &defaultValue)
	Creates a list Property builder object with a specified name and default value. More...

PropertyPtr	DictProperty (const StringPtr &name, const DictPtr< IBaseObject, IBaseObject > &defaultValue, const BooleanPtr &visible=true)
	Creates a dictionary Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	DictPropertyBuilder (const StringPtr &name, const DictPtr< IBaseObject, IBaseObject > &defaultValue)
	Creates a dictionary Property builder object with a specified name and default value. More...

PropertyPtr	RatioProperty (const StringPtr &name, const RatioPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a ratio Property object with a default value and optional Visible state. More...

PropertyBuilderPtr	RatioPropertyBuilder (const StringPtr &name, const RatioPtr &defaultValue)
	Creates a ratio Property builder object with a specified name and default value. More...

PropertyPtr	ObjectProperty (const StringPtr &name, const PropertyObjectPtr &defaultValue=nullptr)
	Creates an object-type config object with a default value. More...

PropertyBuilderPtr	ObjectPropertyBuilder (const StringPtr &name, const PropertyObjectPtr &defaultValue=nullptr)
	Creates an object-type Property builder object with a specified name and default value.. More...

PropertyPtr	FunctionProperty (const StringPtr &name, const CallableInfoPtr &callableInfo, const BooleanPtr &visible=true)
	Creates a function- or procedure-type Property object. Requires the a CallableInfo object to specify the argument type/count and function return type. More...

PropertyBuilderPtr	FunctionPropertyBuilder (const StringPtr &name, const CallableInfoPtr &callableInfo)
	Creates a function- or procedure-type Property builder object. Requires the a CallableInfo object to specify the argument type/count and function return type. More...

PropertyPtr	ReferenceProperty (const StringPtr &name, const EvalValuePtr &referencedPropertyEval)
	Creates a Reference Property object that points at a property specified in the `referencedProperty` parameter. More...

PropertyBuilderPtr	ReferencePropertyBuilder (const StringPtr &name, const EvalValuePtr &referencedPropertyEval)
	Creates a Reference Property builder object that points at a property specified in the `referencedProperty` parameter. More...

PropertyPtr	SelectionProperty (const StringPtr &name, const ListPtr< IBaseObject > &selectionValues, const IntegerPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a Selection Property object with a list of selection values. The default value is an integer index into the default selected value. More...

PropertyBuilderPtr	SelectionPropertyBuilder (const StringPtr &name, const ListPtr< IBaseObject > &selectionValues, const IntegerPtr &defaultValue)
	Creates a Selection Property builder object with a list of selection values. The default value is an integer index into the default selected value. More...

PropertyPtr	SparseSelectionProperty (const StringPtr &name, const DictPtr< Int, IBaseObject > &selectionValues, const IntegerPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a Selection Property object with a dictionary of selection values. The default value is an integer key into the provided dictionary. More...

PropertyBuilderPtr	SparseSelectionPropertyBuilder (const StringPtr &name, const DictPtr< Int, IBaseObject > &selectionValues, const IntegerPtr &defaultValue)
	Creates a Selection Property builder object with a dictionary of selection values. The default value is an integer key into the provided dictionary. More...

PropertyPtr	StructProperty (const StringPtr &name, const StructPtr &defaultValue, const BooleanPtr &visible=true)
	Creates a Struct Property object with a default value and its visible state. More...

PropertyBuilderPtr	StructPropertyBuilder (const StringPtr &name, const StructPtr &defaultValue)
	Creates a Struct Property builder object with a specified name and default value. More...

PropertyPtr	EnumerationProperty (const StringPtr &name, const EnumerationPtr &defaultValue, const BooleanPtr &visible=true)
	Creates an Enumeration Property object with a default value and its visible state. More...

PropertyBuilderPtr	EnumerationPropertyBuilder (const StringPtr &name, const EnumerationPtr &defaultValue)
	Creates an Enumeration Property builder object with a specified name and default value. More...

PropertyPtr	PropertyFromBuilder (const PropertyBuilderPtr &builder)
	Creates a Property using Builder. More...

Function Documentation

◆ BoolProperty()

PropertyPtr BoolProperty	(	const StringPtr &	name,
		const BooleanPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a boolean Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The boolean default value. Can be an EvalValue.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctBool. Note that the defaultValue and visible parameters can be EvalValues.

◆ BoolPropertyBuilder()

PropertyBuilderPtr BoolPropertyBuilder	(	const StringPtr &	name,
		const BooleanPtr &	defaultValue
	)

inline

Creates a boolean Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The boolean default value. Can be an EvalValue.

The Property Value type is ctBool. Note that the defaultValue parameter can be EvalValue.

◆ DictProperty()

PropertyPtr DictProperty	(	const StringPtr &	name,
		const DictPtr< IBaseObject, IBaseObject > &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a dictionary Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The dictionary default value.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctDict. The visible parameter can be an EvalValue. The dictionary passed as default value must have homogeneous key and value lists.

The Property's Item type field will be set according to defaultValue dictionary Item type. The same goes for the Key type.

TODO: defaultValue can be an EvalValue once dictionaries are supported.

◆ DictPropertyBuilder()

PropertyBuilderPtr DictPropertyBuilder	(	const StringPtr &	name,
		const DictPtr< IBaseObject, IBaseObject > &	defaultValue
	)

inline

Creates a dictionary Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The dictionary default value.

The Property Value type is ctDict. The dictionary passed as default value must have homogeneous key and value lists (all dictionary keys/values must be of the same type).

The Property's Item type field will be set according to defaultValue dictionary Item type. The same goes for the Key type.

TODO: defaultValue can be an EvalValue once dictionaries are supported.

◆ EnumerationProperty()

PropertyPtr EnumerationProperty	(	const StringPtr &	name,
		const EnumerationPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates an Enumeration Property object with a default value and its visible state.

Parameters

name	The name of the Property.
defaultValue	The default enumeration value.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctEnumeration.

◆ EnumerationPropertyBuilder()

PropertyBuilderPtr EnumerationPropertyBuilder	(	const StringPtr &	name,
		const EnumerationPtr &	defaultValue
	)

inline

Creates an Enumeration Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The default enumeration value.

The Property Value type is ctEnumeration.

◆ FloatProperty()

PropertyPtr FloatProperty	(	const StringPtr &	name,
		const FloatPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a floating point value Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The float default value. Can be an EvalValue.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctFloat. Note that the defaultValue and visible parameters can be EvalValues.

◆ FloatPropertyBuilder()

PropertyBuilderPtr FloatPropertyBuilder	(	const StringPtr &	name,
		const FloatPtr &	defaultValue
	)

inline

Creates a floating point value Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The float default value. Can be an EvalValue

The Property Value type is ctFloat. Note that the defaultValue parameter can be EvalValue.

◆ FunctionProperty()

PropertyPtr FunctionProperty	(	const StringPtr &	name,
		const CallableInfoPtr &	callableInfo,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a function- or procedure-type Property object. Requires the a CallableInfo object to specify the argument type/count and function return type.

Parameters

name	The name of the Property.
callableInfo	Information about the callable argument type/count and return type.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctFunction or ctProc, depending on if callableInfo contains information on the return type or not. Note that the visible parameter can be an EvalValue.

◆ FunctionPropertyBuilder()

PropertyBuilderPtr FunctionPropertyBuilder	(	const StringPtr &	name,
		const CallableInfoPtr &	callableInfo
	)

inline

Creates a function- or procedure-type Property builder object. Requires the a CallableInfo object to specify the argument type/count and function return type.

Parameters

name	The name of the Property.
callableInfo	Information about the callable argument type/count and return type.

The Property Value type is ctFunction or ctProc, depending on if callableInfo contains information on the return type or not.

◆ IntProperty()

PropertyPtr IntProperty	(	const StringPtr &	name,
		const IntegerPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates an integer Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctInt. Note that the defaultValue and visible parameters can be EvalValues.

◆ IntPropertyBuilder()

PropertyBuilderPtr IntPropertyBuilder	(	const StringPtr &	name,
		const IntegerPtr &	defaultValue
	)

inline

Creates an integer Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.

The Property Value type is ctInt. Note that the defaultValue parameter can be EvalValue.

◆ ListProperty()

PropertyPtr ListProperty	(	const StringPtr &	name,
		const ListPtr< IBaseObject > &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a list Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The list default value. Can be an EvalValue.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctList. Note that the defaultValue and visible parameters can be EvalValues. The list passed as defaultValue must be homogeneous.

The Property's Item type field will be set according to defaultValue list type.

◆ ListPropertyBuilder()

PropertyBuilderPtr ListPropertyBuilder	(	const StringPtr &	name,
		const ListPtr< IBaseObject > &	defaultValue
	)

inline

Creates a list Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The list default value. Can be an EvalValue.

The Property Value type is ctList. Note that the defaultValue parameter can be EvalValue. The list passed as defaultValue must be homogeneous.

The Property's Item type field will be set according to defaultValue list type.

◆ ObjectProperty()

PropertyPtr ObjectProperty	(	const StringPtr &	name,
		const PropertyObjectPtr &	defaultValue = `nullptr`
	)

inline

Creates an object-type config object with a default value.

Parameters

name	The name of the Property.
defaultValue	The Property object default value.

The Property Value type is ctObject. Object properties cannot be have any metadata other than their name, description, and default value configured. The PropertyObject default value can only be a base PropertyObject type (not a descendant type).

If the defaultValue is not specified, it will automatically be configured to an empty Property Object.

◆ ObjectPropertyBuilder()

PropertyBuilderPtr ObjectPropertyBuilder	(	const StringPtr &	name,
		const PropertyObjectPtr &	defaultValue = `nullptr`
	)

inline

Creates an object-type Property builder object with a specified name and default value..

Parameters

name	The name of the Property.
defaultValue	The Property object default value.

The Property Value type is ctObject. Object properties cannot be have any metadata other than their name, description, and default value configured. The PropertyObject default value can only be a base PropertyObject type (not a descendant type).

If the defaultValue is not specified, it will automatically be configured to an empty Property Object.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/7]

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		DictPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		IDict *	,
		defaultValue
	)

Creates a dictionary Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The dictionary default value.

The Property Value type is ctDict. The dictionary passed as default value must have homogeneous key and value lists (all dictionary keys/values must be of the same type).

The Property's Item type field will be set according to defaultValue dictionary Item type. The same goes for the Key type.

TODO: defaultValue can be an EvalValue once dictionaries are supported.

Creates a ratio Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The ratio default value.

The Property Value type is ctRatio.

TODO: defaultValue can be an EvalValue once ratios are supported.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/7]

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue IString IEvalValue referencedPropertyEval OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		FunctionPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		ICallableInfo *	,
		callableInfo
	)

Creates a function- or procedure-type Property builder object. Requires the a CallableInfo object to specify the argument type/count and function return type.

Parameters

name	The name of the Property.
callableInfo	Information about the callable argument type/count and return type.

The Property Value type is ctFunction or ctProc, depending on if callableInfo contains information on the return type or not.

Creates a Selection Property builder object with a list of selection values. The default value is an integer index into the default selected value.

Parameters

name	The name of the Property.
selectionValues	The list of selectable values.
defaultValue	The default index into the list of selection values.

The Property Value type is ctInt.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/7]

IString IBoolean defaultValue OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		IntPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		IInteger *	,
		defaultValue
	)

Creates an integer Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.

The Property Value type is ctInt. Note that the defaultValue parameter can be EvalValue.

Creates a floating point value Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The float default value. Can be an EvalValue

The Property Value type is ctFloat. Note that the defaultValue parameter can be EvalValue.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/7]

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		ObjectPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		IPropertyObject *	,
		defaultValue
	)

Creates an object-type Property builder object with a specified name and default value..

Parameters

name	The name of the Property.
defaultValue	The Property object default value.

The Property Value type is ctObject. Object properties cannot be have any metadata other than their name, description, and default value configured. The PropertyObject default value can only be a base PropertyObject type (not a descendant type).

If the defaultValue is not specified, it will automatically be configured to an empty Property Object.

Creates a Reference Property builder object that points at a property specified in the referencedProperty parameter.

Parameters

name	The name of the Property.
referencedPropertyEval	The evaluation expression that evaluates to another property.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [5/7]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		PropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name
	)

Creates an Property builder object with only the name field configured.

Parameters

name	The name of the Property.

The default Value type is ctUndefined.

Creates a boolean Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The boolean default value. Can be an EvalValue.

The Property Value type is ctBool. Note that the defaultValue parameter can be EvalValue.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [6/7]

IString IBoolean defaultValue IString IFloat defaultValue IString IList defaultValue IString IRatio defaultValue IString IEvalValue referencedPropertyEval IString IList IInteger defaultValue OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		SparseSelectionPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		IDict *	,
		selectionValues	,
		IInteger *	,
		defaultValue
	)

Creates a Selection Property builder object with a dictionary of selection values. The default value is an integer key into the provided dictionary.

Parameters

name	The name of the Property.
selectionValues	The dictionary of selectable values. The key type must be `ctInt`.
defaultValue	The default key into the list of selection values.

The Property Value type is ctInt. The key type of the Selection values dictionary must be ctInt.

Creates a Struct Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The default structure value.

The Property Value type is ctStruct.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [7/7]

IString IBoolean defaultValue IString IFloat defaultValue OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		StringPropertyBuilder	,
		IPropertyBuilder	,
		IString *	,
		name	,
		IString *	,
		defaultValue
	)

Creates a string Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.

The Property Value type is ctString. Note that the defaultValue parameter can be EvalValue.

Creates a list Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The list default value. Can be an EvalValue.

The Property Value type is ctList. Note that the defaultValue parameter can be EvalValue. The list passed as defaultValue must be homogeneous.

The Property's Item type field will be set according to defaultValue list type.

◆ PropertyBuilder()

PropertyBuilderPtr PropertyBuilder ( const StringPtr & name )

inline

Creates an Property builder object with only the name field configured.

The default Value type is ctUndefined.

◆ PropertyFromBuilder()

PropertyPtr PropertyFromBuilder ( const PropertyBuilderPtr & builder )

inline

Creates a Property using Builder.

Parameters

builder Property Builder

◆ RatioProperty()

PropertyPtr RatioProperty	(	const StringPtr &	name,
		const RatioPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a ratio Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The ratio default value.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctRatio. Note that the visible parameter can be an EvalValue.

TODO: defaultValue can be an EvalValue once ratios are supported.

◆ RatioPropertyBuilder()

PropertyBuilderPtr RatioPropertyBuilder	(	const StringPtr &	name,
		const RatioPtr &	defaultValue
	)

inline

Creates a ratio Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The ratio default value.

The Property Value type is ctRatio.

TODO: defaultValue can be an EvalValue once ratios are supported.

◆ ReferenceProperty()

PropertyPtr ReferenceProperty	(	const StringPtr &	name,
		const EvalValuePtr &	referencedPropertyEval
	)

inline

Creates a Reference Property object that points at a property specified in the referencedProperty parameter.

Parameters

name	The name of the Property.
referencedPropertyEval	The evaluation expression that evaluates to another property.

◆ ReferencePropertyBuilder()

PropertyBuilderPtr ReferencePropertyBuilder	(	const StringPtr &	name,
		const EvalValuePtr &	referencedPropertyEval
	)

inline

Creates a Reference Property builder object that points at a property specified in the referencedProperty parameter.

Parameters

name	The name of the Property.
referencedPropertyEval	The evaluation expression that evaluates to another property.

◆ SelectionProperty()

PropertyPtr SelectionProperty	(	const StringPtr &	name,
		const ListPtr< IBaseObject > &	selectionValues,
		const IntegerPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a Selection Property object with a list of selection values. The default value is an integer index into the default selected value.

Parameters

name	The name of the Property.
selectionValues	The list of selectable values.
defaultValue	The default index into the list of selection values.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctInt.

◆ SelectionPropertyBuilder()

PropertyBuilderPtr SelectionPropertyBuilder	(	const StringPtr &	name,
		const ListPtr< IBaseObject > &	selectionValues,
		const IntegerPtr &	defaultValue
	)

inline

Creates a Selection Property builder object with a list of selection values. The default value is an integer index into the default selected value.

Parameters

name	The name of the Property.
selectionValues	The list of selectable values.
defaultValue	The default index into the list of selection values.

The Property Value type is ctInt.

◆ SparseSelectionProperty()

PropertyPtr SparseSelectionProperty	(	const StringPtr &	name,
		const DictPtr< Int, IBaseObject > &	selectionValues,
		const IntegerPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a Selection Property object with a dictionary of selection values. The default value is an integer key into the provided dictionary.

Parameters

name	The name of the Property.
selectionValues	The dictionary of selectable values. The key type must be `ctInt`.
defaultValue	The default key into the list of selection values.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctInt. The key type of the Selection values dictionary must be ctInt.

◆ SparseSelectionPropertyBuilder()

PropertyBuilderPtr SparseSelectionPropertyBuilder	(	const StringPtr &	name,
		const DictPtr< Int, IBaseObject > &	selectionValues,
		const IntegerPtr &	defaultValue
	)

inline

Creates a Selection Property builder object with a dictionary of selection values. The default value is an integer key into the provided dictionary.

Parameters

name	The name of the Property.
selectionValues	The dictionary of selectable values. The key type must be `ctInt`.
defaultValue	The default key into the list of selection values.

The Property Value type is ctInt. The key type of the Selection values dictionary must be ctInt.

◆ StringProperty()

PropertyPtr StringProperty	(	const StringPtr &	name,
		const StringPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a string Property object with a default value and optional Visible state.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctString. Note that the defaultValue and visible parameters can be EvalValues.

◆ StringPropertyBuilder()

PropertyBuilderPtr StringPropertyBuilder	(	const StringPtr &	name,
		const StringPtr &	defaultValue
	)

inline

Creates a string Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The integer default value. Can be an EvalValue.

The Property Value type is ctString. Note that the defaultValue parameter can be EvalValue.

◆ StructProperty()

PropertyPtr StructProperty	(	const StringPtr &	name,
		const StructPtr &	defaultValue,
		const BooleanPtr &	visible = `true`
	)

inline

Creates a Struct Property object with a default value and its visible state.

Parameters

name	The name of the Property.
defaultValue	The default structure value.
visible	If true, the Property is visible. Can be an EvalValue.

The Property Value type is ctStruct.

◆ StructPropertyBuilder()

PropertyBuilderPtr StructPropertyBuilder	(	const StringPtr &	name,
		const StructPtr &	defaultValue
	)

inline

Creates a Struct Property builder object with a specified name and default value.

Parameters

name	The name of the Property.
defaultValue	The default structure value.

The Property Value type is ctStruct.

	openDAQ Open data acquisition platform

Detailed Description

Functions

Function Documentation

◆ BoolProperty()

◆ BoolPropertyBuilder()

◆ DictProperty()

◆ DictPropertyBuilder()

◆ EnumerationProperty()

◆ EnumerationPropertyBuilder()

◆ FloatProperty()

◆ FloatPropertyBuilder()

◆ FunctionProperty()

◆ FunctionPropertyBuilder()

◆ IntProperty()

◆ IntPropertyBuilder()

◆ ListProperty()

◆ ListPropertyBuilder()

◆ ObjectProperty()

◆ ObjectPropertyBuilder()

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [5/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [6/7]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [7/7]

◆ PropertyBuilder()

◆ PropertyFromBuilder()

◆ RatioProperty()

◆ RatioPropertyBuilder()

◆ ReferenceProperty()

◆ ReferencePropertyBuilder()

◆ SelectionProperty()

◆ SelectionPropertyBuilder()

◆ SparseSelectionProperty()

◆ SparseSelectionPropertyBuilder()

◆ StringProperty()

◆ StringPropertyBuilder()

◆ StructProperty()

◆ StructPropertyBuilder()