Gyoto::Object Class Reference

Object with properties. More...

#include <GyotoObject.h>

Inheritance diagram for Gyoto::Object:
Gyoto::Astrobj::Generic Gyoto::Metric::Generic Gyoto::Photon Gyoto::Scenery Gyoto::Screen Gyoto::Spectrometer::Generic Gyoto::Spectrum::Generic Gyoto::Astrobj::Complex Gyoto::Astrobj::Disk3D Gyoto::Astrobj::Standard Gyoto::Astrobj::ThinDisk Gyoto::Metric::KerrBL Gyoto::Metric::KerrKS Gyoto::Metric::Minkowski Gyoto::Metric::NumericalMetricLorene Gyoto::Metric::Python Gyoto::Metric::RezzollaZhidenko Gyoto::Metric::RotStar3_1 Gyoto::Photon::Refined Gyoto::Spectrometer::Complex Gyoto::Spectrometer::Uniform Gyoto::Spectrum::BlackBody Gyoto::Spectrum::PowerLaw Gyoto::Spectrum::Python Gyoto::Spectrum::ThermalBremsstrahlung

List of all members.

Public Member Functions

virtual bool isThreadSafe () const
 Whether this class is thread-safe.
virtual Property const * getProperties () const
 Get list of properties.
 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.
virtual void fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
 Output a single Property to XML.
virtual void fillElement (Gyoto::FactoryMessenger *fmp) const
 Fill the XML element for this Object.
virtual void setParameters (Gyoto::FactoryMessenger *fmp)
 Main loop for parsing Properties from XML description.
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name.
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).
std::string describeProperty (Gyoto::Property const &p) const
 Format desrciption for a property.
void help () const
 Print (to stdout) some help on this class.

Static Public Attributes

static GYOTO_OBJECT Property const properties []
 Property list.

Protected Attributes

std::string kind_
 The "kind" that is output in the XML entity.
std::vector< std::string > plugins_
 The plug-ins that needs to be loaded to access this instance's class.

Detailed Description

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: 1. declare (in the class declaration, .h file) and define (.C file) the pair or quadruplet of accessors for your Property (see Property class documentation; 2. call the GYOTO_OBJECT macro in in a public section of the class declaration (in the .h file):

      class A: public Object {
        public:
          GYOTO_OBJECT;
          A();
          virtual ~A();
        ...
      };

3. call the various GYOTO_PROPERTY_* macros in the corresponding .C file (see the documentation of the Property class).

It is possible to get a Property by name (Assume A is a class deriving from Object):

 A myobj();
 Property const *prop=NULL;
 prop = myobj.property("PropertyName");
 if (!prop) throwError("No Property by that name in this object");

It then becomes possible to set or get the Property from or to a Value:

 myobj.set(*prop, size_t(12));
 size_t val = myobj.get(*prop);

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.


Member Function Documentation

std::string Gyoto::Object::describeProperty ( Gyoto::Property const &  p  )  const

Format desrciption for a property.

Returns a string containing the name(s) and type of the property, as well as whether it supports unit.

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger fmp  )  const [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.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.

virtual void Gyoto::Object::fillProperty ( Gyoto::FactoryMessenger fmp,
Property const &  p 
) const [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:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const ;
 };
 void B::fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const {
   if (name=="Duff") fmp->doSomething();
   else A::fillProperty(fmp, p);
 }

Reimplemented in Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Scenery, Gyoto::Screen, Gyoto::Astrobj::Star, and Gyoto::Spectrometer::Uniform.

Property const * Gyoto::Object::getProperties (  )  const [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::Astrobj::Generic, Gyoto::Spectrum::BlackBody, Gyoto::Metric::ChernSimons, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::DynamicalDiskBolometric, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::InflateStar, Gyoto::Astrobj::Jet, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, Gyoto::Metric::Generic, Gyoto::Metric::Minkowski, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::NeutronStarAnalyticEmission, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Metric::NumericalMetricLorene, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Photon, Gyoto::Astrobj::PolishDoughnut, Gyoto::Spectrum::PowerLaw, Gyoto::Metric::RezzollaZhidenko, Gyoto::Metric::RotStar3_1, Gyoto::Scenery, Gyoto::Screen, Gyoto::Spectrometer::Generic, Gyoto::Spectrum::Generic, Gyoto::Astrobj::Standard, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Spectrum::ThermalBremsstrahlung, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::ThinDiskIronLine, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::Torus, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::UniformSphere, Gyoto::Spectrum::Python, Gyoto::Metric::Python, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

void Gyoto::Object::help (  )  const

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

virtual bool Gyoto::Object::isThreadSafe (  )  const [virtual]

Whether this class is thread-safe.

Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.

The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.

Objects that clone children in their copy constructor that are not declared as properties must take these children into account.

Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.

Property const* Gyoto::Object::property ( std::string const   pname  )  const

Find property by name.

Look into the Property list for a Property whose name (or name_false, for a boolean Property) is pname. Return a const pointer to the first such property found, or NULL if none is found.

virtual void Gyoto::Object::setParameter ( Gyoto::Property const &  p,
std::string const &  name,
std::string const &  content,
std::string const &  unit 
) [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:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void setParameter(Gyoto::Property const &p,
                            std::string name,
                                std::string content,
                                std::string unit);
 };
 void B::setParameter(Gyoto::Property const &p,
                          std::string name,
                          std::string content,
                          std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else A::setParameter(p, name, content, unit);
 }
Parameters:
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 int Gyoto::Object::setParameter ( std::string  name,
std::string  content,
std::string  unit 
) [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:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual int setParameter(std::string name,
                            std::string content,
                            std::string unit);
 };
 int B::setParameter(std::string name,
                            std::string content,
                            std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else return A::setParameter(name, content, unit);
   return 0;  // name was known
 }
Parameters:
name XML name of the parameter (XML entity). This may have a path component, e.g. "Astrobj::Radius", in which case a property named "Astrobj" will be sought in the current object, and setParameter will be called recusrively on this Astrobj with Radius as name.
content string representation of the value
unit string representation of the unit
Returns:
0 if this parameter is known, 1 if it is not.

Reimplemented in Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Metric::KerrKS, Gyoto::Metric::RotStar3_1, and Gyoto::Astrobj::Star.

virtual void Gyoto::Object::setParameters ( Gyoto::FactoryMessenger fmp  )  [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:

SmartPointer<Metric::Generic>
Gyoto::Metric::MyKind::Subcontractor(FactoryMessenger* fmp) {
  SmartPointer<MyKind> gg = new MyKind();
  gg -> setParameters(fmp);
  return gg;
}

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.

Reimplemented in Gyoto::Astrobj::Generic, Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::OscilTorus, Gyoto::Photon, Gyoto::Astrobj::Star, and Gyoto::Spectrometer::Uniform.


Member Data Documentation

std::string Gyoto::Object::kind_ [protected]

The "kind" that is output in the XML entity.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj kind="kind_" ...>...</Astrobj>

is written.

std::vector<std::string> Gyoto::Object::plugins_ [protected]

The plug-ins that needs to be loaded to access this instance's class.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj ... plugin="plugins_">...</Astrobj>

is written.

static Property const Gyoto::Object::properties[] [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.

Reimplemented in Gyoto::Astrobj::Generic, Gyoto::Spectrum::BlackBody, Gyoto::Metric::ChernSimons, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::DynamicalDiskBolometric, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::InflateStar, Gyoto::Astrobj::Jet, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, Gyoto::Metric::Generic, Gyoto::Metric::Minkowski, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::NeutronStarAnalyticEmission, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Metric::NumericalMetricLorene, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Photon, Gyoto::Astrobj::PolishDoughnut, Gyoto::Spectrum::PowerLaw, Gyoto::Metric::RezzollaZhidenko, Gyoto::Metric::RotStar3_1, Gyoto::Scenery, Gyoto::Screen, Gyoto::Spectrometer::Generic, Gyoto::Spectrum::Generic, Gyoto::Astrobj::Standard, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Spectrum::ThermalBremsstrahlung, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::ThinDiskIronLine, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::Torus, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::UniformSphere, Gyoto::Spectrum::Python, Gyoto::Metric::Python, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.


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

Generated on 22 Jul 2017 for Gyoto by  doxygen 1.6.1