collection

Module Contents

class DataStruct_Interface

get_info(self)

Get simple string describing the datastructure

set_info(self, info)

Set simple string describing the datastructure

__str__(self)

class AutosaveStruct(dataStruct, filename='', change_filename_if_exists=True)

Structure that provides automated save of DataStructures

__str__(self)

get_filename(self)

Get set filename

set_filename(self, filename, change_filename_if_exists)

Parameters:

• filename – Filename to set
• change_filename_if_exists – If already exists, create a new filename

stop_autosave(self)

Stop autosave

start_autosave(self, timer_autosave)

Start autosave

save(self, safe_save=True)

Save

get_datastruct(self)

Return :class:’~DataStruct_Interface’

class ListDataStruct

Bases: optimeed.core.collection.DataStruct_Interface

_INFO_STR = info

_DATA_STR = data

save(self, filename)

Save data using json format. The data to be saved are automatically detected, see obj_to_json()

add_data(self, data_in)

Add a data to the list

get_data(self)

Get full list of datas

set_data(self, theData)

Set full list of datas

set_data_at_index(self, data_in, index)

Replace data at specific index

set_attribute_data(self, the_attribute, the_value)

Set attribute to all data

set_attribute_equation(self, attribute_name, equation_str)

Advanced method to set the value of attribute_name from equation_str

Parameters:

• attribute_name – string (name of the attribute to set)
• equation_str – formatted equation, check applyEquation()

Returns:

get_list_attributes(self, attributeName)

Get the value of attributeName of all the data in the Collection

Parameters:attributeName – string (name of the attribute to get) Returns:list

delete_points_at_indices(self, indices)

Delete several elements from the Collection

Parameters:indices – list of indices to delete

export_xls(self, excelFilename, excelsheet='Sheet1', mode='w')

Export the collection to excel. It only exports the direct attributes.

Parameters:

• excelFilename – filename of the excel
• excelsheet – name of the sheet
• mode – ‘w’ to erase existing file, ‘a’ to append sheetname to existing file

merge(self, collection)

Merge a collection with the current collection

Parameters:collection – Collection to merge