casa::viewer::Options Class Reference

#include <Options.h>

Classes
class	Kernel

Public Member Functions
std::string	tmp () const
std::string	temporaryPath (const std::string &base_name, bool remove=true)
	this returns a path to be used as a temporary file or directory, and by default, deletes the file when the viewer exits... More...
	Options ()
	~Options ()

Private Types
typedef std::map< std::string, std::pair< std::string, bool > >	path_map

Private Member Functions
	Options (const Options &)
const Options &	operator= (const Options &)
void	init (Kernel *k)
void	finalize ()
std::string	_temporary_path_ (const std::string &, bool)

Private Attributes
path_map *	returned_paths
Kernel *	kernel

Friends
class	options_init_

Detailed Description

Definition at line 38 of file Options.h.

Member Typedef Documentation

typedef std::map<std::string,std::pair<std::string,bool> > casa::viewer::Options::path_map

private

Definition at line 76 of file Options.h.

Constructor & Destructor Documentation

casa::viewer::Options::Options ( )

inline

Definition at line 61 of file Options.h.

casa::viewer::Options::~Options ( )

inline

Definition at line 62 of file Options.h.

casa::viewer::Options::Options ( const Options &  )

inlineprivate

Definition at line 67 of file Options.h.

Member Function Documentation

std::string casa::viewer::Options::_temporary_path_ ( const std::string &  , bool    )

private

Referenced by temporaryPath().

void casa::viewer::Options::finalize ( )

private

Referenced by casa::viewer::options_init_::~options_init_().

void casa::viewer::Options::init ( Kernel *  k )

inlineprivate

Definition at line 71 of file Options.h.

References kernel, and returned_paths.

const Options& casa::viewer::Options::operator= ( const Options &  )

inlineprivate

Definition at line 68 of file Options.h.

std::string casa::viewer::Options::temporaryPath ( const std::string &  base_name, bool  remove = true  )

inline

this returns a path to be used as a temporary file or directory, and by default, deletes the file when the viewer exits...

the "base_name" is just the name to be used as a starting point for finding a unique file name, an example would be "my_tmp_file"... but it could be anything (not including directories, i.e. "/")... this function guarantees that no two returned strings will be identical... and that all will be valid path names...

Definition at line 57 of file Options.h.

References _temporary_path_().

std::string casa::viewer::Options::tmp ( ) const

inline

Definition at line 46 of file Options.h.

References kernel, and casa::viewer::Options::Kernel::tmp().

Friends And Related Function Documentation

friend class options_init_

friend

Definition at line 66 of file Options.h.

Member Data Documentation

Kernel* casa::viewer::Options::kernel

private

Definition at line 78 of file Options.h.

Referenced by init(), and tmp().

path_map* casa::viewer::Options::returned_paths

private

Definition at line 77 of file Options.h.

Referenced by init().

---

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

• casa/code/display/Display/Options.h