 |
openDAQ
Open data acquisition platform
|
| |
|
openDAQ
Open data acquisition platform
|
|
| |
The top-level openDAQ object. It acts as container for the openDAQ context and the base module manager. More...
Inheritance diagram for IInstance: Collaboration diagram for IInstance:The top-level openDAQ object. It acts as container for the openDAQ context and the base module manager.
It forwards all Device and PropertyObject calls to the current root device, making the calls on the Instance and root device equivalent.
On creation, it creates a Client device - a default device implementation that can load any function blocks present in the module manager search path. If the native openDAQ client-module is loaded, the Client device can connect to any TMS enabled device by using the addDevice function. The Client is set as the root device when the instance is created.
Public Member Functions | |
| virtual ErrCode INTERFACE_FUNC | getModuleManager (IModuleManager **manager)=0 |
| Gets the Module manager. More... | |
| virtual ErrCode INTERFACE_FUNC | getRootDevice (IDevice **rootDevice)=0 |
| Gets the current root device. More... | |
| virtual ErrCode INTERFACE_FUNC | setRootDevice (IString *connectionString, IPropertyObject *config=nullptr)=0 |
| Adds a device with the connection string as root device. More... | |
| virtual ErrCode INTERFACE_FUNC | getAvailableServerTypes (IDict **serverTypes)=0 |
| Get a dictionary of available server types as <IString, IServerType> pairs. More... | |
| virtual ErrCode INTERFACE_FUNC | addStandardServers (IList **servers)=0 |
| Creates and adds streaming and "OpenDAQOPCUA" servers with default configurations. More... | |
| Public Member Functions inherited from IDevice | |
| virtual ErrCode INTERFACE_FUNC | getInfo (IDeviceInfo **info)=0 |
| Gets the device info. It contains data about the device such as the device's serial number, location, and connection string. More... | |
| virtual ErrCode INTERFACE_FUNC | getDomain (IDeviceDomain **domain)=0 |
| Gets the device's domain data. It allows for querying the device for its domain (time) values. More... | |
| virtual ErrCode INTERFACE_FUNC | getInputsOutputsFolder (IFolder **inputsOutputsFolder)=0 |
| Gets a folder containing channels. More... | |
| virtual ErrCode INTERFACE_FUNC | getCustomComponents (IList **customComponents)=0 |
| Gets a list of all components/folders in a device that are not titled 'IO', 'Sig', 'Dev', 'Synchronization' or 'FB'. More... | |
| virtual ErrCode INTERFACE_FUNC | getSignals (IList **signals, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a list of the device's signals. More... | |
| virtual ErrCode INTERFACE_FUNC | getSignalsRecursive (IList **signals, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a list of the signals that belong to the device. More... | |
| virtual ErrCode INTERFACE_FUNC | getChannels (IList **channels, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a flat list of the device's physical channels. More... | |
| virtual ErrCode INTERFACE_FUNC | getChannelsRecursive (IList **channels, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a flat list of the device's physical channels. Also finds all visible channels of visible child devices. More... | |
| virtual ErrCode INTERFACE_FUNC | getDevices (IList **devices, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a list of child devices that the device is connected to. More... | |
| virtual ErrCode INTERFACE_FUNC | getAvailableDevices (IList **availableDevices)=0 |
| Gets a list of available devices, containing their Device Info. More... | |
| virtual ErrCode INTERFACE_FUNC | getAvailableDeviceTypes (IDict **deviceTypes)=0 |
| Get a dictionary of available device types as <IString, IDeviceType> pairs. More... | |
| virtual ErrCode INTERFACE_FUNC | addDevice (IDevice **device, IString *connectionString, IPropertyObject *config=nullptr)=0 |
| Connects to a device at the given connection string and returns it. More... | |
| virtual ErrCode INTERFACE_FUNC | removeDevice (IDevice *device)=0 |
| Disconnects from the device provided as argument and removes it from the internal list of devices. More... | |
| virtual ErrCode INTERFACE_FUNC | getFunctionBlocks (IList **functionBlocks, ISearchFilter *searchFilter=nullptr)=0 |
| Gets the list of added function blocks. More... | |
| virtual ErrCode INTERFACE_FUNC | getAvailableFunctionBlockTypes (IDict **functionBlockTypes)=0 |
| Gets all function block types that are supported by the device, containing their description. More... | |
| virtual ErrCode INTERFACE_FUNC | addFunctionBlock (IFunctionBlock **functionBlock, IString *typeId, IPropertyObject *config=nullptr)=0 |
| Creates and adds a function block to the device with the provided unique ID and returns it. More... | |
| virtual ErrCode INTERFACE_FUNC | removeFunctionBlock (IFunctionBlock *functionBlock)=0 |
| Removes the function block provided as argument, disconnecting its signals and input ports. More... | |
| virtual ErrCode INTERFACE_FUNC | saveConfiguration (IString **configuration)=0 |
| Saves the configuration of the device to string. More... | |
| virtual ErrCode INTERFACE_FUNC | loadConfiguration (IString *configuration, IUpdateParameters *config=nullptr)=0 |
| Loads the configuration of the device from string. More... | |
| virtual ErrCode INTERFACE_FUNC | getTicksSinceOrigin (UInt *ticks)=0 |
| Gets the number of ticks passed since the device's absolute origin. More... | |
| virtual ErrCode INTERFACE_FUNC | addStreaming (IStreaming **streaming, IString *connectionString, IPropertyObject *config=nullptr)=0 |
| Connects to a streaming at the given connection string, adds it as a streaming source of device and returns created streaming object. More... | |
| virtual ErrCode INTERFACE_FUNC | createDefaultAddDeviceConfig (IPropertyObject **defaultConfig)=0 |
| Creates config object that can be used when adding a device. Contains Device and Streaming default configuration for all available Device/Streaming types. Also contains general add-device configuration settings. More... | |
| virtual ErrCode INTERFACE_FUNC | getSyncComponent (ISyncComponent **sync)=0 |
| Gets the sync component of the device. More... | |
| virtual ErrCode INTERFACE_FUNC | addServer (IString *typeId, IPropertyObject *config, IServer **server)=0 |
| Creates and adds to the device a server with the provided unique type ID and returns it. More... | |
| virtual ErrCode INTERFACE_FUNC | removeServer (IServer *server)=0 |
| Removes the server provided as argument. More... | |
| virtual ErrCode INTERFACE_FUNC | getServers (IList **servers)=0 |
| Get list of added servers. More... | |
| virtual ErrCode INTERFACE_FUNC | lock ()=0 |
| Lock a device with a session user. Once locked, no properties of the device can be changed via the protocol layer. Only the same user who locked the device can unlock it. If no user was specified when the device was locked, any user will be able to unlock it. | |
| virtual ErrCode INTERFACE_FUNC | unlock ()=0 |
| Unlock a device with a session user. A device can only be unlocked by the same user who locked it. If no user was specified when the device was locked, any user will be able to unlock it. | |
| virtual ErrCode INTERFACE_FUNC | isLocked (Bool *locked)=0 |
| Returns truee if device is locked. Once locked, no properties of the device can be changed via the protocol layer. More... | |
| virtual ErrCode INTERFACE_FUNC | getLogFileInfos (IList **logFileInfos)=0 |
| Gets a list of available log files. More... | |
| virtual ErrCode INTERFACE_FUNC | getLog (IString **log, IString *id, Int size=-1, Int offset=0)=0 |
| Retrieves a chunk of the log file with the provided ID. More... | |
| Public Member Functions inherited from IFolder | |
| virtual ErrCode INTERFACE_FUNC | getItems (IList **items, ISearchFilter *searchFilter=nullptr)=0 |
| Gets the list of the items in the folder. More... | |
| virtual ErrCode INTERFACE_FUNC | isEmpty (Bool *empty)=0 |
| Returns True if the folder is empty. More... | |
| virtual ErrCode INTERFACE_FUNC | hasItem (IString *localId, Bool *value)=0 |
| Returns True if the folder has an item with local ID. More... | |
| virtual ErrCode INTERFACE_FUNC | getItem (IString *localId, IComponent **item)=0 |
| Gets the item component with the specified localId. More... | |
| Public Member Functions inherited from IComponent | |
| virtual ErrCode INTERFACE_FUNC | getLocalId (IString **localId)=0 |
| Gets the local ID of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getGlobalId (IString **globalId)=0 |
| Gets the global ID of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getActive (Bool *active)=0 |
| Returns true if the component is active; false otherwise. More... | |
| virtual ErrCode INTERFACE_FUNC | setActive (Bool active)=0 |
Sets the component to be either active or inactive. Also recursively sets the active field of all child components if component is a folder. More... | |
| virtual ErrCode INTERFACE_FUNC | getContext (IContext **context)=0 |
| Gets the context object. More... | |
| virtual ErrCode INTERFACE_FUNC | getParent (IComponent **parent)=0 |
| Gets the parent of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getName (IString **name)=0 |
| Gets the name of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setName (IString *name)=0 |
| Sets the name of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getDescription (IString **description)=0 |
| Gets the description of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setDescription (IString *description)=0 |
| Sets the description of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getTags (ITags **tags)=0 |
| Gets the tags of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getVisible (Bool *visible)=0 |
Gets visible metadata state of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setVisible (Bool visible)=0 |
Sets visible attribute state of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getLockedAttributes (IList **attributes)=0 |
| Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnComponentCoreEvent (IEvent **event)=0 |
| Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More... | |
| virtual ErrCode INTERFACE_FUNC | getStatusContainer (IComponentStatusContainer **statusContainer)=0 |
| Gets the container of Component statuses. More... | |
| virtual ErrCode INTERFACE_FUNC | findComponent (IString *id, IComponent **outComponent)=0 |
| Finds the component (signal/device/function block) with the specified (global) id. More... | |
| Public Member Functions inherited from IPropertyObject | |
| virtual ErrCode INTERFACE_FUNC | getClassName (IString **className)=0 |
| Gets the name of the class the Property object was constructed with. More... | |
| virtual ErrCode INTERFACE_FUNC | setPropertyValue (IString *propertyName, IBaseObject *value)=0 |
| Sets the value of the Property with the given name. More... | |
| virtual ErrCode INTERFACE_FUNC | getPropertyValue (IString *propertyName, IBaseObject **value)=0 |
| Gets the value of the Property with the given name. More... | |
| virtual ErrCode INTERFACE_FUNC | getPropertySelectionValue (IString *propertyName, IBaseObject **value)=0 |
| Gets the selected value of the Property, if the Property is a Selection property. More... | |
| virtual ErrCode INTERFACE_FUNC | clearPropertyValue (IString *propertyName)=0 |
| Clears the Property value from the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | hasProperty (IString *propertyName, Bool *hasProperty)=0 |
Checks if the Property object contains a property named propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | getProperty (IString *propertyName, IProperty **property)=0 |
Gets the Property with the given propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | addProperty (IProperty *property)=0 |
| Adds the property to the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | removeProperty (IString *propertyName)=0 |
Removes the Property named propertyName from the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnPropertyValueWrite (IString *propertyName, IEvent **event)=0 |
Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnPropertyValueRead (IString *propertyName, IEvent **event)=0 |
Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More... | |
| virtual ErrCode INTERFACE_FUNC | getVisibleProperties (IList **properties)=0 |
| Returns a list of visible properties contained in the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | getAllProperties (IList **properties)=0 |
| Returns a list of all properties contained in the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | setPropertyOrder (IList *orderedPropertyNames)=0 |
| Sets a custom order of properties as defined in the list of property names. More... | |
| virtual ErrCode INTERFACE_FUNC | beginUpdate ()=0 |
| Begins batch configuration of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | endUpdate ()=0 |
| Ends batch configuration of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | getUpdating (Bool *updating)=0 |
| Returns the state of batch configuration. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnEndUpdate (IEvent **event)=0 |
| Gets the Event that is triggered whenever the batch configuration is applied. More... | |
| virtual ErrCode INTERFACE_FUNC | getPermissionManager (IPermissionManager **permissionManager)=0 |
| Gets the permission manager of property object. More... | |
| Public Member Functions inherited from IBaseObject | |
| virtual ErrCode INTERFACE_FUNC | borrowInterface (const IntfID &intfID, void **obj) const =0 |
| Returns another interface which is supported by the object without incrementing the reference count. More... | |
| virtual ErrCode INTERFACE_FUNC | dispose ()=0 |
| Disposes all references held by the object. More... | |
| virtual ErrCode INTERFACE_FUNC | getHashCode (SizeT *hashCode)=0 |
| Returns hash code of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | equals (IBaseObject *other, Bool *equal) const =0 |
| Compares object to another object for equality. More... | |
| virtual ErrCode INTERFACE_FUNC | toString (CharPtr *str)=0 |
| Returns a string representation of the object. More... | |
| Public Member Functions inherited from IUnknown | |
| virtual ErrCode INTERFACE_FUNC | queryInterface (const IntfID &intfID, void **obj)=0 |
| Returns another interface which is supported by the object and increments the reference count. More... | |
| virtual int INTERFACE_FUNC | addRef ()=0 |
| Increments the reference count for an interface on an object. More... | |
| virtual int INTERFACE_FUNC | releaseRef ()=0 |
| Decrements the reference count for an interface on an object. More... | |
Creates and adds streaming and "OpenDAQOPCUA" servers with default configurations.
| [out] | servers | List of added created servers. |
Get a dictionary of available server types as <IString, IServerType> pairs.
| [out] | serverTypes | The dictionary of available server types. |
|
pure virtual |
Gets the Module manager.
| [out] | manager | The module manager. |
Gets the current root device.
| [out] | rootDevice | The current root device. |
All Device calls invoked on the Instance are forwarded to the current root device.
|
pure virtual |
Adds a device with the connection string as root device.
| connectionString | The connection string containing the address of the device. |
| config | A config object to configure a client device. This object can contain properties like max sample rate, port to use for 3rd party communication, number of channels to generate, or other device specific settings. In case of nullptr, a default configuration is used. |
All Device calls invoked on the Instance are forwarded to the root device. The root device can only be set once.
1.8.17