A Cell that displays the current value of a MonitorPoint, with the background color gotten from a second MP. More...

#include <carma/ui/rtd/common/MonitorCell.h>

Inheritance diagram for carma::ui::rtd::MonitorCell:

Public Member Functions
void	colorIf (monitor::MonitorPoint &mp, sza::util::MonitorCondition condition, int sampleNo=0)

void	colorIfFrequencyInGHz (sza::util::MonitorCondition condition)

bool	conditionsAreMet ()

std::string	getName ()

bool	hasAntenna ()

void	removeGoodColorTextOverride (const ::std::string &text)

void	setAntenna (AntennaMapper::Antenna *ant)

void	setErrorColor (CellColor errorColor)

void	setGoodColor (CellColor goodColor)

void	setGoodColorTextOverride (const ::std::string &text, CellColor color)

void	setNotruncate ()
	Don't truncate value string; display stars if it overflows cell. More...

void	setWarnColor (CellColor warnColor)

virtual void	update ()
	Creates a new string that is the dynamic ascii contents of this object. More...

virtual void	updateColor ()
	Automatically called as part of the update cycle to set background color. More...

virtual	~MonitorCell ()
	destructor More...

Public Member Functions inherited from carma::ui::rtd::Cell
int	addAlternative (const ::std::string &text, CellColor color)
	Add an alternate text string. More...

bool	alternativeIsActive () const

	Cell (int indent, int chars, int width)
	Constructor. More...

	Cell (const char *fmt, int altLen=0)
	Constructor. More...

	Cell (const Format &fmt, int altLen=0)
	Constructor. More...

void	clearActiveAlternative ()

char	getAudio ()
	Get audio state code. More...

std::string	getCellName () const

std::string	getDynamicDescription () const

int	getIndent () const
	Get the indentation for the text. More...

int	getLen () const
	Get the length of the text string. More...

::std::string	getPlotLabel () const
	Get the plot label. More...

std::string	getText ()
	Get the dynamic text. More...

bool	isGrayedOut ()

bool	isPlottable () const
	Can contents be plotted (can it be converted to a number)? More...

bool	isReplaceText () const
	Is this the dynamically formatted text or is it a replacement string set by nohw, overflow or an altString? More...

bool	isValid ()
	Check validity of cell. More...

void	serialize (bool initialize, int fontSize,::rtdproto::RtObject *rtobj)
	Describe (serialize) the static description of the cell. More...

void	setActiveAlternative (int index)
	Select which alternate string to use. More...

void	setAudio (char c)
	Set audio state code. More...

void	setBorderBottomEnabled (bool state)

void	setBorderLeftEnabled (bool state)

void	setBorderRightEnabled (bool state)

void	setBorderTopEnabled (bool state)
	Enable/disbable an edge of the cell border. More...

void	setCellName (const std::string &s)

void	setColor (CellColor color)
	Sets the single character background color code. More...

void	setDynamicDescription (const std::string &s)

void	setEmpty (bool state)

void	setGrayedOut (bool state)

void	setNa (bool tf)
	Set the "not applicable" flag to true/false. More...

void	setNoAudio ()
	Turn off audio capability for the cell. More...

void	setNohw (bool tf)
	Set the "no hardware" flag to true/false. More...

void	setNohwColor (CellColor color)
	Sets the single character background color to use when there is no hardware. More...

void	setPlotLabel (const ::std::string &s)
	Sets the label for a plot. More...

void	setPlotLabel (int a, bool dev, const ::std::string &s)
	Creates a label string for a plot based on antenna & rx. More...

void	setPlottable (bool yesOrNo)
	Sets whether the cell data may be plotted. More...

void	setValidity (bool validity)
	Set the validity of cell. More...

Public Member Functions inherited from carma::ui::rtd::RtObject
void	appendToolTipText (const std::string &text)
	Append more text to the existing tool tip text. More...

Layout	getLayout () const
	Get the layout for this object. More...

std::string	getToolTipText ()

void	setFontSize (int fontSize)
	Set the absolute font size for this object. More...

void	setLayout (Layout layout)
	Set the layout for this object. More...

void	setToolTipText (const std::string &text)
	Set the tool tip text for this RtObject. More...

virtual	~RtObject ()
	Destructor. More...

Static Public Member Functions
static MonitorCellPtr	makeCell (monitor::MonitorPoint &monitorPoint)

static MonitorCellPtr	makeCell (monitor::MonitorPoint &monitorPoint, int sampleNo)

static MonitorCellPtr	makeCell (int cellWidth, monitor::MonitorPoint &monitorPoint)

static MonitorCellPtr	makeCell (int cellWidth, monitor::MonitorPoint &monitorPoint, int sampleNo)

static MonitorCellPtr	makeCell (monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor)

static MonitorCellPtr	makeCell (monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor, int sampleNo)

static MonitorCellPtr	makeCell (int cellWidth, monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor)

static MonitorCellPtr	makeCell (int cellWidth, monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor, int sampleNo)

Protected Types
typedef ::std::map < ::std::string, CellColor >	StringToColorMap

Protected Member Functions
virtual CellColor	computeColor ()

virtual CellColor	computeErrorColor ()

virtual CellColor	computeGoodColor ()

virtual ::std::string	computeText ()

virtual CellColor	computeWarnColor ()

int	getSampleNo () const

	MonitorCell (int cellWidth, bool setMpWidth, monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor, int sampleNo)
	Constructor. More...

	MonitorCell (int cellWidth, bool setMpWidth, monitor::MonitorPoint &monitorPoint, int sampleNo)
	Constructor. More...

	MonitorCell (const MonitorCell &rhs)

MonitorCell &	operator= (const MonitorCell &rhs)

int	setMpWidthToFormatLength ()
	Sets the monitor point width to the internal Cell Format width. More...

Protected Member Functions inherited from carma::ui::rtd::Cell
::std::string	centerStringFmt (const ::std::string &s) const
	Helper to trim and center the formatted string. More...

void	updateInt (int data)
	Create an output string for an integer. More...

Protected Member Functions inherited from carma::ui::rtd::RtObject
int	getFontSize (int parentFontSize) const
	Get the absolute font size for this object. More...

int	getFontSize () const
	Get the absolute font size for this object. More...

	RtObject ()
	Constructor. More...

Static Protected Member Functions
static MonitorCellPtr	makeCell (int cellWidth, bool setMpWidth, monitor::MonitorPoint &monitorPoint, int sampleNo)

static MonitorCellPtr	makeCell (int cellWidth, bool setMpWidth, monitor::MonitorPoint &monitorPoint, monitor::MonitorPoint &mpColor, int sampleNo)

Protected Attributes
AntennaMapper::Antenna *	antenna_

std::vector< Condition >	conditions_

CellColor	defaultGoodColor_

CellColor	errorColor_

::std::auto_ptr< StringToColorMap >	goodColorTextOverrides_

monitor::MonitorPoint &	mp_

monitor::MonitorPoint &	mpc_

const int	sampleNo_

bool	truncateFlag_

CellColor	warnColor_

Protected Attributes inherited from carma::ui::rtd::Cell
char	audio
	Audio cell control ('E'/'Y'/'N') - enabled,y,n. More...

::std::ostringstream	fmtOss_
	Formatted text stream. More...

const Format	format_
	Format for cell data. More...

int	indent
	Left indent of chars. More...

const char *	legit
	Deprecated... More...

int	len
	Total number of chars. More...

::std::string	text
	Formatted text. More...

Detailed Description

A Cell that displays the current value of a MonitorPoint, with the background color gotten from a second MP.

By default, the string is truncated if its length exceeds the amount of space allocated in the cell. This behavior may be changed to give the standard overflow message of a string of stars with the setNotruncate option. By default, the MP for the background MP is the same as the one for the value.

Definition at line 55 of file MonitorCell.h.

Constructor & Destructor Documentation

virtual carma::ui::rtd::MonitorCell::~MonitorCell ( )

virtual

destructor

carma::ui::rtd::MonitorCell::MonitorCell	(	int	cellWidth,
		bool	setMpWidth,
		monitor::MonitorPoint &	monitorPoint,
		monitor::MonitorPoint &	mpColor,
		int	sampleNo
	)

protected

Constructor.

Parameters

cellWidth	cell width in characters
setMpWidth	use the cellWidth; otherwise use width from MP
monitorPoint	reference to the MonitorPoint to display
mpColor	reference to the MonitorPoint to use for the background color
sampleNo	For monitor points with multiple samples, the sample number to use in the display. Default is zero, which means use the average of all samples.

carma::ui::rtd::MonitorCell::MonitorCell	(	int	cellWidth,
		bool	setMpWidth,
		monitor::MonitorPoint &	monitorPoint,
		int	sampleNo
	)

protected

Constructor.

Parameters

cellWidth	cell width in characters
setMpWidth	use the cellWidth; otherwise use width from MP
monitorPoint	reference to the MonitorPoint to display
sampleNo	For monitor points with multiple samples, the sample number to use in the display. Default is zero, which means use the average of all samples.

Member Function Documentation

int carma::ui::rtd::MonitorCell::setMpWidthToFormatLength ( )

protected

Sets the monitor point width to the internal Cell Format width.

Returns: the width that was set

void carma::ui::rtd::MonitorCell::setNotruncate ( )

Don't truncate value string; display stars if it overflows cell.

virtual void carma::ui::rtd::MonitorCell::update ( )

virtual

Creates a new string that is the dynamic ascii contents of this object.

The size of the string is fixed and described by serialize().

See Also: serialize

Implements carma::ui::rtd::RtObject.

virtual void carma::ui::rtd::MonitorCell::updateColor ( )

virtual

Automatically called as part of the update cycle to set background color.

Reimplemented from carma::ui::rtd::Cell.

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

carma/ui/rtd/common/MonitorCell.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation