hudman  5.1.0
Local HUD mirror manager
hudman.hud.HUDCommon Class Reference
Inheritance diagram for hudman.hud.HUDCommon:
hudman.hud.github.HUDGitHub hudman.hud.other.HUDOther

Public Member Functions

None __init__ (self, hud)
 
str archivedir (self)
 
None archivedir (self, str value)
 
bool check (self)
 
bool download (self, str outdir)
 
str filename (self)
 
str gamename (self)
 
None gamename (self, str value)
 
str homepage (self)
 
None homepage (self, str value)
 
str hudname (self)
 
None hudname (self, str value)
 
str installdir (self)
 
None installdir (self, str value)
 
bool isupdated (self)
 
None isupdated (self, bool value)
 
int lastupdate (self)
 
None lastupdate (self, int value)
 
str mainuri (self)
 
None mainuri (self, str value)
 
str mirroruri (self)
 
None mirroruri (self, str value)
 
str repopath (self)
 
None repopath (self, str value)
 
str screenshoturi (self)
 
None screenshoturi (self, str value)
 
str sha512hash (self)
 
None sha512hash (self, str value)
 
None update (self, str outdir)
 
str upstreamuri (self)
 
None upstreamuri (self, str value)
 

Public Attributes

 isupdated
 
 lastupdate
 
 mainuri
 
 mirroruri
 
 sha512hash
 

Private Member Functions

int _updatecheck (self)
 

Private Attributes

 _archivedir
 
 _checkresult
 
 _gamename
 
 _homepage
 
 _hudname
 
 _installdir
 
 _isupdated
 
 _lastupdate
 
 _mainuri
 
 _mirroruri
 
 _repopath
 
 _screenshot
 
 _sha512hash
 
 _upstreamuri
 

Detailed Description

Abstract class for working with HUDs.

Constructor & Destructor Documentation

◆ __init__()

None hudman.hud.HUDCommon.__init__ (   self,
  hud 
)
Main constructor of HUDEntry class.
:param hud: A single entry from HUD database.

Reimplemented in hudman.hud.github.HUDGitHub.

Member Function Documentation

◆ _updatecheck()

int hudman.hud.HUDCommon._updatecheck (   self)
private
Fetch an external source and get last modification time of
the selected HUD. Abstract method.
:return: Last modification time in unixtime format.
:rtype: int

Reimplemented in hudman.hud.other.HUDOther, and hudman.hud.github.HUDGitHub.

◆ archivedir() [1/2]

str hudman.hud.HUDCommon.archivedir (   self)
Get actual archive dir inside archive.
:return: Archive directory name.

◆ archivedir() [2/2]

None hudman.hud.HUDCommon.archivedir (   self,
str  value 
)
Set actual archive dir inside archive.

◆ check()

bool hudman.hud.HUDCommon.check (   self)
Check for the HUD updates.
:return: Return True if the new version is available.
:rtype: bool

◆ download()

bool hudman.hud.HUDCommon.download (   self,
str  outdir 
)
Download current version of the specified HUD.
:param outdir: Output directory.
:return: Return True if the specified HUD was downloaded successfully.
:rtype: bool

◆ filename()

str hudman.hud.HUDCommon.filename (   self)
Get final download filename for HUD.
:return: Download filename for HUD.

◆ gamename() [1/2]

str hudman.hud.HUDCommon.gamename (   self)
Get HUD's game name.
:return: Game name.

◆ gamename() [2/2]

None hudman.hud.HUDCommon.gamename (   self,
str  value 
)
Set HUD's game name.

◆ homepage() [1/2]

str hudman.hud.HUDCommon.homepage (   self)
Get homepage of HUD.
:return: Homepage of HUD.

◆ homepage() [2/2]

None hudman.hud.HUDCommon.homepage (   self,
str  value 
)
Set homepage of HUD.

◆ hudname() [1/2]

str hudman.hud.HUDCommon.hudname (   self)
Get user friendly HUD name.
:return: HUD name.

◆ hudname() [2/2]

None hudman.hud.HUDCommon.hudname (   self,
str  value 
)
Set user friendly HUD name.

◆ installdir() [1/2]

str hudman.hud.HUDCommon.installdir (   self)
Get install directory of HUD.
:return: HUD install directory.

◆ installdir() [2/2]

None hudman.hud.HUDCommon.installdir (   self,
str  value 
)
Set install directory of HUD.

◆ isupdated() [1/2]

bool hudman.hud.HUDCommon.isupdated (   self)
Check if current HUD is up to date.
:return: Update result.

◆ isupdated() [2/2]

None hudman.hud.HUDCommon.isupdated (   self,
bool  value 
)
Set if current HUD is up to date.

◆ lastupdate() [1/2]

int hudman.hud.HUDCommon.lastupdate (   self)
Get last update time in Unixtime format.
:return: Last update time.

◆ lastupdate() [2/2]

None hudman.hud.HUDCommon.lastupdate (   self,
int  value 
)
Set last update time in Unixtime format.

◆ mainuri() [1/2]

str hudman.hud.HUDCommon.mainuri (   self)
Get local mirror URI.
:return: Mirror URI.

◆ mainuri() [2/2]

None hudman.hud.HUDCommon.mainuri (   self,
str  value 
)
Set local mirror URI.

◆ mirroruri() [1/2]

str hudman.hud.HUDCommon.mirroruri (   self)
Get local secondary server URI.
:return: Mirror URI.

◆ mirroruri() [2/2]

None hudman.hud.HUDCommon.mirroruri (   self,
str  value 
)
Set local secondary server URI.

◆ repopath() [1/2]

str hudman.hud.HUDCommon.repopath (   self)
Get upstream repository URL.
:return: Upstream repository URL.

◆ repopath() [2/2]

None hudman.hud.HUDCommon.repopath (   self,
str  value 
)
Set upstream repository URL.

◆ screenshoturi() [1/2]

str hudman.hud.HUDCommon.screenshoturi (   self)
Get screenshot URI.
:return: Screenshot URI.

◆ screenshoturi() [2/2]

None hudman.hud.HUDCommon.screenshoturi (   self,
str  value 
)
Set screenshot URI.

◆ sha512hash() [1/2]

str hudman.hud.HUDCommon.sha512hash (   self)
Get SHA-512 hash sum of HUD file.
:return: SHA-512 hash sum of HUD file.

◆ sha512hash() [2/2]

None hudman.hud.HUDCommon.sha512hash (   self,
str  value 
)
Set SHA-512 hash sum of HUD file.

◆ update()

None hudman.hud.HUDCommon.update (   self,
str  outdir 
)
Download the latest version of the specified HUD.
:param outdir: Output directory.

Reimplemented in hudman.hud.other.HUDOther.

◆ upstreamuri() [1/2]

str hudman.hud.HUDCommon.upstreamuri (   self)
Get upstream URI.
:return: Upstream URI.

◆ upstreamuri() [2/2]

None hudman.hud.HUDCommon.upstreamuri (   self,
str  value 
)
Set upstream URI.