Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY (LIBRARY_FACTORY, CoreEventArgs, CoreEventId, eventId, IString , eventName, IDict , parameters) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args with a given ID and custom parameters. More...

IPropertyObject IString IBaseObject IString path	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsPropertyObjectUpdateEnd, ICoreEventArgs, IPropertyObject , propOwner, IDict , updatedProperties, IString *, path) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when a property object is finished updating. More...

IPropertyObject IString IBaseObject IString path IPropertyObject IProperty IString path	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsPropertyRemoved, ICoreEventArgs, IPropertyObject , propOwner, IString , propName, IString *, path) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when a property is removed from a component. More...

CoreEventArgsPtr	CoreEventArgs (CoreEventId id, const StringPtr &name, const DictPtr< IString, IBaseObject > &parameters)
	Creates Core event args with a given ID and custom parameters. More...

CoreEventArgsPtr	CoreEventArgsPropertyValueChanged (const PropertyObjectPtr &propOwner, const StringPtr &propName, const BaseObjectPtr &value, const StringPtr &path)
	Creates Core event args that are passed as argument when a property value of a component is changed. More...

CoreEventArgsPtr	CoreEventArgsPropertyObjectUpdateEnd (const PropertyObjectPtr &propOwner, const DictPtr< IString, IBaseObject > &updatedProperties, const StringPtr &path)
	Creates Core event args that are passed as argument when a component is finished updating. More...

CoreEventArgsPtr	CoreEventArgsPropertyAdded (const PropertyObjectPtr &propOwner, const PropertyPtr &prop, const StringPtr &path)
	Creates Core event args that are passed as argument when a property is added to a component. More...

CoreEventArgsPtr	CoreEventArgsPropertyRemoved (const PropertyObjectPtr &propOwner, const StringPtr &propName, const StringPtr &path)
	Creates Core event args that are passed as argument when a property is removed from a component. More...

CoreEventArgsPtr	CoreEventArgsTypeAdded (const TypePtr &type)
	Creates Core event args that are passed as argument when a type is added to the type manager. More...

CoreEventArgsPtr	CoreEventArgsTypeRemoved (const StringPtr &typeName)
	Creates Core event args that are passed as argument when a type is removed from the type manager. More...

	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsComponentAdded, ICoreEventArgs, IComponent *, component) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when a new component is added as a child. More...

IString componentId	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsSignalConnected, ICoreEventArgs, ISignal *, signal) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when a signal is connected to an input port. More...

IString componentId ICoreEventArgs	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsDataDescriptorChanged, ICoreEventArgs, IDataDescriptor *, descriptor) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when the descriptor of a signal changes. More...

IString componentId ICoreEventArgs ICoreEventArgs	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsAttributeChanged, ICoreEventArgs, IString , attributeName, IBaseObject , attributeValue) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when a component's internal attribute is modified. More...

IString componentId ICoreEventArgs ICoreEventArgs IList tags	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, CoreEventArgsDeviceDomainChanged, ICoreEventArgs, IDeviceDomain *, deviceDomain) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates Core event args that are passed as argument when the domain of a device changes. More...

CoreEventArgsPtr	CoreEventArgsComponentAdded (const ComponentPtr &component)
	Creates Core event args that are passed as argument when a new component is added as a child. More...

CoreEventArgsPtr	CoreEventArgsComponentRemoved (const StringPtr &componentId)
	Creates Core event args that are passed as argument when a component is removed from the list of children. More...

CoreEventArgsPtr	CoreEventArgsSignalConnected (const SignalPtr &signal)
	Creates Core event args that are passed as argument when a signal is connected to an input port. More...

CoreEventArgsPtr	CoreEventArgsDataDescriptorChanged (const DataDescriptorPtr &descriptor)
	Creates Core event args that are passed as argument when the descriptor of a signal changes. More...

CoreEventArgsPtr	CoreEventArgsAttributeChanged (const StringPtr &attributeName, const BaseObjectPtr &attributeValue)
	Creates Core event args that are passed as argument when a component's internal attribute is modified. More...

CoreEventArgsPtr	CoreEventArgsTagsChanged (const ListPtr< IString > &tags)
	Creates Core event args that are passed as argument when a tag is added/removed from a component. More...

CoreEventArgsPtr	CoreEventArgsDeviceDomainChanged (const DeviceDomainPtr &deviceDomain)
	Creates Core event args that are passed as argument when the domain of a device changes. More...

CoreEventArgsPtr	CoreEventArgsDeviceLockStateChanged (Bool isLocked)
	Creates Core event args that are passed as argument when the device is locked or unlocked. More...

Variables
IString componentId	CoreEventArgsSignalDisconnected ()
	Creates Core event args that are passed as argument when a signal is connected to an input port. More...

IString componentId ICoreEventArgs	CoreEventArgsComponentUpdateEnd ()
	Creates Core event args that are passed as argument when a component is finished updating. More...

Function Documentation

◆ CoreEventArgs()

CoreEventArgsPtr CoreEventArgs	(	CoreEventId	id,
		const StringPtr &	name,
		const DictPtr< IString, IBaseObject > &	parameters
	)

inline

Creates Core event args with a given ID and custom parameters.

Parameters

id	The ID of the event. If the ID is not equal to one of the pre-defined IDs, the event name will be "Unknown".
parameters	The parameters of the event.

◆ CoreEventArgsAttributeChanged()

CoreEventArgsPtr CoreEventArgsAttributeChanged	(	const StringPtr &	attributeName,
		const BaseObjectPtr &	attributeValue
	)

inline

Creates Core event args that are passed as argument when a component's internal attribute is modified.

Parameters

attributeName	The name of the changed attribute.
attributeValue	The new value of the attribute.

An example of such attribute are the "Active" and "Visible" states of a component.

The ID of the event is 100, and the event name is "AttributeChanged".

◆ CoreEventArgsComponentAdded()

CoreEventArgsPtr CoreEventArgsComponentAdded ( const ComponentPtr & component )

inline

Creates Core event args that are passed as argument when a new component is added as a child.

Parameters

component The added component.

The sender of the event is always the parent component. The ID of the event is 40, and the event name is "ComponentAdded".

◆ CoreEventArgsComponentRemoved()

CoreEventArgsPtr CoreEventArgsComponentRemoved ( const StringPtr & componentId )

inline

Creates Core event args that are passed as argument when a component is removed from the list of children.

Parameters

componentId The local ID of the removed component.

The sender of the event is always the parent of the removed component.

The ID of the event is 50, and the event name is "ComponentRemoved".

◆ CoreEventArgsDataDescriptorChanged()

CoreEventArgsPtr CoreEventArgsDataDescriptorChanged ( const DataDescriptorPtr & descriptor )

inline

Creates Core event args that are passed as argument when the descriptor of a signal changes.

Parameters

descriptor The new descriptor.

The sender of the event is always the signal of which descriptor was changed.

The ID of the event is 80, and the event name is "DataDescriptorChanged".

◆ CoreEventArgsDeviceDomainChanged()

CoreEventArgsPtr CoreEventArgsDeviceDomainChanged ( const DeviceDomainPtr & deviceDomain )

inline

Creates Core event args that are passed as argument when the domain of a device changes.

Parameters

deviceDomain The new device domain

The ID of the event is 150, and the event name is "DeviceDomainChanged".

◆ CoreEventArgsDeviceLockStateChanged()

CoreEventArgsPtr CoreEventArgsDeviceLockStateChanged ( Bool isLocked )

inline

Creates Core event args that are passed as argument when the device is locked or unlocked.

Parameters

isLocked New lock state of the device.

The ID of the event is 160, and the event name is "DeviceLockStateChanged".

◆ CoreEventArgsPropertyAdded()

CoreEventArgsPtr CoreEventArgsPropertyAdded	(	const PropertyObjectPtr &	propOwner,
		const PropertyPtr &	prop,
		const StringPtr &	path
	)

inline

Creates Core event args that are passed as argument when a property is added to a component.

Parameters

propOwner	The property object that owns the added property.
prop	The property that was added.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

◆ CoreEventArgsPropertyObjectUpdateEnd()

CoreEventArgsPtr CoreEventArgsPropertyObjectUpdateEnd	(	const PropertyObjectPtr &	propOwner,
		const DictPtr< IString, IBaseObject > &	updatedProperties,
		const StringPtr &	path
	)

inline

Creates Core event args that are passed as argument when a component is finished updating.

Parameters

propOwner	The property object that was updated.
updatedProperties	The dictionary of updated properties. Contains the name (string) of a property as key, and the new value (base object) as the dictionary value.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id.

A component finished updating when endUpdate is called, or at the end of the update call.

◆ CoreEventArgsPropertyRemoved()

CoreEventArgsPtr CoreEventArgsPropertyRemoved	(	const PropertyObjectPtr &	propOwner,
		const StringPtr &	propName,
		const StringPtr &	path
	)

inline

Creates Core event args that are passed as argument when a property is removed from a component.

Parameters

propOwner	The property object that owned the removed property.
propName	The name of the property that was removed.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

◆ CoreEventArgsPropertyValueChanged()

CoreEventArgsPtr CoreEventArgsPropertyValueChanged	(	const PropertyObjectPtr &	propOwner,
		const StringPtr &	propName,
		const BaseObjectPtr &	value,
		const StringPtr &	path
	)

inline

Creates Core event args that are passed as argument when a property value of a component is changed.

Parameters

propOwner	The property object that owns the changed property.
propName	The name of the property of which value was changed.
value	The new value of the property.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

◆ CoreEventArgsSignalConnected()

CoreEventArgsPtr CoreEventArgsSignalConnected ( const SignalPtr & signal )

inline

Creates Core event args that are passed as argument when a signal is connected to an input port.

Parameters

signal The connected signal.

The sender of the event is always the input port into which the signal was connected.

The ID of the event is 60, and the event name is "SignalConnected".

◆ CoreEventArgsTagsChanged()

CoreEventArgsPtr CoreEventArgsTagsChanged ( const ListPtr< IString > & tags )

inline

Creates Core event args that are passed as argument when a tag is added/removed from a component.

Parameters

tags	The list of tags (as strings).

The ID of the event is 110, and the event name is "TagsChanged".

◆ CoreEventArgsTypeAdded()

CoreEventArgsPtr CoreEventArgsTypeAdded ( const TypePtr & type )

inline

Creates Core event args that are passed as argument when a type is added to the type manager.

Parameters

type	The type that was added.

The ID of the event is 130, and the event name is "TypeAdded".

◆ CoreEventArgsTypeRemoved()

CoreEventArgsPtr CoreEventArgsTypeRemoved ( const StringPtr & typeName )

inline

Creates Core event args that are passed as argument when a type is removed from the type manager.

Parameters

typeName The name of the removed type

The ID of the event is 140, and the event name is "TypeRemoved".

◆ OPENDAQ_DECLARE_CLASS_FACTORY()

OPENDAQ_DECLARE_CLASS_FACTORY	(	LIBRARY_FACTORY	,
		CoreEventArgs	,
		CoreEventId	,
		eventId	,
		IString *	,
		eventName	,
		IDict *	,
		parameters
	)

Creates Core event args with a given ID and custom parameters.

Parameters

eventId	The ID of the event. If the ID is not equal to one of the pre-defined IDs, the event name will be "Unknown".
parameters	The parameters of the event.

Creates Core event args that are passed as argument when a property value of a component is changed.

Parameters

propOwner	The property object that owns the changed property.
propName	The name of the property of which value was changed.
value	The new value of the property.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

The ID of the event is 0, and the event name is "PropertyValueChanged".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/7]

IString componentId ICoreEventArgs ICoreEventArgs OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsAttributeChanged	,
		ICoreEventArgs	,
		IString *	,
		attributeName	,
		IBaseObject *	,
		attributeValue
	)

Creates Core event args that are passed as argument when a component's internal attribute is modified.

Parameters

attributeName	The name of the changed attribute.
attributeValue	The new value of the attribute.

An example of such attribute are the "Active" and "Visible" states of a component.

The ID of the event is 100, and the event name is "AttributeChanged".

Creates Core event args that are passed as argument when a tag is added/removed from a component.

Parameters

tags	The list of tags (as strings).

The ID of the event is 110, and the event name is "TagsChanged".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/7]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsComponentAdded	,
		ICoreEventArgs	,
		IComponent *	,
		component
	)

Creates Core event args that are passed as argument when a new component is added as a child.

Parameters

component The added component.

The sender of the event is always the parent component. The ID of the event is 40, and the event name is "ComponentAdded".

Creates Core event args that are passed as argument when a component is removed from the list of children.

Parameters

componentId The local ID of the removed component.

The sender of the event is always the parent of the removed component.

The ID of the event is 50, and the event name is "ComponentRemoved".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/7]

IString componentId ICoreEventArgs OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsDataDescriptorChanged	,
		ICoreEventArgs	,
		IDataDescriptor *	,
		descriptor
	)

Creates Core event args that are passed as argument when the descriptor of a signal changes.

Parameters

descriptor The new descriptor.

The sender of the event is always the signal of which descriptor was changed.

The ID of the event is 80, and the event name is "DataDescriptorChanged".

Creates Core event args that are passed as argument when a component is finished updating.

A component finished updating at the end of the update call. The ID of the event is 90, and the event name is "ComponentUpdateEnd".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/7]

IString componentId ICoreEventArgs ICoreEventArgs IList tags OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsDeviceDomainChanged	,
		ICoreEventArgs	,
		IDeviceDomain *	,
		deviceDomain
	)

Creates Core event args that are passed as argument when the domain of a device changes.

Parameters

deviceDomain The new device domain

The ID of the event is 150, and the event name is "DeviceDomainChanged".

Creates Core event args that are passed as argument when the device is locked or unlocked.

Parameters

isLock New lock state of the device.

The ID of the event is 160, and the event name is "DeviceLockStateChanged".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [5/7]

IPropertyObject IString IBaseObject IString path OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsPropertyObjectUpdateEnd	,
		ICoreEventArgs	,
		IPropertyObject *	,
		propOwner	,
		IDict *	,
		updatedProperties	,
		IString *	,
		path
	)

Creates Core event args that are passed as argument when a property object is finished updating.

Parameters

propOwner	The property object that was updated.
updatedProperties	The dictionary of updated properties. Contains the name (string) of a property as key, and the new value (base object) as the dictionary value.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id.

A property object finished updating when endUpdate is called, or at the end of the update call. The ID of the event is 10, and the event name is "PropertyObjectUpdateEnd".

Creates Core event args that are passed as argument when a property is added to a component.

Parameters

propOwner	The property object that owns the added property.
prop	The property that was added.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

The ID of the event is 20, and the event name is "PropertyAdded".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [6/7]

IPropertyObject IString IBaseObject IString path IPropertyObject IProperty IString path OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsPropertyRemoved	,
		ICoreEventArgs	,
		IPropertyObject *	,
		propOwner	,
		IString *	,
		propName	,
		IString *	,
		path
	)

Creates Core event args that are passed as argument when a property is removed from a component.

Parameters

propOwner	The property object that owned the removed property.
propName	The name of the property that was removed.
path	The relative path to the property owner from the sender component. Used for object-type properties. Eg. "child1.child2". Does not include the Component id and property name.

The ID of the event is 30, and the event name is "PropertyRemoved".

Creates Core event args that are passed as argument when a type is added to the type manager.

Parameters

type	The type that was added.

The ID of the event is 130, and the event name is "TypeAdded".

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [7/7]

IString componentId OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		CoreEventArgsSignalConnected	,
		ICoreEventArgs	,
		ISignal *	,
		signal
	)

Creates Core event args that are passed as argument when a signal is connected to an input port.

Parameters

signal The connected signal.

The sender of the event is always the input port into which the signal was connected.

The ID of the event is 60, and the event name is "SignalConnected".

Creates Core event args that are passed as argument when a signal is connected to an input port.

The sender of the event is always the input port from which the signal was disconnected. The parameters of this event are empty.

The ID of the event is 70, and the event name is "SignalDisconnected".

Variable Documentation

◆ CoreEventArgsComponentUpdateEnd

CoreEventArgsPtr CoreEventArgsComponentUpdateEnd ( )

inline

Creates Core event args that are passed as argument when a component is finished updating.

A component finished updating at the end of the update call. The ID of the event is 90, and the event name is "ComponentUpdateEnd".

◆ CoreEventArgsSignalDisconnected

CoreEventArgsPtr CoreEventArgsSignalDisconnected ( )

inline

Creates Core event args that are passed as argument when a signal is connected to an input port.

The sender of the event is always the input port from which the signal was disconnected. The parameters of this event are empty.

The ID of the event is 70, and the event name is "SignalDisconnected".

	openDAQ Open data acquisition platform

Detailed Description

Functions

Variables

Function Documentation

◆ CoreEventArgs()

◆ CoreEventArgsAttributeChanged()

◆ CoreEventArgsComponentAdded()

◆ CoreEventArgsComponentRemoved()

◆ CoreEventArgsDataDescriptorChanged()

◆ CoreEventArgsDeviceDomainChanged()

◆ CoreEventArgsDeviceLockStateChanged()

◆ CoreEventArgsPropertyAdded()

◆ CoreEventArgsPropertyObjectUpdateEnd()

◆ CoreEventArgsPropertyRemoved()

◆ CoreEventArgsPropertyValueChanged()

◆ CoreEventArgsSignalConnected()

◆ CoreEventArgsTagsChanged()

◆ CoreEventArgsTypeAdded()

◆ CoreEventArgsTypeRemoved()

◆ OPENDAQ_DECLARE_CLASS_FACTORY()

◆ 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]

Variable Documentation

◆ CoreEventArgsComponentUpdateEnd

◆ CoreEventArgsSignalDisconnected