Package record. More...

#include <miktex/PackageManager/PackageInfo.h>

Collaboration diagram for MiKTeX::Packages::PackageInfo:

Public Member Functions
unsigned long	GetRefCount () const
	Gets the number of dependents. More...

unsigned long	GetNumFiles () const

std::size_t	GetSize () const

std::time_t	GetTimeInstalled () const
	Gets the time, the package was installed. More...

bool	IsContained () const
	Checks to see if this package has dependents. More...

bool	IsContainer () const
	Tests for a container package. More...

bool	IsInstalled () const
	Checks to see whether the package is installed. More...

bool	IsInstalled (MiKTeX::Core::ConfigurationScope scope) const
	Checks to see whether the package is installed in the specified scope. More...

bool	IsPureContainer () const

void	SetTimeInstalled (std::time_t timeInstalled, MiKTeX::Core::ConfigurationScope scope)
	Gets the time, the package was installed. More...

Public Attributes
std::size_t	archiveFileSize = 0
	Size of the archive file. More...

std::string	copyrightOwner
	The copyright owner of the package. More...

std::string	copyrightYear
	Copyright year. More...

std::string	creator
	Name of creator (packer). More...

std::string	ctanPath
	Relative path to the package directory on a CTAN mirror. More...

std::string	description
	Multi-line package description. More...

MiKTeX::Core::MD5	digest
	MD5 of the package. More...

std::string	displayName
	Display name. More...

std::string	id
	Package ID. More...

bool	isObsolete = false
	`true`, if the package is obsolete. More...

bool	isRemovable = false
	`true`, if the package can be removed. More...

std::vector< std::string >	docFiles
	The doc file list. More...

std::string	licenseType
	The license type of the package. More...

std::string	minTargetSystemVersion
	The minimum required target system version. More...

RepositoryReleaseState	releaseState = RepositoryReleaseState::Unknown
	The release state of the package. More...

std::vector< std::string >	requiredBy
	List of dependents. More...

std::vector< std::string >	requiredPackages
	List of required packages. More...

std::vector< std::string >	runFiles
	The run file list. More...

std::size_t	sizeDocFiles = 0
	Total size of all doc files. More...

std::size_t	sizeSourceFiles = 0
	Total size of all source files. More...

std::size_t	sizeRunFiles = 0
	Total size of all run files. More...

std::vector< std::string >	sourceFiles
	The source file list. More...

std::string	targetSystem
	Target system. More...

std::time_t	timeInstalledCommon = InvalidTimeT
	Date/time when the package was installed in the common scope. More...

std::time_t	timeInstalledUser = InvalidTimeT
	Date/time when the package was installed in the user scope.. More...

std::time_t	timePackaged = InvalidTimeT
	Date/time when the package was created. More...

std::string	title
	One-line package description. More...

std::string	version
	Informal version information. More...

std::string	versionDate
	The version/date of the package. More...

Detailed Description

Package record.

Member Function Documentation

◆ GetNumFiles()

unsigned long MiKTeX::Packages::PackageInfo::GetNumFiles ( ) const

inline

Gets the total number of files in the package.

Returns: Returns the number of files.

◆ GetRefCount()

unsigned long MiKTeX::Packages::PackageInfo::GetRefCount ( ) const

inline

Gets the number of dependents.

◆ GetSize()

std::size_t MiKTeX::Packages::PackageInfo::GetSize ( ) const

inline

Gets the total size (in bytes) of all files in the package.

Returns: Returns the package size.

◆ GetTimeInstalled()

std::time_t MiKTeX::Packages::PackageInfo::GetTimeInstalled ( ) const

inline

Gets the time, the package was installed.

◆ IsContained()

bool MiKTeX::Packages::PackageInfo::IsContained ( ) const

inline

Checks to see if this package has dependents.

◆ IsContainer()

bool MiKTeX::Packages::PackageInfo::IsContainer ( ) const

inline

Tests for a container package.

◆ IsInstalled() [1/2]

bool MiKTeX::Packages::PackageInfo::IsInstalled ( ) const

inline

Checks to see whether the package is installed.

◆ IsInstalled() [2/2]

bool MiKTeX::Packages::PackageInfo::IsInstalled ( MiKTeX::Core::ConfigurationScope scope ) const

inline

Checks to see whether the package is installed in the specified scope.

◆ IsPureContainer()

bool MiKTeX::Packages::PackageInfo::IsPureContainer ( ) const

inline

Tests for a pure container package.

Returns: Returns true, if this is a pure container package.

◆ SetTimeInstalled()

void MiKTeX::Packages::PackageInfo::SetTimeInstalled	(	std::time_t	timeInstalled,
		MiKTeX::Core::ConfigurationScope	scope
	)

inline

Gets the time, the package was installed.

Member Data Documentation

◆ archiveFileSize

std::size_t MiKTeX::Packages::PackageInfo::archiveFileSize = 0

Size of the archive file.

◆ copyrightOwner

std::string MiKTeX::Packages::PackageInfo::copyrightOwner

The copyright owner of the package.

◆ copyrightYear

std::string MiKTeX::Packages::PackageInfo::copyrightYear

Copyright year.

◆ creator

std::string MiKTeX::Packages::PackageInfo::creator

Name of creator (packer).

◆ ctanPath

std::string MiKTeX::Packages::PackageInfo::ctanPath

Relative path to the package directory on a CTAN mirror.

◆ description

std::string MiKTeX::Packages::PackageInfo::description

Multi-line package description.

◆ digest

MiKTeX::Core::MD5 MiKTeX::Packages::PackageInfo::digest

MD5 of the package.

◆ displayName

std::string MiKTeX::Packages::PackageInfo::displayName

Display name.

◆ docFiles

std::vector<std::string> MiKTeX::Packages::PackageInfo::docFiles

The doc file list.

◆ id

std::string MiKTeX::Packages::PackageInfo::id

Package ID.

◆ isObsolete

bool MiKTeX::Packages::PackageInfo::isObsolete = false

true, if the package is obsolete.

◆ isRemovable

bool MiKTeX::Packages::PackageInfo::isRemovable = false

true, if the package can be removed.

◆ licenseType

std::string MiKTeX::Packages::PackageInfo::licenseType

The license type of the package.

◆ minTargetSystemVersion

std::string MiKTeX::Packages::PackageInfo::minTargetSystemVersion

The minimum required target system version.

◆ releaseState

RepositoryReleaseState MiKTeX::Packages::PackageInfo::releaseState = RepositoryReleaseState::Unknown

The release state of the package.

◆ requiredBy

std::vector<std::string> MiKTeX::Packages::PackageInfo::requiredBy

List of dependents.

◆ requiredPackages

std::vector<std::string> MiKTeX::Packages::PackageInfo::requiredPackages

List of required packages.

◆ runFiles

std::vector<std::string> MiKTeX::Packages::PackageInfo::runFiles

The run file list.

◆ sizeDocFiles

std::size_t MiKTeX::Packages::PackageInfo::sizeDocFiles = 0

Total size of all doc files.

◆ sizeRunFiles

std::size_t MiKTeX::Packages::PackageInfo::sizeRunFiles = 0

Total size of all run files.

◆ sizeSourceFiles

std::size_t MiKTeX::Packages::PackageInfo::sizeSourceFiles = 0

Total size of all source files.

◆ sourceFiles

std::vector<std::string> MiKTeX::Packages::PackageInfo::sourceFiles

The source file list.

◆ targetSystem

std::string MiKTeX::Packages::PackageInfo::targetSystem

Target system.

◆ timeInstalledCommon

std::time_t MiKTeX::Packages::PackageInfo::timeInstalledCommon = InvalidTimeT

Date/time when the package was installed in the common scope.

◆ timeInstalledUser

std::time_t MiKTeX::Packages::PackageInfo::timeInstalledUser = InvalidTimeT

Date/time when the package was installed in the user scope..

◆ timePackaged

std::time_t MiKTeX::Packages::PackageInfo::timePackaged = InvalidTimeT

Date/time when the package was created.

◆ title

std::string MiKTeX::Packages::PackageInfo::title

One-line package description.

◆ version

std::string MiKTeX::Packages::PackageInfo::version

Informal version information.

◆ versionDate

std::string MiKTeX::Packages::PackageInfo::versionDate

The version/date of the package.

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

Libraries/MiKTeX/PackageManager/include/miktex/PackageManager/PackageInfo.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ GetNumFiles()

◆ GetRefCount()

◆ GetSize()

◆ GetTimeInstalled()

◆ IsContained()

◆ IsContainer()

◆ IsInstalled() [1/2]

◆ IsInstalled() [2/2]

◆ IsPureContainer()

◆ SetTimeInstalled()

Member Data Documentation

◆ archiveFileSize

◆ copyrightOwner

◆ copyrightYear

◆ creator

◆ ctanPath

◆ description

◆ digest

◆ displayName

◆ docFiles

◆ id

◆ isObsolete

◆ isRemovable

◆ licenseType

◆ minTargetSystemVersion

◆ releaseState

◆ requiredBy

◆ requiredPackages

◆ runFiles

◆ sizeDocFiles

◆ sizeRunFiles

◆ sizeSourceFiles

◆ sourceFiles

◆ targetSystem

◆ timeInstalledCommon

◆ timeInstalledUser

◆ timePackaged

◆ title

◆ version

◆ versionDate