Gyoto
|
Object with properties. More...
#include <GyotoObject.h>
Public Member Functions | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
Object (std::string const &kind) | |
Constructor setting kind. | |
Object () | |
Default constructor. | |
Object (Object const &orig) | |
Deep copy constructor. | |
virtual | ~Object () |
Virtual destructor. | |
void | set (Property const &p, Value val) |
Set Value of a Property. | |
void | set (Property const &p, Value val, std::string const &unit) |
Set Value (expressed in unit) of a Property. | |
void | set (std::string const &pname, Value val) |
Set Value of a Property. | |
void | set (std::string const &pname, Value val, std::string const &unit) |
Set Value (expressed in unit) of a Property. | |
Value | get (Property const &p) const |
Get Value of a Property. | |
Value | get (std::string const &pname) const |
Get Value of a Property. | |
Value | get (Property const &p, std::string const &unit) const |
Get Value of a Property, converted to unit. | |
Value | get (std::string const &pname, std::string const &unit) const |
Get Value of a Property, converted to unit. | |
Property const * | property (std::string const pname) const |
Find property by name. More... | |
virtual void | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual void | setParameters (Gyoto::FactoryMessenger *fmp) |
Main loop for parsing Properties from XML description. More... | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
virtual void | setParameter (Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) |
Set parameter by Property (and name) More... | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Property list. More... | |
Protected Attributes | |
std::string | kind_ |
The "kind" that is output in the XML entity. More... | |
Object with properties.
The Object API allows declaring a list of Properties that can be set and retrieved using a common, text-based interface. This interface simplifies a lot how to read and write XML, as well as writing bindings for interpreted langages (e.g. the Yorick interface).
In fact, any class member that has an interface implemented as a Property can be readily read and written from/to XML as well as from the Yorick plug-in, without the need for any additional code.
To declare a Property list:
It is possible to get a Property by name (Assume A is a class deriving from Object):
It then becomes possible to set or get the Property from or to a Value:
Of course the type of the Value instance and of the Property instance must match. Refer to the documentation of these to classes for details.
|
virtual |
Fill the XML element for this Object.
The base implementation simply calls fillProperty() for each Property defined for the Object.
Derived classes should avoid overriding fillElement(). It may make sense occasionally, e.g. to make sure that the metric is output first.
To customize how a given Property is rendered, it is better to override fillProperty().
If this method is overridden, the implementation should in general call fillElement() on the direct base.
|
virtual |
Output a single Property to XML.
The base implementation decides what to do based on the p.type. The format matches how setParameters() an setParameter() would interpret the XML descition.
Overriding this method should be avoided, but makes sense in some cases (for instance Screen::fillProperty() selects a different unit for Distance based on its magnitude, so that stellar sizes are expressed in solar radii while smaller sizes can be expressed in meters and larger sizes in parsecs).
Overriding implementation should fall-back on calling the implementation in the direct parent class:
Reimplemented in Gyoto::Screen, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, and Gyoto::Astrobj::DirectionalDisk.
|
virtual |
Get list of properties.
This method is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_END macro.
Reimplemented in Gyoto::Scenery, Gyoto::Screen, Gyoto::Spectrometer::Generic, Gyoto::Astrobj::Generic, Gyoto::Metric::Generic, Gyoto::Spectrum::Generic, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Star, Gyoto::Astrobj::Standard, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Photon, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::StarTrace, Gyoto::Metric::NumericalMetricLorene, Gyoto::Astrobj::DirectionalDisk, Gyoto::Spectrometer::Uniform, Gyoto::Metric::KerrKS, Gyoto::Metric::KerrBL, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::Torus, Gyoto::Astrobj::ThinDiskPL, Gyoto::Spectrum::BlackBody, Gyoto::Metric::RotStar3_1, Gyoto::Astrobj::FixedStar, Gyoto::Spectrum::ThermalBremsstrahlung, Gyoto::Metric::Minkowski, Gyoto::Spectrum::PowerLaw, and Gyoto::Astrobj::ThinDiskIronLine.
Property const* Gyoto::Object::property | ( | std::string const | pname | ) | const |
|
virtual |
Set parameter by name.
This function is used when parsing an XML description, if no Property of this name is found. Overriding implementation should fall-back on calling the direct's parent implementation:
name | XML name of the parameter (XML entity) |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Metric::RotStar3_1.
|
virtual |
Set parameter by Property (and name)
This function is used when parsing an XML description, if Property (p) of this name is found (i.e. either p.name or p.name_false is equal to name). Implementation should fall-back on calling the direct's parent implementation:
p | Property that matches name (p.name == name or p.name_false == name) |
name | XML name of the parameter (XML entity) |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::PolishDoughnut.
|
virtual |
Main loop for parsing Properties from XML description.
This function queries the FactoryMessenger for elements to parse, and tries to matche each element to a Property to set it accordingly.
Any class that tries to be buildable from XML must supply a subcontractor (for base classes such as Metric, Astrobj, Spectrum and Spectrometer, it is done as a template that must be specialized for each class).
This subcontractor typically looks somewhat like this:
Although this is discouraged, it is possible to override the following functions to customize how XML entities are parsed: - setParameters() if low-level access to the FactoryMessenger is required; - setParameter(std::string name, std::string content, std::string unit) to interpret an entity that does not match a Property (e.g. alternative name); - setParameter(Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) to change how a Property is interpreted.
|
protected |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
static |
Property list.
This static member is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_START, GYOTO_PROPERTY_END and GYOTO_PROPERTY_* macros.
The list of properties is implemented as a static array of Property instances. The last item in a Property of type Property::empty_t, which evaluates to false, so the list can be considered to be NULL-terminated (it is actually rather false-terminated). This empty_t last item can be a link to another Property list: for instance, the last item in Gyoto::Astrobj::Standard::properties is a link to Gyoto::Astrobj::Generic::properties.