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

Class DataSource

source code


Base Class for DataSources.

Instance Methods [hide private]
 
__init__(self)
All sync functionality should be provided by derived classes
source code
conduit.DataType.DataType
get(self, LUID)
Returns data with the specified LUID.
source code
int
get_num_items(self)
Returns the number of items requiring sychronization.
source code
 
get_all(self)
Returns an array of all the LUIDs this dataprovider holds.
source code
 
get_changes(self)
Returns all changes since last sync
source code
 
add(self, LUID)
Adds an item to the datasource according to 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)

get(self, LUID)

source code 

Returns data with the specified LUID. This function must be overridden by the appropriate dataprovider.

Derived classes should call this function to ensure the dataprovider status is updated.
Parameters:
  • LUID (string) - The index of the data to return
Returns: conduit.DataType.DataType
An item of data

get_num_items(self)

source code 
Returns the number of items requiring sychronization.
Returns: int
The number of items to synchronize

add(self, LUID)

source code 
Adds an item to the datasource according to LUID. This method is used by the DBus interface
Returns:
True if the data was successfully added