Package conduit :: Package dataproviders :: Module DataProvider :: Class DataSink
[hide private]

Class DataSink

source code


Base Class for DataSinks

Instance Methods [hide private]
 
__init__(self)
All sync functionality should be provided by derived classes
source code
 
put(self, putData, overwrite, LUID)
Stores data.
source code
 
delete(self, LUID)
Deletes data with LUID.
source code

Inherited from DataProviderBase: configure, emit, emit_change_detected, finish, get_UID, get_configuration, get_configuration_xml, get_input_conversion_args, get_input_type, get_name, get_output_conversion_args, get_output_type, get_status, initialize, is_busy, is_configured, refresh, set_configuration, set_configuration_xml, set_status, uninitialize

Class Variables [hide private]

Inherited from DataProviderBase: __gsignals__, _category_, _configurable_, _description_, _icon_, _in_type_, _module_type_, _name_, _out_type_

Method Details [hide private]

__init__(self)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: DataProviderBase.__init__
(inherited documentation)

put(self, putData, overwrite, LUID)

source code 

Stores data. The derived class is responsible for checking if putData conflicts.

In the case of a two-way datasource, the derived type should consider the overwrite parameter, which if True, should allow the dp to replace a datatype instance if one is found at the existing location

Derived classes should call this function to ensure the dataprovider status is updated.
Parameters:
  • putData (A conduit.DataType.DataType derived type that this dataprovider is capable of handling) - Data which to save
  • overwrite (bool) - If this argument is True, the DP should overwrite an existing datatype instace (if one exists). Generally used in conflict resolution.
  • LUID - A locally unique identifier representing the location where the data was previously put.
Raises: