sbuild::chroot_facet Class Reference

Common chroot data. More...

#include <sbuild-chroot-facet.h>

Inheritance diagram for sbuild::chroot_facet:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot_facet:

Collaboration graph
[legend]

List of all members.

Public Types

typedef std::tr1::shared_ptr
< chroot_facet
ptr
 A shared_ptr to a chroot facet object.
typedef std::tr1::shared_ptr
< const chroot_facet
const_ptr
 A shared_ptr to a const chroot facet object.

Public Member Functions

virtual ~chroot_facet ()
 The destructor.
virtual ptr clone () const =0
 Copy the chroot facet.
virtual std::string const & get_name () const =0
 Get the name of the chroot facet.
virtual void setup_env (chroot const &chroot, environment &env) const =0
 Set environment.
virtual chroot::session_flags get_session_flags (chroot const &chroot) const =0
 Get the session flags of the chroot.
virtual void get_details (chroot const &chroot, format_detail &detail) const =0
 Get detailed information about the chroot for output.
virtual void get_keyfile (chroot const &chroot, keyfile &keyfile) const =0
 Copy the chroot properties into a keyfile.
virtual void set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys)=0
 Set the chroot properties from a keyfile.

Protected Member Functions

 chroot_facet ()
 The constructor.
void set_chroot (chroot &chroot)
 Set containing chroot.

Protected Attributes

chrootowner
 Chroot owning this facet.

Friends

class chroot


Detailed Description

Common chroot data.

This class contains all of the metadata associated with a single chroot, for all chroot types. This is the in-core representation of a chroot definition in the configuration file, and may be initialised directly from an open keyfile.


Member Function Documentation

void sbuild::chroot_facet::set_chroot ( chroot chroot  )  [inline, protected]

Set containing chroot.

Parameters:
chroot the chroot containing this facet.

References owner.

virtual ptr sbuild::chroot_facet::clone (  )  const [pure virtual]

virtual std::string const& sbuild::chroot_facet::get_name (  )  const [pure virtual]

virtual void sbuild::chroot_facet::setup_env ( chroot const &  chroot,
environment env 
) const [pure virtual]

virtual chroot::session_flags sbuild::chroot_facet::get_session_flags ( chroot const &  chroot  )  const [pure virtual]

virtual void sbuild::chroot_facet::get_details ( chroot const &  chroot,
format_detail detail 
) const [pure virtual]

virtual void sbuild::chroot_facet::get_keyfile ( chroot const &  chroot,
keyfile keyfile 
) const [pure virtual]

Copy the chroot properties into a keyfile.

The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.

Parameters:
chroot the chroot to use.
keyfile the keyfile to use.

Implemented in sbuild::chroot_facet_mountable, sbuild::chroot_facet_personality, sbuild::chroot_facet_session_clonable, sbuild::chroot_facet_session, sbuild::chroot_facet_source_clonable, sbuild::chroot_facet_source, and sbuild::chroot_facet_union.

virtual void sbuild::chroot_facet::set_keyfile ( chroot chroot,
keyfile const &  keyfile,
string_list used_keys 
) [pure virtual]

Set the chroot properties from a keyfile.

The chroot name must have previously been set, so that the correct keyfile group may be determined.

Parameters:
chroot the chroot to use.
keyfile the keyfile to get the properties from.
used_keys a list of the keys used will be set.

Implemented in sbuild::chroot_facet_mountable, sbuild::chroot_facet_personality, sbuild::chroot_facet_session_clonable, sbuild::chroot_facet_session, sbuild::chroot_facet_source_clonable, sbuild::chroot_facet_source, and sbuild::chroot_facet_union.


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

Generated on Wed Jun 1 08:00:15 2011 for sbuild by  doxygen 1.5.6