The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
SelectDustMixFamily Class Reference

#include <SelectDustMixFamily.hpp>

Inheritance diagram for SelectDustMixFamily:
Inheritance graph
[legend]

Public Member Functions

const vector< DustMix * > & dustMixes () const
 
const MaterialMixmix (const Array &parameters) const override
 
vector< SnapshotParameterparameterInfo () const override
 
virtual const MaterialMixmix (const Array &parameters) const =0
 
virtual vector< SnapshotParameterparameterInfo () const =0
 
- Public Member Functions inherited from SimulationItem
template<class T >
T * find (bool setup=true) const
 
template<class T >
T * interface (int levels=-999999, bool setup=true) const
 
virtual string itemName () const
 
void setup ()
 
string typeAndName () const
 
- Public Member Functions inherited from Item
 Item (const Item &)=delete
 
virtual ~Item ()
 
void addChild (Item *child)
 
const vector< Item * > & children () const
 
virtual void clearItemListProperty (const PropertyDef *property)
 
void destroyChild (Item *child)
 
virtual bool getBoolProperty (const PropertyDef *property) const
 
virtual vector< double > getDoubleListProperty (const PropertyDef *property) const
 
virtual double getDoubleProperty (const PropertyDef *property) const
 
virtual string getEnumProperty (const PropertyDef *property) const
 
virtual int getIntProperty (const PropertyDef *property) const
 
virtual vector< Item * > getItemListProperty (const PropertyDef *property) const
 
virtual ItemgetItemProperty (const PropertyDef *property) const
 
virtual string getStringProperty (const PropertyDef *property) const
 
int getUtilityProperty (string name) const
 
virtual void insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
 
Itemoperator= (const Item &)=delete
 
Itemparent () const
 
virtual void removeFromItemListProperty (const PropertyDef *property, int index)
 
virtual void setBoolProperty (const PropertyDef *property, bool value)
 
virtual void setDoubleListProperty (const PropertyDef *property, vector< double > value)
 
virtual void setDoubleProperty (const PropertyDef *property, double value)
 
virtual void setEnumProperty (const PropertyDef *property, string value)
 
virtual void setIntProperty (const PropertyDef *property, int value)
 
virtual void setItemProperty (const PropertyDef *property, Item *item)
 
virtual void setStringProperty (const PropertyDef *property, string value)
 
void setUtilityProperty (string name, int value)
 
virtual string type () const
 

Protected Member Functions

 SelectDustMixFamily ()
 
- Protected Member Functions inherited from MaterialMixFamily
 MaterialMixFamily ()
 
- Protected Member Functions inherited from SimulationItem
 SimulationItem ()
 
virtual bool offersInterface (const std::type_info &interfaceTypeInfo) const
 
virtual void setupSelfAfter ()
 
virtual void setupSelfBefore ()
 
- Protected Member Functions inherited from Item
 Item ()
 

Private Types

using BaseType = MaterialMixFamily
 
using ItemType = SelectDustMixFamily
 

Private Attributes

vector< DustMix * > _dustMixes
 

Friends

class ItemRegistry
 

Detailed Description

An instance of the SelectDustMixFamily class represents a family of dust mixes that is specified as part of the configuration. Specifically, a property of this class holds a user-configurable list of dust mixes representing the family. The family requires a single parameter value to select a family member, corresponding to the zero-based index in the configured list of dust mixes. The floating point parameter value is rounded to the nearest integer and subsequently clipped to be in range.

Constructor & Destructor Documentation

◆ SelectDustMixFamily()

SelectDustMixFamily::SelectDustMixFamily ( )
inlineprotected

Default constructor for concrete Item subclass SelectDustMixFamily : "a family of dust mixes specified in the configuration" .

Member Function Documentation

◆ dustMixes()

SelectDustMixFamily::dustMixes ( ) const
inline

This function returns the value of the discoverable item list property dustMixes : "the family of dust mixes" .

The default value for this property is given by the conditional value expression "ConfigurableDustMix" .

◆ mix()

const MaterialMix * SelectDustMixFamily::mix ( const Array parameters) const
overridevirtual

This function returns (a pointer to) the dust mix corresponding to the zero-based index in the configured list of dust mixes specified as the single parameter in the list. The floating point parameter value is rounded to the nearest integer and subsequently clipped to be in range. If the number of parameters in the specified list is not equal to one, the behavior is undefined. The material mix family retains ownership of the returned dust mix, and guarantees that it will not be destroyed until the family itself is destroyed.

Implements MaterialMixFamily.

◆ parameterInfo()

vector< SnapshotParameter > SelectDustMixFamily::parameterInfo ( ) const
overridevirtual

This function returns SnapshotParameter information for a single parameter corresponding to the zero-based index in the configured list of dust mixes.

Implements MaterialMixFamily.


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