Implementation of DParameterChoice to store color selection parameters. More...

#include <DParameterColorChoice.h>

Inheritance diagram for casa::DParameterColorChoice:

Public Member Functions
	DParameterColorChoice (const casacore::String name, const casacore::String description, const casacore::String help, const casacore::String context="", const casacore::Bool editable=true)
	Constructor takes the name of the parameter, a short description and some help text. More...

	DParameterColorChoice (const DParameterColorChoice &other)
	Copy constructor using copy semantics. More...

virtual	~DParameterColorChoice ()
	Destructor. More...

DParameterColorChoice &	operator= (const DParameterColorChoice &other)
	Copy assignment. More...

Public Member Functions inherited from casa::DParameterChoice
	DParameterChoice (const casacore::String name, const casacore::String description, const casacore::String help, const casacore::Vector< casacore::String > &options, const casacore::String defaultvalue, const casacore::String value, const casacore::String context="", const casacore::Bool editable=false)
	Constructor taking the name of the parameter, a short description, some help text, a list of allowed options, a default value, an initial value, the context of the parameter, and a flag indicating whether the parameter is editable. More...

	DParameterChoice (const casacore::String name, const casacore::String description, const casacore::String help, const ColormapDefinition::colormapnamemap &options, const casacore::String defaultvalue, const casacore::String value, const casacore::String context="", const casacore::Bool editable=false)

	DParameterChoice (const DParameterChoice &other)
	(Required) copy constructor. More...

virtual	~DParameterChoice ()
	Destructor. More...

DParameterChoice &	operator= (const DParameterChoice &other)
	(Required) copy assignment. More...

virtual casacore::Bool	fromRecord (const casacore::RecordInterface &record)
	Parse `record`, and update this parameter if a field exists whose name matches that of this parameter. More...

virtual void	toRecord (casacore::RecordInterface &record, const casacore::Bool fullrecord=true, const casacore::Bool overwrite=false)
	Place a record describing this parameter in a sub-field of `record` with name matching that of this parameter. More...

casacore::Vector < casacore::String >	options () const
	Return the list of allowed options for this parameter. More...

casacore::String	defaultValue ()
	Return the default for this parameter. More...

casacore::String	value ()
	Return the current value of this parameter. More...

void	setEditable (const casacore::Bool editable)
	Set or change if this parameter is editable (determines wether choice or userchoice is returned in the record. More...

void	setOptions (const casacore::Vector< casacore::String > &options)
	Set or change the list of allowed options for this parameter. More...

void	setDefaultValue (const casacore::String defaultvalue)
	Set or change the default value for this parameter. More...

void	setValue (const casacore::String value)
	Set or change the current value. More...

const casacore::String &	operator= (const casacore::String &value)
	Convenient syntax to set (only) the value. More...

casacore::Bool	existsOption (const casacore::String value)
	Determine whether this value exists in the list of options. More...

Public Member Functions inherited from casa::DisplayParameter
virtual	~DisplayParameter ()
	Destructor. More...

casacore::String	name () const
	Return the name of this parameter. More...

casacore::String	description () const
	Return the description of this parameter. More...

casacore::String	help () const
	Return the help for this parameter. More...

casacore::String	context () const
	Return the context of this parameter. More...

casacore::Bool	allowUnset () const
	Return whether this parameter can be unset. More...

casacore::Bool	editable () const
	Return whether this parameter is editable. More...

void	setName (const casacore::String name)
	Set or change the name of this parameter to that specified. More...

void	setDescription (const casacore::String description)
	Set or change the description of this parameter to what is specified. More...

void	setHelp (const casacore::String help)
	Set or change the help for this parameter to what is specified. More...

void	setContext (const casacore::String context)
	Set or change the context of this parameter to what is specified. More...

void	setAllowUnset (const casacore::Bool allowunset)
	Set or change whether this parameter may be unset, according to the function argument value. More...

void	setEditable (const casacore::Bool editable)
	Set or change whether this parameter is editable according to the function argument. More...

Protected Member Functions
	DParameterColorChoice ()
	(Required) default constructor. More...

Protected Member Functions inherited from casa::DParameterChoice
	DParameterChoice ()
	(Required) default constructor. More...

Protected Member Functions inherited from casa::DisplayParameter
	DisplayParameter (const casacore::String name, const casacore::String description, const casacore::String help, const casacore::String context="", const casacore::Bool allowunset=false, const casacore::Bool editable=true)
	Constructor taking the name of the parameter, a short description, some help text, and flags indicating whether the parameter can be unset and is editable. More...

	DisplayParameter (const DisplayParameter &other)
	Copy constructor using copy semantics. More...

	DisplayParameter ()
	Default constructor yielding a useless DisplayParameter. More...

DisplayParameter &	operator= (const DisplayParameter &other)
	Copy assignment. More...

casacore::Record	baseDescription ()
	Return a basic description of this parameter; used by virtual implementations of `toRecord` method to fill out a casacore::Record describing this DisplayParameter. More...

const DisplayOptions &	displayOptions () const
	Return the DisplayOptions to use for parsing Records. More...

Detailed Description

Implementation of DParameterChoice to store color selection parameters.

Intended use:

Public interface

Prerequisite

DParameterChoice

Etymology

DParameterColorChoice is an implementation of a DisplayParameter providing a choice parameter type tuned to selecting colors.

Motivation

It is common to have the user select a color for a particular element of the display, hence this class.

Thrown Exceptions

None.

To Do

Nothing known.

Definition at line 66 of file DParameterColorChoice.h.

Constructor & Destructor Documentation

casa::DParameterColorChoice::DParameterColorChoice	(	const casacore::String	name,
		const casacore::String	description,
		const casacore::String	help,
		const casacore::String	context = `""`,
		const casacore::Bool	editable = `true`
	)

Constructor takes the name of the parameter, a short description and some help text.

The context of the parameter, and whether it is editable, can also be given. The default and initial color is always the foreground color.

casa::DParameterColorChoice::DParameterColorChoice ( const DParameterColorChoice & other )

Copy constructor using copy semantics.

virtual casa::DParameterColorChoice::~DParameterColorChoice ( )

virtual

Destructor.

casa::DParameterColorChoice::DParameterColorChoice ( )

protected

(Required) default constructor.

Member Function Documentation

DParameterColorChoice& casa::DParameterColorChoice::operator= ( const DParameterColorChoice & other )

Copy assignment.

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

casa/code/display/Display/DParameterColorChoice.h

Public Member Functions

Protected Member Functions