rtop::Info Class Reference

data structure that defines type of entry from which panel menu entrires obtain their c-string data More...

#include <info.h>

Public Member Functions
	Info (std::string hdr, std::string short_desc, std::string long_desc)
	Info (std::string hdr, std::string short_desc, std::string long_desc, std::string unit_str)
	Info (const Info &obj)
const char *	Header ()
const char *	longDesc ()
const char *	shortDesc ()
std::string	Unit ()

Private Attributes
std::string	header
	header, longdesc and shortdesc of a panel entry More...
std::string	longdesc
std::string	shortdesc
std::string	units

Detailed Description

data structure that defines type of entry from which panel menu entrires obtain their c-string data

designed for holding string values with additional information.

Todo:

: need to investigate usefulness and performance. investigate and refactor

Definition at line 25 of file info.h.

Constructor & Destructor Documentation

Info() [1/3]

rtop::Info::Info ( std::string  hdr, std::string  short_desc, std::string  long_desc  )

inline

Definition at line 33 of file info.h.

Info() [2/3]

rtop::Info::Info ( std::string  hdr, std::string  short_desc, std::string  long_desc, std::string  unit_str  )

inline

Definition at line 41 of file info.h.

Info() [3/3]

rtop::Info::Info ( const Info &  obj )

inline

Definition at line 49 of file info.h.

Member Function Documentation

Header()

const char* rtop::Info::Header ( )

inline

Definition at line 57 of file info.h.

longDesc()

const char* rtop::Info::longDesc ( )

inline

Definition at line 58 of file info.h.

shortDesc()

const char* rtop::Info::shortDesc ( )

inline

Definition at line 59 of file info.h.

Unit()

std::string rtop::Info::Unit ( )

inline

Definition at line 60 of file info.h.

Member Data Documentation

header

std::string rtop::Info::header

private

header, longdesc and shortdesc of a panel entry

Definition at line 29 of file info.h.

longdesc

std::string rtop::Info::longdesc

private

Definition at line 29 of file info.h.

shortdesc

std::string rtop::Info::shortdesc

private

Definition at line 29 of file info.h.

units

std::string rtop::Info::units

private

Definition at line 31 of file info.h.

---

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

• /home/rk/Documents/Repos/in_progress/rtop/include/info.h