GyotoProperty.h File Reference

Introspectable properties. More...

#include "GyotoConfig.h"
#include <string>
#include <vector>

Go to the source code of this file.

Classes
class	Gyoto::SmartPointer< T >
	Pointers performing reference counting. More...
class	Gyoto::Property
	Property that can be set and got using standard methods. More...
union	Gyoto::Property::setter_t
	Union holding an accessor to set any type. More...
union	Gyoto::Property::getter_t
	Union holding an accessor to get any type. More...
union	Gyoto::Property::setter_unit_t
	Union holding an accessor to set double or vector<double> with unit. More...
union	Gyoto::Property::getter_unit_t
	Union holding an accessor to get double or vector<double> with unit. More...

Namespaces
	Gyoto
	Namespace for the Gyoto library.
	Gyoto::Metric
	Access to metrics.
	Gyoto::Astrobj
	Access to astronomical objects.
	Gyoto::Spectrum
	Spectrum of a simple object (e.g. a Gyoto::Astrobj::Star)
	Gyoto::Spectrometer
	Access to spectrometers.

Macros
#define	GYOTO_PROPERTY_ACCESSORS(class, type, member, method)
	Define a pair of accessors to scalar member (double, long, size_t) More...
#define	GYOTO_PROPERTY_ACCESSORS_GEOMETRICAL(class, member, method, metric)
	Define 4 accessors to double scalar member in geometrical units. More...
#define	GYOTO_PROPERTY_START(class)   Property const class::properties[] = {
	Start Property list. More...
#define	GYOTO_PROPERTY_BOOL(class, name, namef, fname)
	Define a new Property of type Bool. More...
#define	GYOTO_PROPERTY_DOUBLE(class, name, fname)
	Define a Property of type Double. More...
#define	GYOTO_PROPERTY_LONG(class, name, fname)
	Define a Property of type Long. More...
#define	GYOTO_PROPERTY_UNSIGNED_LONG(class, name, fname)
	Define a Property of type Long. More...
#define	GYOTO_PROPERTY_SIZE_T   GYOTO_PROPERTY_UNSIGNED_LONG
#define	GYOTO_PROPERTY_DOUBLE_UNIT(class, name, fname)
	Define a Property of type Double supporting unit. More...
#define	GYOTO_PROPERTY_FILENAME(class, name, fname)
	Define a Property of type Filename. More...
#define	GYOTO_PROPERTY_STRING(class, name, fname)
	Define a Property of type String. More...
#define	GYOTO_PROPERTY_VECTOR_DOUBLE(class, name, fname)
	Define a Property of type vector<double> More...
#define	GYOTO_PROPERTY_VECTOR_DOUBLE_UNIT(class, name, fname)
	Define a Property of type vector<double> with unit support. More...
#define	GYOTO_PROPERTY_VECTOR_UNSIGNED_LONG(class, name, fname)
	Define a Property of type vector<unsigned long> More...
#define	GYOTO_PROPERTY_METRIC(class, name, fname)
	Define a Property of type Gyoto::Metric::Generic. More...
#define	GYOTO_PROPERTY_SCREEN(class, name, fname)
	Define a Property of type Gyoto::Screen. More...
#define	GYOTO_PROPERTY_ASTROBJ(class, name, fname)
	Define a Property of type Gyoto::Astrobj::Generic. More...
#define	GYOTO_PROPERTY_SPECTRUM(class, name, fname)
	Define a Property of type Gyoto::Spectrum::Generic. More...
#define	GYOTO_PROPERTY_SPECTROMETER(class, name, fname)
	Define a Property of type Gyoto::Spectrometer::Generic. More...
#define	GYOTO_PROPERTY_END(class, next)
	Define class::properties and class::getProperties() More...

Detailed Description

Introspectable properties.

Macro Definition Documentation

#define GYOTO_PROPERTY_ACCESSORS	(		class,
			type,
			member,
			method
	)

Value:

void class::method(type v) {member=v;}                          \
  type class::method() const {return member;}

Define a pair of accessors to scalar member (double, long, size_t)

Accessors must also be declared in the class declaration, which can be done using #GYOTO_OBJECT_SCALAR_ACCESSORS.

#define GYOTO_PROPERTY_ACCESSORS_GEOMETRICAL	(		class,
			member,
			method,
			metric
	)

Value:

GYOTO_PROPERTY_ACCESSORS(class, double, member, method)         \
  void class::method(double v, std::string const &u) {                  \
    member=Units::ToGeometrical(v, u, metric);                          \
  }                                                                     \
  double class::method(std::string const &u) const {                    \
    return Units::FromGeometrical(member, u, metric);                   \
  }

Define 4 accessors to double scalar member in geometrical units.

Accessors must also be declared in the class declaration, which can be done using GYOTO_OBJECT_ACCESSORS_UNIT.

Parameters

class	class name
member	member holding the value in geometrical unit
method	name for accessors member or expression yielding metric (which defines the geometrical unit)

#define GYOTO_PROPERTY_ASTROBJ	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_astrobj_t)&class::fname,                       \
   (Gyoto::Property::get_astrobj_t)&class::fname),

Define a Property of type Gyoto::Astrobj::Generic.

#define GYOTO_PROPERTY_BOOL	(		class,
			name,
			namef,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   #namef,                                                              \
   (Gyoto::Property::set_bool_t)&class :: fname,                        \
   (Gyoto::Property::get_bool_t)&class :: fname),

Define a new Property of type Bool.

#define GYOTO_PROPERTY_DOUBLE	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                         \
  (#name,                                                       \
   (Gyoto::Property::set_double_t)&class::fname,                \
   (Gyoto::Property::get_double_t)&class::fname),

Define a Property of type Double.

#define GYOTO_PROPERTY_DOUBLE_UNIT	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                         \
  (#name,                                                       \
   (Gyoto::Property::set_double_t)&class::fname,                \
   (Gyoto::Property::get_double_t)&class::fname,                \
   (Gyoto::Property::set_double_unit_t)&class::fname,           \
   (Gyoto::Property::get_double_unit_t)&class::fname),

Define a Property of type Double supporting unit.

#define GYOTO_PROPERTY_END	(		class,
			next
	)

Value:

Property(next)};                                                        \
  Gyoto::Property const * class::getProperties() const {                \
    return class::properties;                                           \
  }

Define class::properties and class::getProperties()

#define GYOTO_PROPERTY_FILENAME	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                         \
  (#name,                                                       \
   (Gyoto::Property::set_string_t)&class::fname,                \
   (Gyoto::Property::get_string_t)&class::fname,                \
   true),

Define a Property of type Filename.

#define GYOTO_PROPERTY_LONG	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                 \
  (#name,                                               \
   (Gyoto::Property::set_long_t)&class::fname,          \
   (Gyoto::Property::get_long_t)&class::fname),

Define a Property of type Long.

#define GYOTO_PROPERTY_METRIC	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_metric_t)&class::fname,                        \
   (Gyoto::Property::get_metric_t)&class::fname),

Define a Property of type Gyoto::Metric::Generic.

#define GYOTO_PROPERTY_SCREEN	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_screen_t)&class::fname,                        \
   (Gyoto::Property::get_screen_t)&class::fname),

Define a Property of type Gyoto::Screen.

#define GYOTO_PROPERTY_SPECTROMETER	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_spectrometer_t)&class::fname,                  \
   (Gyoto::Property::get_spectrometer_t)&class::fname),

Define a Property of type Gyoto::Spectrometer::Generic.

#define GYOTO_PROPERTY_SPECTRUM	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
    (#name,                                                             \
     (Gyoto::Property::set_spectrum_t)&class::fname,                    \
     (Gyoto::Property::get_spectrum_t)&class::fname),

Define a Property of type Gyoto::Spectrum::Generic.

#define GYOTO_PROPERTY_START

(

class

)

Property const class::properties[] = {

Start Property list.

Parameters

class

Class for which we are defining a Property list

#define GYOTO_PROPERTY_STRING	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_string_t)&class::fname,                        \
   (Gyoto::Property::get_string_t)&class::fname,                        \
   false),

Define a Property of type String.

#define GYOTO_PROPERTY_UNSIGNED_LONG	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                         \
  (#name,                                                       \
   (Gyoto::Property::set_unsigned_long_t)&class::fname,         \
   (Gyoto::Property::get_unsigned_long_t)&class::fname),

Define a Property of type Long.

#define GYOTO_PROPERTY_VECTOR_DOUBLE	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_vector_double_t)&class::fname,                 \
   (Gyoto::Property::get_vector_double_t)&class::fname),

Define a Property of type vector<double>

#define GYOTO_PROPERTY_VECTOR_DOUBLE_UNIT	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_vector_double_t)&class::fname,                 \
   (Gyoto::Property::get_vector_double_t)&class::fname,                 \
   (Gyoto::Property::set_vector_double_unit_t)&class::fname,            \
   (Gyoto::Property::get_vector_double_unit_t)&class::fname),

Define a Property of type vector<double> with unit support.

#define GYOTO_PROPERTY_VECTOR_UNSIGNED_LONG	(		class,
			name,
			fname
	)

Value:

Gyoto::Property                                                 \
  (#name,                                                               \
   (Gyoto::Property::set_vector_unsigned_long_t)&class::fname,          \
   (Gyoto::Property::get_vector_unsigned_long_t)&class::fname),

Define a Property of type vector<unsigned long>