LibPkg
Public Member Functions | List of all members
pkg::pkg_env Class Reference

A class to represent the enviroment a package is designed for. More...

#include <env_checker.h>

Public Member Functions

const std::string & name () const
 The full name of this environment. More...
 
bool available () const
 Return true if this environment is compatible with the current machine. More...
 
int default_install_priority () const
 Default install priority to use if the package doesn't specify one. More...
 
const std::string & id () const
 Unique short Id string for use in maps and file caches. More...
 
env_check_type type () const
 Main type to describe this package, chosen from the checks in the environment. More...
 
void reset_available ()
 Reset available flag from contained checks. More...
 
std::string env_names () const
 Return the environment part of the name. More...
 
std::string module_names () const
 Return the modules part of the name. More...
 

Detailed Description

A class to represent the enviroment a package is designed for.

Pointers to this class should be retrieved from the env_checker class.

Member Function Documentation

◆ name()

const std::string& pkg::pkg_env::name ( ) const
inline

The full name of this environment.

◆ available()

bool pkg::pkg_env::available ( ) const
inline

Return true if this environment is compatible with the current machine.

References pkg::env_check::_available.

Referenced by pkg::env_packages_table::operator[]().

◆ default_install_priority()

int pkg::pkg_env::default_install_priority ( ) const
inline

Default install priority to use if the package doesn't specify one.

References pkg::env_check::_install_priority.

Referenced by pkg::binary_control::install_priority().

◆ id()

const std::string& pkg::pkg_env::id ( ) const
inline

Unique short Id string for use in maps and file caches.

Referenced by pkg::binary_control::environment_id().

◆ type()

env_check_type pkg::pkg_env::type ( ) const
inline

Main type to describe this package, chosen from the checks in the environment.

References pkg::env_check::_available, pkg::env_check::_install_priority, and pkg::env_check::name().

◆ reset_available()

void pkg::pkg_env::reset_available ( )

Reset available flag from contained checks.

References pkg::env_check::available().

◆ env_names()

std::string pkg::pkg_env::env_names ( ) const

Return the environment part of the name.

Referenced by pkg::commit::poll().

◆ module_names()

std::string pkg::pkg_env::module_names ( ) const

Return the modules part of the name.

Referenced by pkg::commit::poll().


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

Reference Manual LibPkg Version 0.9.0 (4 Sep 2020)