Example

A DParameterString can easily be used to store and update any parameter which can be expressed as a String. In the following example, a DParameterString is constructed to store some text to be used for axis labelling:

    DParameterString pstring("xaxislabel", "X Axis Label", 
                             "Enter the text to appear alongside the X Axis");
    
    // ...
    
    // update the parameter from some Record
    pstring.fromRecord(rec);
    
    // examine the value of the parameter
    if (pstring.value() == "Four frogs found fabulous frocks") {
    // ...
    }
    

Motivation

Thrown Exceptions

• None.

To Do

• Nothing known.

Member Description

DParameterString(const String name, const String description, const String help, const String defaultvalue, const String value, const String context = "", const Bool editable = True)

DParameterString(const DParameterString &other)

(Required) copy constructor.

virtual ~DParameterString()

Destructor.

DParameterString &operator=(const DParameterString &other)

(Required) copy assignment.

virtual Bool fromRecord(const RecordInterface &record)

Parse record, and update this parameter if a field exists whose name matches that of this parameter. Return True if the parameter is changed, otherwise return False.

virtual void toRecord(RecordInterface &record, const Bool fullrecord = True, const Bool overwrite = False)

Place a record describing this parameter in a sub-field of record with name matching that of this parameter. If overwrite is True, then any existing field with matching name will be overwritten. If fullrecord is True, then a complete description of the parameter is given, otherwise just its current value is stored in record. Presently fullrecord is ignored.

String defaultValue()

Return the default for this parameter.

String value()

Return the current value of this parameter.

DParameterString()