The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | List of all members
DoublePropertyHandler Class Reference

#include <DoublePropertyHandler.hpp>

Inheritance diagram for DoublePropertyHandler:
Inheritance graph
[legend]

Public Member Functions

void acceptVisitor (PropertyHandlerVisitor *visitor) override
 
double defaultValue () const
 
void insertNames () override
 
bool isValidValue (string value) const override
 
void setValue (double value)
 
double value () const
 
- Public Member Functions inherited from AbstractDoublePropertyHandler
bool isInRange (const vector< double > &value) const
 
bool isInRange (double value) const
 
bool isValidDouble (string value) const
 
bool isValidDoubleList (string value) const
 
 PropertyHandler (const PropertyHandler &)=delete
 
 PropertyHandler (Item *target, const PropertyDef *property, const SchemaDef *schema, NameManager *nameMgr)
 
string quantity () const
 
string rangeDescription () const
 
double toDouble (string value) const
 
vector< double > toDoubleList (string value) const
 
string toString (double value) const
 
string toString (vector< double > value) const
 
- Public Member Functions inherited from PropertyHandler
 PropertyHandler (const PropertyHandler &)=delete
 
 PropertyHandler (Item *target, const PropertyDef *property, const SchemaDef *schema, NameManager *nameMgr)
 
virtual ~PropertyHandler ()=default
 
virtual void acceptVisitor (PropertyHandlerVisitor *visitor)=0
 
virtual vector< Item * > children () const
 
bool hasChanged () const
 
bool hasDefaultValue () const
 
virtual void insertNames ()=0
 
virtual bool isCompound () const
 
bool isConfigured ()
 
bool isConfiguredByUser ()
 
bool isDisplayed () const
 
bool isRelevant () const
 
bool isRequired () const
 
bool isSilent () const
 
virtual bool isValidValue (string value) const =0
 
string name () const
 
NameManagernameManager () const
 
PropertyHandleroperator= (const PropertyHandler &)=delete
 
void rebuildNames ()
 
Itemroot () const
 
const SchemaDefschema () const
 
void setConfiguredByUser (bool valid=true)
 
void setConfiguredToDefault ()
 
void setNotConfigured ()
 
string title () const
 
string type () const
 

Additional Inherited Members

- Protected Member Functions inherited from PropertyHandler
const PropertyDefproperty () const
 
void setChanged ()
 
Itemtarget () const
 

Detailed Description

This class handles SMILE data item properties that hold a single floating point value with an optional unit specification.

Member Function Documentation

◆ acceptVisitor()

void DoublePropertyHandler::acceptVisitor ( PropertyHandlerVisitor visitor)
overridevirtual

Accepts the specified visitor. This function is part of the "visitor" design pattern implementation used to handle properties of various types.

Implements PropertyHandler.

◆ defaultValue()

double DoublePropertyHandler::defaultValue ( ) const

Returns the default value for the handled property, or zero if unavailable.

◆ insertNames()

void DoublePropertyHandler::insertNames ( )
overridevirtual

Causes the name manager associated with this handler to insert names into the global and/or local name sets corresponding to the current value of the target property. For double properties, the function inserts the target property's name if the current property value is nonzero, and does not insert any names if the value is zero. In addition, the function inserts the names provided in the conditional expression of the "insert" attribute of the target property, if any.

Implements PropertyHandler.

◆ isValidValue()

bool DoublePropertyHandler::isValidValue ( string  value) const
overridevirtual

Returns true if the given string can be successfully converted to a value of the property's type. For double properties, the function returns true if the string conforms to the syntax recognized by the AbstractDoublePropertyHandler::isValidDouble() function, and false otherwise.

Implements PropertyHandler.

◆ setValue()

void DoublePropertyHandler::setValue ( double  value)

Sets the value of the handled property in the target item.

◆ value()

double DoublePropertyHandler::value ( ) const

Returns the value of the handled property in the target item.


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