SessionEnfReader#

class pyCGM2.Nexus.eclipse.SessionEnfReader(path: str, enfFile: str)#

A class for handling a Session.enf file created by Vicon Eclipse.

Inherits from EnfReader.

__init__(path: str, enfFile: str)#

Initializes the SessionEnfReader object.

Methods

__init__(path, enfFile)

Initializes the SessionEnfReader object.

get(label)

Retrieves the value of a specified parameter from the Session.enf file.

getFile()

Retrieves the filename of the .enf file.

getPath()

Retrieves the path of the folder containing the .enf file.

getSection(section)

Returns the content of a specified section from the .enf file.

getSessionInfos()

Retrieves the session information section from the Session.enf file.

remove(label)

Removes a parameter from the Session.enf file (call save() to write it).

save()

Saves the changes made to the Session.enf file.

set(label, value)

Sets the value of a specified parameter in the Session.enf file.

get(label: str)#

Retrieves the value of a specified parameter from the Session.enf file.

Parameters:

label (str) – The name of the parameter.

Returns:

Any – The value of the specified parameter.

getSessionInfos()#

Retrieves the session information section from the Session.enf file.

Returns:

dict – A dictionary containing session information.

remove(label: str)#

Removes a parameter from the Session.enf file (call save() to write it).

Parameters:

label (str) – The name of the parameter (exact case).

Returns:

bool – True if the parameter existed.

save()#

Saves the changes made to the Session.enf file.

set(label: str, value: str)#

Sets the value of a specified parameter in the Session.enf file.

Parameters:
  • label (str) – The name of the parameter.

  • value (str) – The value to be set.