LibPkg
Public Member Functions | Protected Attributes | List of all members
pkg::env_check Class Reference

Base class for the environment checking classes. More...

#include <env_checker.h>

Inheritance diagram for pkg::env_check:
pkg::all_check pkg::arm26_check pkg::arm32_check pkg::arm_check pkg::module_check pkg::swp_check pkg::unknown_check pkg::unset_check pkg::vfp_check

Public Member Functions

 env_check (const std::string &name, const std::string &desc, const std::string &id, env_check_type type, int install_priority)
 Construct a default environment check. More...
 
virtual ~env_check ()
 
const std::string & name () const
 The name of the check, should be fairly short. More...
 
const std::string & description () const
 A one line description for display purposes only. More...
 
const std::string & id () const
 Short id consisting of a single letter optionally followed be a number. More...
 
bool detected () const
 Automatic detection result. More...
 
bool available () const
 Software override of status. More...
 
void available (bool override)
 
env_check_type type () const
 Type for this check. More...
 
int install_priority ()
 Priority for this check, the higher the more important. More...
 

Protected Attributes

std::string _description
 
bool _detected
 
bool _available
 
int _install_priority
 

Detailed Description

Base class for the environment checking classes.

Constructor & Destructor Documentation

◆ env_check()

pkg::env_check::env_check ( const std::string &  name,
const std::string &  desc,
const std::string &  id,
env_check_type  type,
int  install_priority 
)

Construct a default environment check.

Parameters
nameshort name
descshort description
idsingle letter optionally followed by a number. This must be unique for all checks.
typeThe type of the check
install_prioritythe priority weighting for this check

◆ ~env_check()

virtual pkg::env_check::~env_check ( )
inlinevirtual

Member Function Documentation

◆ name()

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

The name of the check, should be fairly short.

Referenced by pkg::env_checker::override_environment(), pkg::env_checker::package_env(), and pkg::pkg_env::type().

◆ description()

const std::string& pkg::env_check::description ( ) const
inline

A one line description for display purposes only.

References _description.

◆ id()

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

Short id consisting of a single letter optionally followed be a number.

Referenced by pkg::env_checker::override_environment().

◆ detected()

bool pkg::env_check::detected ( ) const
inline

Automatic detection result.

References _detected.

Referenced by pkg::env_checker::clear_environment_overrides().

◆ available() [1/2]

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

◆ available() [2/2]

void pkg::env_check::available ( bool  override)
inline

References _available.

◆ type()

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

Type for this check.

Referenced by pkg::env_checker::override_environment().

◆ install_priority()

int pkg::env_check::install_priority ( )
inline

Priority for this check, the higher the more important.

References _install_priority.

Referenced by pkg::env_checker::override_environment().

Member Data Documentation

◆ _description

std::string pkg::env_check::_description
protected

◆ _detected

bool pkg::env_check::_detected
protected

◆ _available

bool pkg::env_check::_available
protected

◆ _install_priority

int pkg::env_check::_install_priority
protected

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

Reference Manual LibPkg Version 0.6.1 (28 Jan 2015)