casacore
PycValueHolder.h
Go to the documentation of this file.
1 //# PycValueHolder.h: Class to convert a ValueHolder to/from Python
2 //# Copyright (C) 2006
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //# $Id: PycValueHolder.h,v 1.2 2006/10/17 03:33:50 gvandiep Exp $
27 
28 
29 #ifndef PYRAP_PYCVALUEHOLDER_H
30 #define PYRAP_PYCVALUEHOLDER_H
31 
32 //# Includes
33 
34 // include first to avoid _POSIX_C_SOURCE redefined warnings
35 #include <boost/python.hpp>
36 #include <casacore/casa/Containers/ValueHolder.h>
37 #include <casacore/casa/Utilities/DataType.h>
38 
39 namespace casacore { namespace python {
40 
41 
42  // <summary>
43  // A class to convert a ValueHolder to/from Python objects.
44  // </summary>
45 
46  // <use visibility=export>
47  // <reviewed reviewer="" date="" tests="">
48  // </reviewed>
49 
50  // <synopsis>
51  // </synopsis>
52 
54  {
55  static boost::python::object makeobject (ValueHolder const&);
56  static PyObject* convert (ValueHolder const& c)
57  {
58  return boost::python::incref(makeobject(c).ptr());
59  }
60  };
61 
63  {
65  {
66  boost::python::converter::registry::push_back(
67  &convertible,
68  &construct,
69  boost::python::type_id<ValueHolder>());
70  }
71 
72  // Check if it is a type we can convert.
73  static void* convertible(PyObject* obj_ptr);
74 
75  // Constructs a ValueHolder from a Python object.
76  static void construct(
77  PyObject* obj_ptr,
78  boost::python::converter::rvalue_from_python_stage1_data* data);
79 
80  // Make a ValueHolder from all possible python data types.
81  static ValueHolder makeValueHolder (PyObject* obj_ptr);
82 
83  // Make a vector from a python sequence.
84  static ValueHolder toVector (PyObject* obj_ptr);
85  // Get (and check) the data type in a python sequence.
86  static DataType checkDataType (PyObject* obj_ptr);
87  };
88 
89 
90  // Register the ValueHolder conversion.
92  {
93  static void reg();
94  static bool _done;
95  };
98 
99 }}
100 
101 #endif
const Double c
Fundamental physical constants (SI units):
void register_convert_casa_valueholder()
this file contains all the compiler specific defines
Definition: mainpage.dox:28
static ValueHolder toVector(PyObject *obj_ptr)
Make a vector from a python sequence.
static void * convertible(PyObject *obj_ptr)
Check if it is a type we can convert.
static ValueHolder makeValueHolder(PyObject *obj_ptr)
Make a ValueHolder from all possible python data types.
static DataType checkDataType(PyObject *obj_ptr)
Get (and check) the data type in a python sequence.
static void construct(PyObject *obj_ptr, boost::python::converter::rvalue_from_python_stage1_data *data)
Constructs a ValueHolder from a Python object.
static PyObject * convert(ValueHolder const &c)
static boost::python::object makeobject(ValueHolder const &)
Register the ValueHolder conversion.