The SKIRT project
advanced radiative transfer for astrophysics
IntPropertyHandler Class Reference

#include <IntPropertyHandler.hpp>

Inheritance diagram for IntPropertyHandler:

Public Member Functions

void acceptVisitor (PropertyHandlerVisitor *visitor) override
int defaultValue () const
void insertNames () override
bool isValidValue (string value) const override
int maxValue () const
int minValue () const
 PropertyHandler (const PropertyHandler &)=delete
 PropertyHandler (Item *target, const PropertyDef *property, const SchemaDef *schema, NameManager *nameMgr)
void setValue (int value)
int 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 vector< Item * > children () const
bool hasChanged () const
bool hasDefaultValue () const
virtual bool isCompound () const
bool isConfigured ()
bool isConfiguredByUser ()
bool isDisplayed () const
bool isRelevant () const
bool isRequired () const
bool isSilent () const
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 of integer types.

Member Function Documentation

◆ acceptVisitor()

void IntPropertyHandler::acceptVisitor ( PropertyHandlerVisitor * visitor)
overridevirtual

Accepts the specified property handler visitor.

Implements PropertyHandler.

◆ defaultValue()

int IntPropertyHandler::defaultValue ( ) const

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

◆ insertNames()

void IntPropertyHandler::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 integer 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 IntPropertyHandler::isValidValue ( string value) const
overridevirtual

Returns true if the given string can be successfully converted to a value of the property's type. For integer properties, the function returns true if the string conforms to the regular syntax for a decimal integer, and false otherwise.

Implements PropertyHandler.

◆ maxValue()

int IntPropertyHandler::maxValue ( ) const

Returns the maximum value for the handled property. If no maximum value is specified in the property definition, the function returns a default maximum value close to the largest representable integer.

◆ minValue()

int IntPropertyHandler::minValue ( ) const

Returns the minimum value for the handled property. If no minimum value is specified in the property definition, the function returns a default minimum value close to the smallest representable integer (i.e. a negative integer with a large absolute value).

◆ PropertyHandler() [1/2]

Constructs a property handler for the specified target item and property, with a given schema definition.

◆ PropertyHandler() [2/2]

PropertyHandler::PropertyHandler ( Item * target,
const PropertyDef * property,
const SchemaDef * schema,
NameManager * nameMgr )

Constructs a property handler for the specified target item and property, with a given schema definition.

◆ setValue()

void IntPropertyHandler::setValue ( int value)

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

◆ value()

int IntPropertyHandler::value ( ) const

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


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