Detailed Description

Spreadsheet that contains data of the table explorer editor.

Todo:: Not implemented at the moment. Meta object that contains declared references between deferent Spreadsheets.

Inheritance diagram for Doloro.DataManagement.Tables.Solution:

[legend]

Collaboration diagram for Doloro.DataManagement.Tables.Solution:

[legend]

Public Member Functions
	Solution ()
	Creates empty solution.

	Solution (SerializationInfo info, StreamingContext context)
	Allows to binary serializer instantiate the object from binary. More...

	Solution (params string[] resourcePaths)
	Creates solution for the resources located by defined paths. More...

	Solution (params Spreadsheet[] ramSheets)
	Creates solution for the RAM located spreadsheets. More...

void	SetDirty (Spreadsheet source)
	Marks data source as modified. More...

void	LoadSpreadsheet (string reference, out Spreadsheet sheet)
	Trying to load spreadsheet by reference defined by index. In case if already loaded, reloads data with the referenced source. More...

void	LoadSpreadsheet (int idx, out Spreadsheet sheet)
	Trying to load spreadsheet by reference defined by index. In case if already loaded, reloads data with the referenced source. More...

bool	IsSpreadsheetLoaded (string reference)
	Checks is the spreadsheet loaded to the memory. More...

bool	UnloadSpreadsheet (string reference)
	Unloading spreadsheet from loaded. Releases allocated memory using by the source Table. More...

void	Dispose ()

void	AddReference (string path)
	Adding reference to the data table by the path. More...

string	GetRefernce (int index)
	Returns reference by order index. More...

bool	RemoveReference (string path, bool disposeData)
	trying to remove reference among registered. More...

bool	FindReference (Spreadsheet sheet, out string reference)
	Trying to find resource's file system reference among loaded. More...

bool	FindSpreadsheet (string reference, out Spreadsheet sheet)
	Looking for spreadsheet related to resource reference among loaded. More...

void	UpdateReference (string oldRef, string newRef)
	Updating one reference value. More...

bool	ContaninsReference (string path)
	Checks is the reference already added to the spreadsheet. More...

IEnumerator< string >	GetEnumerator ()
	Enumerates solution as bunch of spreed sheet references. More...

virtual void	GetObjectData (SerializationInfo info, StreamingContext context)
	Converts data object to the binary dump. More...

void	SetDirty ()
	Marks asset as modified and required save operation.

Protected Member Functions
virtual void	Dispose (bool disposing)
	Releasing loaded data of connected spreadsheets as well with referenced data tables. More...

override void	OnPreSave ()
	Checking is some of binded spreadsheet has no reference definition. More...

virtual void	OnPostSave ()
	Occurs after save process started.

Properties
new bool	isDirty `[get]`
	Is the references data or spreadsheet settings was modified.

Spreadsheet[]	unsaved `[get]`
	Array that contains references to the

int	ActiveSpreadsheet `[get, set]`
	Index of the spreadsheet that was in view at the last time. More...

int	ReferencesCount `[get]`
	Count of spreadsheet references binded to the solution.

List< string >	references `[get]`
	Collection of paths to tables data referenced to the spreadsheet.

bool	isRamLocated `[get]`
	Is the object has no binding to the stored resource.

bool	isObsolete `[get]`
	The asset data is no longer relevant. More...

StorableAsset	asset `[get, set]`
	Reference to relevant asset. More...

string	StoredAssetPath `[get, set]`
	Path to resource binded to the instance. More...

Events
Action	AssetObsoleted
	Occurs when object became obsolete.

Constructor & Destructor Documentation

◆ Solution() [1/3]

Doloro.DataManagement.Tables.Solution.Solution	(	SerializationInfo	info,
		StreamingContext	context
	)

Allows to binary serializer instantiate the object from binary.

Parameters

info
context

◆ Solution() [2/3]

Doloro.DataManagement.Tables.Solution.Solution ( params string[] resourcePaths )

Creates solution for the resources located by defined paths.

Parameters

resourcePaths Paths to the serialized Spreadsheet resource.

◆ Solution() [3/3]

Doloro.DataManagement.Tables.Solution.Solution ( params Spreadsheet[] ramSheets )

Creates solution for the RAM located spreadsheets.

Parameters

ramSheets Array to sheets to solutions include.

Member Function Documentation

◆ AddReference()

void Doloro.DataManagement.Tables.Solution.AddReference ( string path )

Adding reference to the data table by the path.

Parameters

path	Path to the table.

Exceptions

ArgumentException	Reference already exists.
ArgumentNullException	Path is null or whitespace.

◆ ContaninsReference()

bool Doloro.DataManagement.Tables.Solution.ContaninsReference ( string path )

Checks is the reference already added to the spreadsheet.

Parameters

path	Path to data table.

Returns: Result of search among registered references.

Exceptions

ArgumentNullException Null or whitespace as argument.

◆ Dispose()

virtual void Doloro.DataManagement.Tables.Solution.Dispose ( bool disposing )

protectedvirtual

Releasing loaded data of connected spreadsheets as well with referenced data tables.

Parameters

disposing

◆ FindReference()

bool Doloro.DataManagement.Tables.Solution.FindReference	(	Spreadsheet	sheet,
		out string	reference
	)

Trying to find resource's file system reference among loaded.

Parameters

sheet	Loaded sheet related to the solution.
reference	File system reference in case if found.

Returns: Is reference found.

◆ FindSpreadsheet()

bool Doloro.DataManagement.Tables.Solution.FindSpreadsheet	(	string	reference,
		out Spreadsheet	sheet
	)

Looking for spreadsheet related to resource reference among loaded.

Parameters

reference	Path to stored resource.
sheet

Returns: Result of instance search. True if found.

◆ GetEnumerator()

IEnumerator< string > Doloro.DataManagement.Tables.Solution.GetEnumerator ( )

Enumerates solution as bunch of spreed sheet references.

Returns: Enumerator instance.

◆ GetObjectData()

virtual void Doloro.DataManagement.Serialization.StorableAsset.GetObjectData	(	SerializationInfo	info,
		StreamingContext	context
	)

virtualinherited

Converts data object to the binary dump.

Parameters

info
context

◆ GetRefernce()

string Doloro.DataManagement.Tables.Solution.GetRefernce ( int index )

Returns reference by order index.

Parameters

index Index of the reference into definition list.

Returns: Reference path to the Spreadsheet resource in file system.

Exceptions

IndexOutOfRangeException index lesser then 0 or greater or equal then ReferencesCount.

◆ IsSpreadsheetLoaded()

bool Doloro.DataManagement.Tables.Solution.IsSpreadsheetLoaded ( string reference )

Checks is the spreadsheet loaded to the memory.

Parameters

reference Spreadsheet asset referenced path.

Returns: True if loaded, false otherwise.

◆ LoadSpreadsheet() [1/2]

void Doloro.DataManagement.Tables.Solution.LoadSpreadsheet	(	int	idx,
		out Spreadsheet	sheet
	)

Trying to load spreadsheet by reference defined by index. In case if already loaded, reloads data with the referenced source.

Parameters

idx	Index of the reference into the defined order.
sheet	Reference to loaded sheet instance in case if operation succeeded.

Exceptions

IndexOutOfRangeException value lesser then 0 or greater or equal to the ReferencesCount.

See also: GetRefernce(int), ReferencesCount(int)

◆ LoadSpreadsheet() [2/2]

void Doloro.DataManagement.Tables.Solution.LoadSpreadsheet	(	string	reference,
		out Spreadsheet	sheet
	)

Trying to load spreadsheet by reference defined by index. In case if already loaded, reloads data with the referenced source.

Parameters

reference	Path to the referenced asset in file system.
sheet	Reference to loaded sheet instance in case if operation succeeded.

In case if reference not found among registered adds it via the AddReference(string) handler.

◆ OnPreSave()

override void Doloro.DataManagement.Tables.Solution.OnPreSave ( )

protectedvirtual

Checking is some of binded spreadsheet has no reference definition.

Reimplemented from Doloro.DataManagement.Serialization.StorableAsset.

◆ RemoveReference()

bool Doloro.DataManagement.Tables.Solution.RemoveReference	(	string	path,
		bool	disposeData
	)

trying to remove reference among registered.

Parameters

path	path to remove.
disposeData	If true then will release referenced spreadsheet.

Returns: Is the element was found.

Exceptions

ArgumentNullException Path is null or whitespace.

◆ SetDirty()

void Doloro.DataManagement.Tables.Solution.SetDirty ( Spreadsheet source )

Marks data source as modified.

Parameters

source Source itself.

◆ UnloadSpreadsheet()

bool Doloro.DataManagement.Tables.Solution.UnloadSpreadsheet ( string reference )

Unloading spreadsheet from loaded. Releases allocated memory using by the source Table.

Parameters

reference

Returns

◆ UpdateReference()

void Doloro.DataManagement.Tables.Solution.UpdateReference	(	string	oldRef,
		string	newRef
	)

Updating one reference value.

Parameters

oldRef	Current reference. Case insensitive.
newRef	New value to set.

Exceptions

ArgumentNullException Reference is null or whitespace.

Property Documentation

◆ ActiveSpreadsheet

int Doloro.DataManagement.Tables.Solution.ActiveSpreadsheet

getset

Index of the spreadsheet that was in view at the last time.

Exceptions

IndexOutOfRangeException value lesser then 0 or greater or equal to the ReferencesCount.

◆ asset

StorableAsset Doloro.DataManagement.Serialization.StorableAsset.asset

getsetprotectedinherited

Reference to relevant asset.

References itself in case if isObsolete is false.

◆ isObsolete

bool Doloro.DataManagement.Serialization.StorableAsset.isObsolete

getpackageinherited

The asset data is no longer relevant.

Occurs when object was overridden by some data operation (Load etc.) In this case reference

See also: asset

◆ StoredAssetPath

string Doloro.DataManagement.Serialization.StorableAsset.StoredAssetPath

getsetinherited

Path to resource binded to the instance.

Changes during IO.LoadAs(string), IO.SaveAs(StorableAsset, string) or manual set operation.

The documentation for this class was generated from the following files:

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Solution/Solution.cs
D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Solution/SolutionAssembly.cs

Detailed Description

Public Member Functions

Protected Member Functions

Properties

Events

Constructor & Destructor Documentation

◆ Solution() [1/3]

◆ Solution() [2/3]

◆ Solution() [3/3]

Member Function Documentation

◆ AddReference()

◆ ContaninsReference()

◆ Dispose()

◆ FindReference()

◆ FindSpreadsheet()

◆ GetEnumerator()

◆ GetObjectData()

◆ GetRefernce()

◆ IsSpreadsheetLoaded()

◆ LoadSpreadsheet() [1/2]

◆ LoadSpreadsheet() [2/2]

◆ OnPreSave()

◆ RemoveReference()

◆ SetDirty()

◆ UnloadSpreadsheet()

◆ UpdateReference()

Property Documentation

◆ ActiveSpreadsheet

◆ asset

◆ isObsolete

◆ StoredAssetPath