carma::ui::rtd Namespace Reference

User Interface Realtime Display Windows. More...

Classes
class	AngleCell
	@ brief A Cell that displays the current value of a MonitorPoint that represents an angle More...
class	CarmaWindows
	Class to define the specific set of windows and code words for Carma. More...
class	Cell
	An abstract realtime (dynamic) text Cell. More...
class	CellCatString
	A Cell containing a string composed of 2 pieces which are concatenated together. More...
class	CellChar
	A Cell with character data (signed) treated as an int. More...
class	CellCharString
	A Cell containing a string based on a char*. More...
class	CellDateUT
	A Cell with MJD data formatted as Date followed by the UT. More...
class	CellDble
	A Cell that displays the contents of a double. More...
class	CellDbleMM
	A CellDble variant with max and min limits to set background colors. More...
class	CellDbleTol
	A Cell with a double for data and dynamic absolute tolerances. More...
class	CellDEC
	A Cell for Declination. More...
class	CellEmpty
	A Cell that is empty that can be used as filler in tables. More...
class	CellFloat
	A Cell that displays the contents of a float. More...
class	CellFloatMM
	A CellDble variant with max and min limits to set background colors. More...
class	CellFloatTol
	A Cell with a double for data and dynamic absolute tolerances. More...
class	CellInt
	A Cell with integer (long) data. More...
class	CellRA
	A Cell for Right Ascension. More...
class	CellRADEC
	Base class for the RA and DEC Cells. More...
class	CellShort
	A Cell with short integer data. More...
class	CellShortMM
	A Cell with short data and thresholds for setting background color. More...
class	CellString
	A Cell containing a string based on a std::string. More...
class	CellUChar
	A Cell with unsigned character data treated as an int. More...
class	CellUT
	Takes an MJD and formats output as UT. More...
struct	Cnx
	Structure definition for a single connection to the system. More...
class	ColorVisitor
	Visitor that post processes a set of MonitorCell to have good and bad colors set to something other than the default. More...
class	CompositeMonitorTableVisitor
	Composite design pattern implementation for MonitorTableVisitor interface. More...
class	ConnectionBase
	Base class for the connection objects. More...
struct	ConnectionData
	Structure definition for keeping track of all connections, windows, and user control of the system. More...
class	ConnectionRO
	Class to access connection shared memory object with readonly mode. More...
class	ConnectionRW
	Class to access connection shared memory object with read/write mode. More...
class	DisplayTimeOnlyVisitor
	Visitor to display time only instead of full Date and Time. More...
class	Format
	Class to describe the layout of text within a cell. More...
class	GoodIsGreenVisitor
	Visitor that post processes a set of MonitorCell to have green as their good color. More...
class	GrayedOutVisitor
	Visitor that post processes a set of MonitorCell to be grayed out. More...
class	MasterServer
	This object is the master data server for java monitor and control programs for the Carma. More...
class	MemoryMappedFile
	Memory Mapped file is a class that provides a C++ interface to the mmap(2) system call. More...
class	MemoryMappedFileException
	Exceptions for MemoryMappedFile's. More...
class	MonitorCell
	A Cell that displays the current value of a MonitorPoint, with the background color gotten from a second MP. More...
class	ReaderWithTimeout
	Read a series of bytes with a timeout and return a raw byte string with the contents of the read. More...
class	RowVisitor
	Visitor that uses the long monitor point names for row labels instead of the short ones. More...
class	RtArea
	A container and an associated line oriented layout manager suitable for multiline layout of grouped objects. More...
class	RtBox
	Container that handles layout of components with a "BoxLayout". More...
class	RtColumn
	A column for a table. More...
class	RtContainer
	A base bordered container class for RtObjects. More...
class	RtDisplay
	Realtime display - the whole enchilada. More...
class	RtFolder
	A vertical box that defines a folder. More...
class	RtHBox
	RtBox with horizontal layout. More...
class	RtLabel
	A static label. More...
class	RtMenu
	A menu for creating new windows. More...
class	RtObject
	Base class for everything that can be put in a realtime display. More...
class	RtRow
	A row for a table. More...
class	RtSpacer
	A static component that provides spacing inside of boxes (with BoxLayout). More...
class	RtSpring
	A static component that provides spacing inside of boxes (with BoxLayout). More...
class	RtStatic
	An abstract class for static components that are not updated and do not contain other components. More...
class	RtTable
	Displays Cells in a tabular format. More...
class	RtTimePanel
	A panel with time strings. More...
class	RtTimeString
	Time string sends over the UT, LST and local time. More...
class	RtTitledObj
	Base class for RtObjects with titles, such as a container. More...
class	RtVBox
	RtBox with vertical layout. More...
class	SenderAddress
	SenderAddress stores and makes available peer information for the opposite (client) end of a connected socket. More...
class	Version
	Class to read and contain versioning info for C++ server and Java client RTD programs. More...
class	WindowList
	A list of all possible windows on a system and methods to find them. More...
class	ZebraVisitor
	Visitor that post processes a set of MonitorCell to have zebra-like coloring (alternating white and gray rows) More...

Typedefs
typedef boost::shared_ptr < AngleCell >	AngleCellPtr
typedef enum carma::ui::rtd::angleFormatTypeEnum	angleFormatType
typedef enum carma::ui::rtd::CellColorEnum	CellColor
	Cell color choices. More...
typedef boost::shared_ptr< Cell >	CellPtr
typedef boost::shared_ptr < CompositeMonitorTableVisitor >	CompositeMonitorTableVisitorPtr
typedef boost::shared_ptr < DisplayTimeOnlyVisitor >	DisplayTimeOnlyVisitorPtr
typedef enum carma::ui::rtd::modulusTypeEnum	modulusType
typedef boost::shared_ptr < MonitorCellMapped >	MonitorCellMappedPtr
typedef boost::shared_ptr < MonitorCell >	MonitorCellPtr
typedef boost::shared_ptr < MonitorCellScaled >	MonitorCellScaledPtr
typedef boost::shared_ptr < MonitorSingleTableFolder >	MonitorSingleTableFolderPtr
typedef boost::shared_ptr < MonitorTable >	MonitorTablePtr
typedef boost::shared_ptr < MonitorTableVisitor >	MonitorTableVisitorPtr
typedef boost::shared_ptr< RtArea >	RtAreaPtr
typedef boost::shared_ptr < RtAzelPlot >	RtAzelPlotPtr
typedef boost::shared_ptr< RtBox >	RtBoxPtr
typedef boost::shared_ptr < RtColumn >	RtColPtr
typedef boost::shared_ptr < RtColumn >	RtColumnPtr
typedef boost::shared_ptr < RtFolder >	RtFolderPtr
typedef boost::shared_ptr< RtHBox >	RtHBoxPtr
typedef boost::shared_ptr < RtLabel >	RtLabelPtr
typedef boost::shared_ptr< RtMenu >	RtMenuPtr
typedef boost::shared_ptr < RtObject >	RtObjectPtr
typedef boost::shared_ptr< RtRow >	RtRowPtr
typedef boost::shared_ptr < RtSpacer >	RtSpacerPtr
typedef boost::shared_ptr < RtSpring >	RtSpringPtr
typedef boost::shared_ptr < RtTable >	RtTablePtr
typedef boost::shared_ptr < RtTimePanel >	RtTimePanelPtr
typedef boost::shared_ptr< RtVBox >	RtVBoxPtr
typedef boost::shared_ptr < ZebraVisitor >	ZebraVisitorPtr

Enumerations
enum	angleFormatTypeEnum {   FORMAT_HMS, FORMAT_DMS, FORMAT_DECIMAL_HOURS, FORMAT_DECIMAL_DEGREES,   FORMAT_RADIANS }
enum	AuthenticationStatus { AUTH_SUCCESS, AUTH_FAILURE, AUTH_EXIT }
enum	Border {   TWO_PIXELS_ALL_SIDES_BORDER, TWO_PIXELS_LEFT_RIGHT_BOTTOM_BORDER, TWO_PIXELS_BELOW_BORDER, ONE_PIXEL_ABOVE_BORDER,   ONE_PIXEL_BELOW_BORDER, ONE_PIXEL_RIGHT_BORDER, ONE_PIXEL_LEFT_BORDER, NO_BORDER }
	Possible border styles for RtContainer objects. More...
enum	CellColorEnum {   WHITE_CELL_COLOR, RED_CELL_COLOR, YELLOW_CELL_COLOR, GREEN_CELL_COLOR,   BLUE_CELL_COLOR, ORANGE_CELL_COLOR, CYAN_CELL_COLOR, MAGENTA_CELL_COLOR,   BLACK_CELL_COLOR, PURPLE_CELL_COLOR, LIGHT_GRAY_CELL_COLOR, STRIPE_LIGHT_CELL_COLOR,   STRIPE_DARK_CELL_COLOR, LIGHT_GRAY_TEXT_CELL_COLOR, EMPTY_CELL_COLOR }
	Cell color choices. More...
enum	FontType { FONT_PLAIN, FONT_BOLD, FONT_ITALIC, FONT_BOLD_ITALIC }
	Font type choices. More...
enum	Grouping { GROUP_EXACT, GROUP_ANTTYPE, GROUP_SUBARRAY }
enum	Layout {   NONE_LAYOUT, UNFILLED_LAYOUT, CHAIN_LAYOUT, EOL_CENTERED_LAYOUT,   EOL_RIGHT_JUSTIFIED_LAYOUT, EOL_LEFT_JUSTIFIED_LAYOUT }
	Layout choices. More...
enum	modulusTypeEnum { MOD_TWO_PI, MOD_PI, MOD_NONE }
enum	Operator {   OPER_NONE, OPER_MULT, OPER_DIV, OPER_ADD,   OPER_SUB }

Functions
void	addControlAntsFolder (MonitorDisplay &display)
void	addControlReachableFolder (MonitorDisplay &display)
int	calcReachableCellWidth ()
void	compressLZMA (const std::string &src, const uint32_t level, std::string &dst)
	Compress a buffer of bytes using LZMA. More...
void	compressZLIB (const std::string &src, const uint32_t level, std::string &dst)
	Compress a buffer of bytes using ZLIB. More...
void	decompressLZMA (const std::string &src, std::string &dst)
	Decompress a buffer of bytes using LZMA. More...
void	decompressZLIB (const std::string &src, std::string &dst)
	Decompress a buffer of bytes using ZLIB. More...
RtBoxPtr	makeAntTableBox (const int saNo, CompositeSubarrayDisplay *display, const SubarrayStatus *saStatus)
RtFolderPtr	makeFolderForSubarray (const int saNo, CompositeSubarrayDisplay *display, const SubarrayStatus *saStatus)
RtHBoxPtr	makeSourceInfoBox (const int saNo, CompositeSubarrayDisplay *display, const SubarrayStatus *saStatus)
std::ostream &	operator<< (std::ostream &os, AntennaMapper::AntennaType &type)
void	postprocessReachableCell (MonitorCellBool &cell)
bool	serializeMessageToStdout (const ::google::protobuf::Message &msg, bool compress=true)
	Serialize a Google Protocol Buffer to stdout in the following format: More...

Variables
const int	AUTO_SIZE = 0
	Indicate to MonitorSingleTableFolder that we want column widths to be automatically calculated with all columns equal width. More...
const int	AUTO_SIZE_EACH_COLUMN = -1
	Indicate to MonitorSingleTableFolder that we want column widths to be automatically calculated with each column sized individually. More...
const int	NUMBEROF_CONNECTIONS = 150
const int	SIZEOF_COMPACTNAME = 40
const int	SIZEOF_CONNECTSTART = 20
const int	SIZEOF_FULLLOCATION = 50
const int	SIZEOF_FULLNAME = 40
const int	SIZEOF_LOCATION = 10
const int	SIZEOF_LONGUSERNAME = 60
const int	SIZEOF_USERNAME = 14
const int	SIZEOF_WINDOWNAME = 20
const int	SIZEOF_WINDOWUPDATE = 10

Detailed Description

User Interface Realtime Display Windows.

Typedef Documentation

typedef enum carma::ui::rtd::CellColorEnum carma::ui::rtd::CellColor

Cell color choices.

Enumeration Type Documentation

enum carma::ui::rtd::angleFormatTypeEnum

Enumerator
FORMAT_HMS	Display in sexagesimal HH:MM:SS.S.
FORMAT_DMS	Display in sexagesimal DD:MM:SS.S.
FORMAT_DECIMAL_HOURS	Display in decimal hours.
FORMAT_DECIMAL_DEGREES	Display in decimal degrees.
FORMAT_RADIANS	Display in radians.

Definition at line 29 of file AngleCell.h.

enum carma::ui::rtd::Border

Possible border styles for RtContainer objects.

Definition at line 1378 of file RtDisplay.h.

enum carma::ui::rtd::CellColorEnum

Cell color choices.

Definition at line 261 of file RtDisplay.h.

enum carma::ui::rtd::FontType

Font type choices.

Definition at line 57 of file RtDisplay.h.

enum carma::ui::rtd::Layout

Layout choices.

Definition at line 47 of file RtDisplay.h.

enum carma::ui::rtd::modulusTypeEnum

Enumerator
MOD_TWO_PI	Modulus 0 to 2PI.
MOD_PI	Modulus -PI to PI.
MOD_NONE	No Modulus.

Definition at line 52 of file AngleCell.h.

Function Documentation

void carma::ui::rtd::compressLZMA	(	const std::string &	src,
		const uint32_t	level,
		std::string &	dst
	)

Compress a buffer of bytes using LZMA.

Parameters

src	the buffer to compress
level	the level to compress with (0 == fast,large / 9 == slow,small)
dst	the buffer containing the output

void carma::ui::rtd::compressZLIB	(	const std::string &	src,
		const uint32_t	level,
		std::string &	dst
	)

Compress a buffer of bytes using ZLIB.

Parameters

src	the buffer to compress
level	the level to compress with (0 == fast,large / 9 == slow,small)
dst	the buffer containing the output

void carma::ui::rtd::decompressLZMA	(	const std::string &	src,
		std::string &	dst
	)

Decompress a buffer of bytes using LZMA.

Parameters

src	the compressed buffer of bytes
dst	the buffer in which to place the result

void carma::ui::rtd::decompressZLIB	(	const std::string &	src,
		std::string &	dst
	)

Decompress a buffer of bytes using ZLIB.

Parameters

src	the compressed buffer of bytes
dst	the buffer in which to place the result

bool carma::ui::rtd::serializeMessageToStdout	(	const ::google::protobuf::Message &	msg,
		bool	compress = true
	)

Serialize a Google Protocol Buffer to stdout in the following format:

• number of bytes: 4-byte network byte order integer
• protocol buffer: n bytes long (optionally ZLIB compressed)

Variable Documentation

const int carma::ui::rtd::AUTO_SIZE = 0

Indicate to MonitorSingleTableFolder that we want column widths to be automatically calculated with all columns equal width.

Definition at line 43 of file MonitorTable.h.

const int carma::ui::rtd::AUTO_SIZE_EACH_COLUMN = -1

Indicate to MonitorSingleTableFolder that we want column widths to be automatically calculated with each column sized individually.

Definition at line 49 of file MonitorTable.h.