Py::Store Class Reference

#include <PyStore.h>

Collaboration diagram for Py::Store:

Public Member Functions
	Store ()
	Constructor with parameters: More...
	Store (const std::size_t bufSize)
	Constructor with parameters: size of buffers. More...
	~Store ()
	Destructor: More...
const PyObject *	pydict () const
	retrieve the underlying python dictionary More...
std::size_t	bufferSize () const
	retrieve the current buffer size More...
std::string	repr ()
	python representation More...
void	setBufferSize (std::size_t bufferSize)
	reset the buffer size. More...
template<typename T >
void	book (const std::string &key, const std::string &dataName)
	retrieve the underlying python dictionary More...
template<typename T >
void	fill (const std::string &key, const std::string &dataName, const T &data)
	fill some already registered node with data More...
void	clear_store ()
	clear buckets (but keeps registered/booked keys around) More...
std::size_t	m_bufSize
	the buffer size of all buckets (ie: the pre-reserved length of all PyArrays) More...
PyObject *	m_store
	data store: a python dictionary More...
void	py_book (const std::string &key, const std::string &dataName, char dataType='d')
	python API More...
void	py_fill (const std::string &key, const std::string &dataName, PyObject *data)
void	book_impl (const std::string &key, const std::string &dataName, char dataType='d')
	register a variable with the store More...
void	fill_impl (const std::string &key, const std::string &dataName, PyObject *data)
	fill some already registered node with data More...

Detailed Description

Definition at line 36 of file PyStore.h.

Constructor & Destructor Documentation

Store() [1/2]

Py::Store::Store

(

)

Constructor with parameters:

Definition at line 46 of file PyStore.cxx.

             :
  m_bufSize( defaultBufferSize ),
  m_store  ( PyDict_New() )
{}

Store() [2/2]

Py::Store::Store

(

const std::size_t

bufSize

)

Constructor with parameters: size of buffers.

Definition at line 51 of file PyStore.cxx.

                                      :
  m_bufSize( bufSize      ),
  m_store  ( PyDict_New() )
{}

~Store()

Py::Store::~Store

(

)

Destructor:

Definition at line 58 of file PyStore.cxx.

{
  Py_DECREF( m_store );
}

Member Function Documentation

book()

template<typename T >

void Py::Store::book ( const std::string &  key, const std::string &  dataName  )

inline

retrieve the underlying python dictionary

register a variable with the store

Definition at line 79 of file PyStore.h.

  {
    //PyObject* buf = Py::cnv<T>::toPy( T() );
    //PyObject* buf = PyList_New(0);
    //PyObject* buf = Py::cnv<T>::to( T() );
    this->book_impl( key, dataName, 'd' );
    //Py_XDECREF(buf);
  }

book_impl()

void Py::Store::book_impl ( const std::string &  key, const std::string &  dataName, char  dataType = 'd'  )

private

register a variable with the store

Definition at line 123 of file PyStore.cxx.

{
  PyObject* buf = PyList_New( m_bufSize );
  if ( !buf ) {
    // error handling
    std::cerr << "Store::book : Could not allocate a buffer for ["
          << key << s_uri << dataName << "] !!\n";
    Py_XDECREF(buf);
    return;
  }
 
  // resize to 0: >>> del buf[:]
  if ( PyList_SetSlice( buf, 0, m_bufSize, (PyObject*)NULL ) != 0 ) {
    // error handling
    std::cerr << "Store::book : Could not reset allocated buffer ["
          << key << s_uri << dataName << "] !!\n"
          << " buf: " << Py::repr( buf ) << "\n";
    
    Py_DECREF(buf);
    return;
  }
 
  if ( PyDict_SetItemString( m_store, 
                 const_cast<char*>((key+s_uri+dataName).c_str()),
                 buf ) != 0 ) {
    // error handling
    std::cerr << "Store::book : Could not create buffer at ["
          << key << s_uri << dataName << "]\n"
          << " buf: " << Py::repr( buf ) << "\n";
    Py_DECREF(buf);
    return;
  }
}

bufferSize()

std::size_t Py::Store::bufferSize ( ) const

inline

retrieve the current buffer size

Definition at line 61 of file PyStore.h.

{ return m_bufSize; }

clear_store()

void Py::Store::clear_store

(

)

clear buckets (but keeps registered/booked keys around)

Definition at line 89 of file PyStore.cxx.

{
  PyObject *buffers = PyDict_Values( m_store );
  if ( !buffers ) {
    // error handling
    Py_XDECREF( buffers );
    return;
  }
  
  for ( int i = 0, iMax = PyList_GET_SIZE( buffers ); i < iMax; ++i ) {
    PyObject* buf = PyList_GET_ITEM( buffers, i );
    Py_INCREF( buf );
   
    const int len = PyList_GET_SIZE( buf );
 
    // delete the whole slice
    if ( PyList_SetSlice( buf, 0, len, (PyObject *) NULL ) != 0 ) {
      // error handling
 
      Py_DECREF( buf );
      continue;
    }
 
    Py_DECREF( buf );
  }
 
  Py_DECREF( buffers );
  return;
}

fill()

template<typename T >

void Py::Store::fill ( const std::string &  key, const std::string &  dataName, const T &  data  )

inline

fill some already registered node with data

Definition at line 91 of file PyStore.h.

  {
//     std::cerr << "PyStore::fill( " << key << ", " << dataName
//        << ", " << typeid(data).name() << " => "
//        << ClassName<T>::name() << "\n";
    PyObject* pyData = Py::cnv<T>::toPy( data );
    this->fill_impl( key, dataName, pyData );
    // fill_impl steals pyData reference...
    return;
  }

fill_impl()

void Py::Store::fill_impl ( const std::string &  key, const std::string &  dataName, PyObject *  data  )

private

fill some already registered node with data

Definition at line 159 of file PyStore.cxx.

{
  PyObject* buf = 
    PyDict_GetItemString( m_store,
              const_cast<char*>((key+s_uri+dataName).c_str()) );
  Py_XINCREF( buf );
  if ( ! buf ) {
    std::cerr << "Store::fill : Could not retrieve key ["
          << key << s_uri << dataName << "] from store !!\n";
 
    // error handling
    PyErr_Clear();
    Py_DECREF ( data );
    Py_XDECREF( buf );
    return;
  }
 
  if ( !PyList_Check( buf ) ) {
    std::cerr << "Store::fill : buffer at ["
          << key << s_uri << dataName << "] is NOT a python array !!\n"
          << " buf: " << Py::repr( buf ) << "\n";
 
    // error handling
    PyErr_Clear();
    Py_DECREF( data );
    Py_DECREF( buf );
    return;
  }
 
  if ( 0 != PyList_Append( buf, data ) ) {
 
    std::cerr << "Store::fill : could not fill buffer at ["
          << key << s_uri << dataName << "] !!\n"
          << " buf:  " << Py::repr( buf )  << "\n"
          << " data: " << Py::repr( data ) << "\n";
 
    // error handling
    PyErr_Clear();
    Py_DECREF( data );
    Py_DECREF( buf );
    return;
  }
 
  Py_DECREF( data );
  Py_DECREF( buf );
  return;
}

py_book()

void Py::Store::py_book ( const std::string &  key, const std::string &  dataName, char  dataType = 'd'  )

inline

python API

Definition at line 108 of file PyStore.h.

  { return this->book_impl( key, dataName, dataType ); }

py_fill()

void Py::Store::py_fill ( const std::string &  key, const std::string &  dataName, PyObject *  data  )

inline

Definition at line 113 of file PyStore.h.

  { return this->fill_impl( key, dataName, data ); }

pydict()

const PyObject* Py::Store::pydict ( ) const

inline

retrieve the underlying python dictionary

Definition at line 58 of file PyStore.h.

{ Py_INCREF(m_store); return m_store; }

repr()

std::string Py::Store::repr

(

)

python representation

Definition at line 67 of file PyStore.cxx.

{
  return Py::repr( m_store );
}

setBufferSize()

void Py::Store::setBufferSize

(

std::size_t

bufferSize

)

reset the buffer size.

A no-op if new buffer size is same as old or smaller than old

Definition at line 76 of file PyStore.cxx.

{
  if ( bufferSize <= m_bufSize ) {
    m_bufSize = bufferSize;
    return;
  }
 
  m_bufSize = bufferSize;
  // loop over buffers and extend their size
 
  return;
}

Member Data Documentation

m_bufSize

std::size_t Py::Store::m_bufSize

private

the buffer size of all buckets (ie: the pre-reserved length of all PyArrays)

Definition at line 141 of file PyStore.h.

m_store

PyObject* Py::Store::m_store

private

data store: a python dictionary

Definition at line 144 of file PyStore.h.

---

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

• PyStore.h
• PyStore.cxx