CellexalVR  1.1.0
A virtual reality platform for the exploration and analysis of single-cell gene expression data
CellexalVR.General.ConfigManager Class Reference

This class is a helper class that reads the config file and sets the properties in CellexalConfig.Config. More...

Inheritance diagram for CellexalVR.General.ConfigManager:

Public Member Functions

void ReadConfigFiles (string folderPath)
 
void ResetToDefault ()
 Copies the deafult config file and overwrites the current one. More...
 
void ReadConfigFile (string configPath, bool switchTo=true)
 Reads a config file. More...
 
void SaveConfigFile (string path)
 Saves the current config as a file. If a file already exists at the specified path, it will be overwritten. More...
 
string ProfileNameToConfigPath (string profileName)
 
void MultiUserSynchronise ()
 Synchronizes our config with a clients. More...
 
byte[] SerializeConfig (Config serializableConfig)
 Serializes the config. More...
 
Config DeserializeConfig (byte[] serializedBytes)
 Deserializes the config. More...
 
void SynchroniseConfig (byte[] data)
 Synchronized our config with the serialized data from another clients config. More...
 

Public Attributes

ReferenceManager referenceManager
 
string currentProfileFullPath
 

Detailed Description

This class is a helper class that reads the config file and sets the properties in CellexalConfig.Config.

Member Function Documentation

◆ DeserializeConfig()

Config CellexalVR.General.ConfigManager.DeserializeConfig ( byte[]  serializedBytes)

Deserializes the config.

Parameters
serializedBytesThe raw byte data, preferably coming from SerializeConfig(Config).
Returns
The deserialized config.

◆ MultiUserSynchronise()

void CellexalVR.General.ConfigManager.MultiUserSynchronise ( )

Synchronizes our config with a clients.

◆ ReadConfigFile()

void CellexalVR.General.ConfigManager.ReadConfigFile ( string  configPath,
bool  switchTo = true 
)

Reads a config file.

Parameters
configPathThe full path to the config file.
switchToTrue if this config should become the new config to use right now, setting this to false disables invoking the CellexalEvents.ConfigLoaded event.

◆ ResetToDefault()

void CellexalVR.General.ConfigManager.ResetToDefault ( )

Copies the deafult config file and overwrites the current one.

◆ SaveConfigFile()

void CellexalVR.General.ConfigManager.SaveConfigFile ( string  path)

Saves the current config as a file. If a file already exists at the specified path, it will be overwritten.

Parameters
pathThe path to the file.

◆ SerializeConfig()

byte [] CellexalVR.General.ConfigManager.SerializeConfig ( Config  serializableConfig)

Serializes the config.

Parameters
serializableConfigThe config to serialize
Returns
The raw byte data representing the config.

◆ SynchroniseConfig()

void CellexalVR.General.ConfigManager.SynchroniseConfig ( byte[]  data)

Synchronized our config with the serialized data from another clients config.

Parameters
data

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