// Copyright information and license terms for this software can be // found in the file LICENSE that is included with the distribution #include "boost/python/class.hpp" #include "boost/python/module.hpp" #include "boost/python/def.hpp" #include "boost/python/self.hpp" #include "boost/python/other.hpp" #include "boost/python/enum.hpp" #include "boost/python/dict.hpp" #include "boost/python/operators.hpp" #include "boost/python/manage_new_object.hpp" #include "boost/python/overloads.hpp" #include "boost/python/exception_translator.hpp" #include "boost/python/object.hpp" #include "boost/python/docstring_options.hpp" #include "boost/shared_ptr.hpp" #include "boost/operators.hpp" #include "PvaException.h" #include "FieldNotFound.h" #include "InvalidArgument.h" #include "InvalidDataType.h" #include "InvalidRequest.h" #include "PvObject.h" #include "PvProvider.h" #include "PvScalar.h" #include "PvType.h" #include "PvBoolean.h" #include "PvByte.h" #include "PvUByte.h" #include "PvShort.h" #include "PvUShort.h" #include "PvInt.h" #include "PvUInt.h" #include "PvLong.h" #include "PvULong.h" #include "PvFloat.h" #include "PvDouble.h" #include "PvString.h" #include "PvScalarArray.h" #include "PvUnion.h" #include "PvTimeStamp.h" #include "NtType.h" #include "NtTable.h" #include "Channel.h" #include "RpcClient.h" #include "RpcServer.h" #include "RpcServiceImpl.h" #include "PvaException.h" #include "PvaExceptionTranslator.h" // Overload macros BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(ChannelGet, Channel::get, 0, 1) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(ChannelPut, Channel::put, 1, 2) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(ChannelStartMonitor, Channel::startMonitor, 0, 1) //BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(RpcClientRequest, RpcClient::request, 1, 2) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(RpcServerListen, RpcServer::listen, 0, 1) PyObject* pvaException = NULL; PyObject* fieldNotFoundException = NULL; PyObject* invalidArgumentException = NULL; PyObject* invalidDataTypeException = NULL; PyObject* invalidRequestException = NULL; BOOST_PYTHON_MODULE(pvaccess) { using namespace boost::python; scope().attr("__doc__") = "pvaccess module is a python wrapper for pvAccess and other `EPICS V4 `_ C++ libraries."; docstring_options local_docstring_options(true, true, false); // // Exceptions // register_exception_translator(PvaExceptionTranslator::translator) ; pvaException = PvaExceptionTranslator::createExceptionClass(PvaException::PyExceptionClassName); fieldNotFoundException = PvaExceptionTranslator::createExceptionClass(FieldNotFound::PyExceptionClassName, pvaException); invalidArgumentException = PvaExceptionTranslator::createExceptionClass(InvalidArgument::PyExceptionClassName, pvaException); invalidDataTypeException = PvaExceptionTranslator::createExceptionClass(InvalidDataType::PyExceptionClassName, pvaException); invalidRequestException = PvaExceptionTranslator::createExceptionClass(InvalidRequest::PyExceptionClassName, pvaException); // // PvType // enum_("PvType") .value("BOOLEAN", PvType::Boolean) .value("BYTE", PvType::Byte) .value("UBYTE", PvType::UByte) .value("SHORT", PvType::Short) .value("USHORT", PvType::UShort) .value("INT", PvType::Int) .value("UINT", PvType::UInt) .value("LONG", PvType::Long) .value("ULONG", PvType::ULong) .value("FLOAT", PvType::Float) .value("DOUBLE", PvType::Double) .value("STRING", PvType::String) .export_values() ; // // PvProvider // enum_("ProviderType") .value("PVA", PvProvider::PvaProviderType) .value("CA", PvProvider::CaProviderType) .export_values() ; // // PvObject // class_("PvObject", "PvObject represents a generic PV structure.\n\n" "**PvObject(structureDict)**\n\n" "\t:Parameter: *structureDict* (dict) - dictionary of key:value pairs describing the underlying PV structure in terms of field names and their types\n\n" "\tThe dictionary key is a string (PV field name), and value is one of:\n\n" "\t- PVTYPE: scalar type, can be BOOLEAN, BYTE, UBYTE, SHORT, USHORT, INT, UINT, LONG, ULONG, FLOAT, DOUBLE, or STRING\n" "\t- [PVTYPE]: single element list representing scalar array\n" "\t- {key:value,…}: structure\n" "\t- [{key:value,…}]: single element list representing structure array\n" "\t- (): variant union\n" "\t- [()]: single element list representing variant union array\n" "\t- ({key:value,…},): restricted union\n" "\t- [({key:value,…},)]: single element list representing restricted union array\n\n" "\t:Raises: *InvalidArgument* - in case structure dictionary cannot be parsed\n\n" "\t::\n\n" "\t\tpv1 = PvObject({'anInt' : INT})\n\n" "\t\tpv2 = PvObject({'aShort' : SHORT, 'anUInt' : UINT, 'aString' : STRING})\n\n" "\t\tpv3 = PvObject({'aStringArray' : [STRING], 'aStruct' : {'aString2' : STRING, 'aBoolArray' : [BOOLEAN], 'aStruct2' : {'aFloat' : FLOAT, 'aString3' : [STRING]}}})\n\n" "\t\tpv4 = PvObject({'aStructArray' : [{'anInt' : INT, 'anInt2' : INT, 'aDouble' : DOUBLE}]})\n\n" "\t\tpv5 = PvObject({'anUnion' : ({'anInt' : INT, 'aDouble' : DOUBLE},)})\n\n" "\t\tpv6 = PvObject({'aVariant' : ()})\n\n", init(args("structureDict"))) .def(str(self)) .def("set", static_cast(&PvObject::set), args("valueDict"), "Populates PV structure fields from python dictionary.\n\n" ":Parameter: *valueDict* (dict) - dictionary of key:value pairs that correspond to PV structure field names and their values\n\n" ":Raises: *FieldNotFound* - in case PV structure does not have one of the dictionary keys\n" ":Raises: *InvalidDataType* - in case PV structure field type does not match type of the corresponding dictionary value\n\n" "::\n\n" " pv = PvObject({'anUInt' : UINT, 'aString' : STRING})\n\n" " pv.set({'anUInt' : 1, 'aString' : 'my string example'})\n\n") .def("get", static_cast(&PvObject::get), "Retrieves PV structure as python dictionary.\n\n" ":Returns: python key:value dictionary representing current PV structure in terms of field names and their values\n\n" "::\n\n" " pv = PvObject({'anInt' : INT, 'aString' : STRING})\n\n" " pv.set({'anInt' : 1})\n\n" " valueDict = pv.get()\n\n") .def("setObject", static_cast(&PvObject::setObject), args("value"), "Sets value for a single-field structure, or for a structure that has field named 'value'.\n\n" ":Parameter: *value* (object) - value object\n\n" ":Raises: *InvalidRequest* - when single-field structure has no field or multiple-field structure has no 'value' field\n\n" "::\n\n" " pv = PvObject({'aString' : STRING})\n\n" " pv.setObject('string value')\n\n") .def("setObject", static_cast(&PvObject::setObject), args("fieldName", "value"), "Sets value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (object) - value object\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field does not match provided object type\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN, 'aString' : STRING})\n\n" " pv.setObject('aString', 'string value')\n\n") .def("getObject", static_cast(&PvObject::getObject), "Retrieves value object from a single-field structure, or from a structure that has field named 'value'.\n\n" ":Returns: value object\n\n" ":Raises: *InvalidRequest* - when single-field structure has no field or multiple-field structure has no 'value' field\n\n" "::\n\n" " pv = PvObject({'aString' : STRING})\n\n" " value = pv.getObject()\n\n") .def("getObject", static_cast(&PvObject::getObject), args("fieldName"), "Retrieves value object assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: value object\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN, 'aString' : STRING})\n\n" " value = pv.getObject('aString')\n\n") .def("setBoolean", static_cast(&PvObject::setBoolean), args("value"), "Sets boolean value for a single-field structure, or for a structure that has boolean field named 'value'.\n\n" ":Parameter: *value* (bool) - boolean value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no boolean field or multiple-field structure has no boolean 'value' field\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN})\n\n" " pv.setBoolean(True)\n\n") .def("setBoolean", static_cast(&PvObject::setBoolean), args("fieldName", "value"), "Sets boolean value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (bool) - boolean value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a boolean\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN, 'aString' : STRING})\n\n" " pv.setBoolean('aBoolean', True)\n\n") .def("getBoolean", static_cast(&PvObject::getBoolean), "Retrieves boolean value from a single-field structure, or from a structure that has boolean field named 'value'.\n\n" ":Returns: boolean value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no boolean field or multiple-field structure has no boolean 'value' field\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN})\n\n" " value = pv.getBoolean()\n\n") .def("getBoolean", static_cast(&PvObject::getBoolean), args("fieldName"), "Retrieves boolean value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: boolean value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a boolean\n\n" "::\n\n" " pv = PvObject({'aBoolean' : BOOLEAN, 'aString' : STRING})\n\n" " value = pv.getBoolean('aBoolean')\n\n") .def("setByte", static_cast(&PvObject::setByte), args("value"), "Sets byte (character) value for a single-field structure, or for a structure that has byte field named 'value'.\n\n" ":Parameter: *value* (str) - byte value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no byte field or multiple-field structure has no byte 'value' field\n\n" "::\n\n" " pv = PvObject({'aByte' : BYTE})\n\n" " pv.setByte('a')\n\n") .def("setByte", static_cast(&PvObject::setByte), args("fieldName", "value"), "Sets byte (character) value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (str) - byte value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a byte\n\n" "::\n\n" " pv = PvObject({'aByte' : BYTE, 'aString' : STRING})\n\n" " pv.setByte('aByte', 'a')\n\n") .def("getByte", static_cast(&PvObject::getByte), "Retrieves byte (character) value from a single-field structure, or from a structure that has byte field named 'value'.\n\n" ":Returns: byte value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no byte field or multiple-field structure has no byte 'value' field\n\n" "::\n\n" " pv = PvObject({'aByte' : BYTE})\n\n" " value = pv.getByte()\n\n") .def("getByte", static_cast(&PvObject::getByte), args("fieldName"), "Retrieves byte (character) value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: byte value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a byte\n\n" "::\n\n" " pv = PvObject({'aByte' : BYTE, 'aString' : STRING})\n\n" " value = pv.getByte('aByte')\n\n") .def("setUByte", static_cast(&PvObject::setUByte), args("value"), "Sets unsigned byte (character) value for a single-field structure, or for a structure that has unsigned byte field named 'value'.\n\n" ":Parameter: *value* (str) - unsigned byte value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned byte field or multiple-field structure has no unsigned byte 'value' field\n\n" "::\n\n" " pv = PvObject({'anUByte' : UBYTE})\n\n" " pv.setUByte('a')\n\n") .def("setUByte", static_cast(&PvObject::setUByte), args("fieldName", "value"), "Sets unsigned byte (character) value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (str) - unsigned byte value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned byte\n\n" "::\n\n" " pv = PvObject({'anUByte' : UBYTE, 'aString' : STRING})\n\n" " pv.setUByte('anUByte', 'a')\n\n") .def("getUByte", static_cast(&PvObject::getUByte), "Retrieves unsigned byte (character) value from a single-field structure, or from a structure that has unsigned byte field named 'value'.\n\n" ":Returns: unsigned byte value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned byte field or multiple-field structure has no unsigned byte 'value' field\n\n" "::\n\n" " pv = PvObject({'anUByte' : UBYTE})\n\n" " value = pv.getUByte()\n\n") .def("getUByte", static_cast(&PvObject::getUByte), args("fieldName"), "Retrieves unsigned byte (character) value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: unsigned byte value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned byte\n\n" "::\n\n" " pv = PvObject({'anUByte' : UBYTE, 'aString' : STRING})\n\n" " value = pv.getUByte('anUByte')\n\n") .def("setShort", static_cast(&PvObject::setShort), args("value"), "Sets short value for a single-field structure, or for a structure that has short field named 'value'.\n\n" ":Parameter: *value* (int) - short value'\n\n" ":Raises: *InvalidRequest* - when single-field structure has no short field or multiple-field structure has no short 'value' field\n\n" "::\n\n" " pv = PvObject({'aShort' : SHORT})\n\n" " pv.setShort(10)\n\n") .def("setShort", static_cast(&PvObject::setShort), args("fieldName", "value"), "Sets short value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (int) - short value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a short\n\n" "::\n\n" " pv = PvObject({'aShort' : SHORT, 'aString' : STRING})\n\n" " pv.setShort('aShort', 10)\n\n") .def("getShort", static_cast(&PvObject::getShort), "Retrieves short value from a single-field structure, or from a structure that has short field named 'value'.\n\n" ":Returns: short value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no short field or multiple-field structure has no short 'value' field\n\n" "::\n\n" " pv = PvObject({'aShort' : SHORT})\n\n" " value = pv.getShort()\n\n") .def("getShort", static_cast(&PvObject::getShort), args("fieldName"), "Retrieves short value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: short value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a short\n\n" "::\n\n" " pv = PvObject({'aShort' : SHORT, 'aString' : STRING})\n\n" " value = pv.getShort('aShort')\n\n") .def("setUShort", static_cast(&PvObject::setUShort), args("value"), "Sets unsigned short value for a single-field structure, or for a structure that has unsigned short field named 'value'.\n\n" ":Parameter: *value* (int) - unsigned short value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned short field or multiple-field structure has no unsigned short 'value' field\n\n" "::\n\n" " pv = PvObject({'anUShort' : USHORT})\n\n" " pv.setUShort(10)\n\n") .def("setUShort", static_cast(&PvObject::setUShort), args("fieldName", "value"), "Sets unsigned short value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (int) - unsigned short value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned short\n\n" "::\n\n" " pv = PvObject({'anUShort' : USHORT, 'aString' : STRING})\n\n" " pv.setUShort('anUShort', 10)\n\n") .def("getUShort", static_cast(&PvObject::getUShort), "Retrieves unsigned short value from a single-field structure, or from a structure that has unsigned short field named 'value'.\n\n" ":Returns: unsigned short value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned short field or multiple-field structure has no unsigned short 'value' field\n\n" "::\n\n" " pv = PvObject({'anUShort' : USHORT})\n\n" " value = pv.getUShort()\n\n") .def("getUShort", static_cast(&PvObject::getUShort), args("fieldName"), "Retrieves unsigned short value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: unsigned short value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned short\n\n" "::\n\n" " pv = PvObject({'anUShort' : USHORT, 'aString' : STRING})\n\n" " value = pv.getUShort('anUShort')\n\n") .def("setInt", static_cast(&PvObject::setInt), args("value"), "Sets int value for a single-field structure, or for a structure that has int field named 'value'.\n\n" ":Parameter: *value* (int) - integer value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no int field or multiple-field structure has no int 'value' field\n\n" "::\n\n" " pv = PvObject({'anInt' : INT})\n\n" " pv.setInt(10)\n\n") .def("setInt", static_cast(&PvObject::setInt), args("fieldName", "value"), "Sets int value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (int) - integer value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an int\n\n" "::\n\n" " pv = PvObject({'anInt' : INT, 'aString' : STRING})\n\n" " pv.setInt('anInt', 10)\n\n") .def("getInt", static_cast(&PvObject::getInt), "Retrieves int value from a single-field structure, or from a structure that has int field named 'value'.\n\n" ":Returns: int value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no int field or multiple-field structure has no int 'value' field\n\n" "::\n\n" " pv = PvObject({'anInt' : INT})\n\n" " value = pv.getInt()\n\n") .def("getInt", static_cast(&PvObject::getInt), args("fieldName"), "Retrieves int value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: int value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an int\n\n" "::\n\n" " pv = PvObject({'anInt' : INT, 'aString' : STRING})\n\n" " value = pv.getInt('anInt')\n\n") .def("setUInt", static_cast(&PvObject::setUInt), args("value"), "Sets unsigned int value for a single-field structure, or for a structure that has unsigned int field named 'value'.\n\n" ":Parameter: *value* (int) - unsigned integer value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned int field or multiple-field structure has no unsigned int 'value' field\n\n" "::\n\n" " pv = PvObject({'anUInt' : UINT})\n\n" " pv.setUInt(10)\n\n") .def("setUInt", static_cast(&PvObject::setUInt), args("fieldName", "value"), "Sets unsigned int value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (int) - unsigned integer value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned int\n\n" "::\n\n" " pv = PvObject({'anUInt' : UINT, 'aString' : STRING})\n\n" " pv.setUInt('anInt', 10)\n\n") .def("getUInt", static_cast(&PvObject::getUInt), args("fieldName"), "Retrieves unsigned int value from a single-field structure, or from a structure that has unsigned int field named 'value'.\n\n" ":Returns: unsigned integer value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned int field or multiple-field structure has no unsigned int 'value' field\n\n" "::\n\n" " pv = PvObject({'anUInt' : UINT})\n\n" " value = pv.getUInt()\n\n") .def("getUInt", static_cast(&PvObject::getUInt), args("fieldName"), "Retrieves unsigned int value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: unsigned integer value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned int\n\n" "::\n\n" " pv = PvObject({'anUInt' : UINT, 'aString' : STRING})\n\n" " value = pv.getUInt('anUInt')\n\n") .def("setLong", static_cast(&PvObject::setLong), args("value"), "Sets long value for a single-field structure, or for a structure that has long field named 'value'.\n\n" ":Parameter: *value* (long) - long value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no long field or multiple-field structure has no long 'value' field\n\n" "::\n\n" " pv = PvObject({'aLong' : LONG})\n\n" " pv.setLong(10L)\n\n") .def("setLong", static_cast(&PvObject::setLong), args("fieldName", "value"), "Sets long value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (long) - long value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a long\n\n" "::\n\n" " pv = PvObject({'aLong' : LONG, 'aString' : STRING})\n\n" " pv.setLong('aLong', 10L)\n\n") .def("getLong", static_cast(&PvObject::getLong), "Retrieves long value from a single-field structure, or from a structure that has long field named 'value'.\n\n" ":Returns: long value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no long field or multiple-field structure has no long 'value' field\n\n" "::\n\n" " pv = PvObject({'aLong' : LONG})\n\n" " value = pv.getLong()\n\n") .def("getLong", static_cast(&PvObject::getLong), args("fieldName"), "Retrieves short value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: long value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a long\n\n" "::\n\n" " pv = PvObject({'aLong' : LONG, 'aString' : STRING})\n\n" " value = pv.getLong('aLong')\n\n") .def("setULong", static_cast(&PvObject::setULong), args("value"), "Sets unsigned long value for a single-field structure, or for a structure that has unsigned long field named 'value'.\n\n" ":Parameter: *value* (long) - unsigned long value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned long field or multiple-field structure has no unsigned long 'value' field\n\n" "::\n\n" " pv = PvObject({'anULong' : ULONG})\n\n" " pv.setULong(10L)\n\n") .def("setULong", static_cast(&PvObject::setULong), args("fieldName", "value"), "Sets unsigned long value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (long) - unsigned long value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned long\n\n" "::\n\n" " pv = PvObject({'anULong' : ULONG, 'aString' : STRING})\n\n" " pv.setULong('anULong', 10L)\n\n") .def("getULong", static_cast(&PvObject::getULong), "Retrieves unsigned long value from a single-field structure, or from a structure that has unsigned long field named 'value'.\n\n" ":Returns: unsigned long value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no unsigned long field or multiple-field structure has no unsigned long 'value' field\n\n" "::\n\n" " pv = PvObject({'anULong' : ULONG})\n\n" " value = pv.getULong()\n\n") .def("getULong", static_cast(&PvObject::getULong), args("fieldName"), "Retrieves unsigned long value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: unsigned long value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an unsigned long\n\n" "::\n\n" " pv = PvObject({'anULong' : ULONG, 'aString' : STRING})\n\n" " value = pv.getULong('anULong')\n\n") .def("setFloat", static_cast(&PvObject::setFloat), args("value"), "Sets float value for a single-field structure, or for a structure that has float field named 'value'.\n\n" ":Parameter: *value* (float) - float value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no float field or multiple-field structure has no float 'value' field\n\n" "::\n\n" " pv = PvObject({'aFloat' : FLOAT})\n\n" " pv.setFloat(10.0)\n\n") .def("setFloat", static_cast(&PvObject::setFloat), args("fieldName", "value"), "Sets short value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (float) - float value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a short\n\n" "::\n\n" " pv = PvObject({'aFloat' : FLOAT, 'aString' : STRING})\n\n" " pv.setFloat('aFloat', 10.0)\n\n") .def("getFloat", static_cast(&PvObject::getFloat), "Retrieves float value from a single-field structure, or from a structure that has float field named 'value'.\n\n" ":Returns: float value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no float field or multiple-field structure has no float 'value' field\n\n" "::\n\n" " pv = PvObject({'aFloat' : FLOAT})\n\n" " value = pv.getFloat()\n\n") .def("getFloat", static_cast(&PvObject::getFloat), args("fieldName"), "Retrieves float value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: float value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a float\n\n" "::\n\n" " pv = PvObject({'aFloat' : FLOAT, 'aString' : STRING})\n\n" " value = pv.getFloat('aFloat')\n\n") .def("setDouble", static_cast(&PvObject::setDouble), args("value"), "Sets double value for a single-field structure, or for a structure that has double field named 'value'.\n\n" ":Parameter: *value* (float) - double value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no double field or multiple-field structure has no double 'value' field\n\n" "::\n\n" " pv = PvObject({'aDouble' : DOUBLE})\n\n" " pv.setDouble(10.0)\n\n") .def("setDouble", static_cast(&PvObject::setDouble), args("fieldName", "value"), "Sets short value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (float) - double value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a double\n\n" "::\n\n" " pv = PvObject({'aDouble' : DOUBLE, 'aString' : STRING})\n\n" " pv.setDouble('aDouble', 10.0)\n\n") .def("getDouble", static_cast(&PvObject::getDouble), "Retrieves double value from a single-field structure, or from a structure that has double field named 'value'.\n\n" ":Returns: double value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no double field or multiple-field structure has no double 'value' field\n\n" "::\n\n" " pv = PvObject({'aDouble' : DOUBLE})\n\n" " value = pv.getDouble()\n\n") .def("getDouble", static_cast(&PvObject::getDouble), args("fieldName"), "Retrieves double value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: double value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a double\n\n" "::\n\n" " pv = PvObject({'aDouble' : DOUBLE, 'aString' : STRING})\n\n" " value = pv.getDouble('aDouble')\n\n") .def("setString", static_cast(&PvObject::setString), args("value"), "Sets string value for a single-field structure, or for a structure that has string field named 'value'.\n\n" ":Parameter: *value* (str) - string value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no string field or multiple-field structure has no string 'value' field\n\n" "::\n\n" " pv = PvObject({'aString' : STRING})\n\n" " pv.setString('string value')\n\n") .def("setString", static_cast(&PvObject::setString), args("fieldName", "value"), "Sets string value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *value* (str) - string value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a string\n\n" "::\n\n" " pv = PvObject({'aString' : STRING, 'anInt' : INT})\n\n" " pv.setString('aString', 'string value')\n\n") .def("getString", static_cast(&PvObject::getString), "Retrieves string value from a single-field structure, or from a structure that has string field named 'value'.\n\n" ":Returns: string value\n\n" ":Raises: *InvalidRequest* - when single-field structure has no string field or multiple-field structure has no string 'value' field\n\n" "::\n\n" " pv = PvObject({'aString' : STRING})\n\n" " value = pv.getString()\n\n") .def("getString", static_cast(&PvObject::getString), args("fieldName"), "Retrieves string value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: string value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a string\n\n" "::\n\n" " pv = PvObject({'aString' : STRING, 'anInt' : INT})\n\n" " value = pv.getString('aString')\n\n") .def("setScalarArray", static_cast(&PvObject::setScalarArray), args("valueList"), "Sets scalar array value for a single-field structure, or for a structure that has scalar array field named 'value'.\n\n" ":Parameter: *valueList* (list) - list of scalar values\n\n" ":Raises: *InvalidRequest* - when single-field structure has no scalar array field or multiple-field structure has no scalar array 'value' field\n\n" "::\n\n" " pv = PvObject({'aScalarArray' : [INT]})\n\n" " pv.setScalarArray([0,1,2,3,4])\n\n") .def("setScalarArray", static_cast(&PvObject::setScalarArray), args("fieldName", "valueList"), "Sets scalar array value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *valueList* (list) - list of scalar values\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a scalar array\n\n" "::\n\n" " pv = PvObject({'aScalarArray' : [INT], 'aString' : STRING})\n\n" " pv.setScalarArray('aScalarArray', [0,1,2,3,4])\n\n") .def("getScalarArray", static_cast(&PvObject::getScalarArray), "Retrieves scalar array value from a single-field structure, or from a structure that has scalar array field named 'value'.\n\n" ":Returns: list of scalar values\n\n" ":Raises: *InvalidRequest* - when single-field structure has no scalar array field or multiple-field structure has no scalar array 'value' field\n\n" "::\n\n" " pv = PvObject({'aScalarArray' : [INT]})\n\n" " valueList = pv.getScalarArray()\n\n") .def("getScalarArray", static_cast(&PvObject::getScalarArray), args("fieldName"), "Retrieves scalar array value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: list of scalar values\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a scalar array\n\n" "Retrieves scalar array assigned to the given PV field.\n\n" "::\n\n" " pv = PvObject({'aScalarArray' : [INT]})\n\n" " valueList = pv.getScalarArray('aScalarArray', 'aString' : STRING)\n\n") .def("setStructure", static_cast(&PvObject::setStructure), args("valueDict"), "Sets structure value for a single-field structure, or for a structure that has structure field named 'value'.\n\n" ":Parameter: *valueDict* (dict) - dictionary of structure key:value pairs\n\n" ":Raises: *InvalidRequest* - when single-field structure has no structure field or multiple-field structure has no structure 'value' field\n\n" "::\n\n" " pv = PvObject({'aStruct' : {'anInt':INT, 'aDouble':DOUBLE}})\n\n" " pv.setStructure({'anInt' : 1, 'aDouble' : 1.1})\n\n") .def("setStructure", static_cast(&PvObject::setStructure), args("fieldName", "valueDict"), "Sets structure value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *valueDict* (dict) - dictionary of structure key:value pairs\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a structure\n\n" "::\n\n" " pv = PvObject({'aStruct' : {'anInt':INT, 'aDouble':DOUBLE}, 'aString' : STRING})\n\n" " pv.setStructure('aStruct', {'anInt' : 1, 'aDouble' : 1.1})\n\n") .def("getStructure", static_cast(&PvObject::getStructure), "Retrieves structure value from a single-field structure, or from a structure that has structure field named 'value'.\n\n" ":Returns: dictionary of structure key:value pairs\n\n" ":Raises: *InvalidRequest* - when single-field structure has no structure field or multiple-field structure has no structure 'value' field\n\n" "::\n\n" " pv = PvObject({'aStruct' : {'anInt':INT, 'aDouble':DOUBLE}})\n\n" " valueDict = pv.getStructure()\n\n") .def("getStructure", static_cast(&PvObject::getStructure), args("fieldName"), "Retrieves structure value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: dictionary of structure key:value pairs\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a structure\n\n" "::\n\n" " pv = PvObject({'aStruct' : {'anInt':INT, 'aDouble':DOUBLE}, 'aString' : STRING})\n\n" " valueDict = pv.getStructure('aStruct')\n\n") .def("setStructureArray", static_cast(&PvObject::setStructureArray), args("dictList"), "Sets structure array value for a single-field structure, or for a structure that has structure array field named 'value'.\n\n" ":Parameter: *dictList* (list) - list of dictionaries\n\n" ":Raises: *InvalidRequest* - when single-field structure has no structure array field or multiple-field structure has no structure array 'value' field\n\n" "::\n\n" " pv = PvObject({'aStructArray' : [{'anInt' : INT, 'aFloat' : FLOAT}]})\n\n" " pv.setStructureArray([{'anInt' : 1, 'aFloat' : 1.1},{'anInt' : 2, 'aFloat' : 2.2},{'anInt' : 3, 'aFloat' : 3.3}])\n\n") .def("setStructureArray", static_cast(&PvObject::setStructureArray), args("fieldName", "dictList"), "Sets structure array value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *dictList* (list) - list of dictionaries\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a structure array\n\n" "::\n\n" " pv = PvObject({'aStructArray' : [{'anInt' : INT, 'aFloat' : FLOAT}], 'aString' : STRING})\n\n" " pv.setStructureArray('aStructArray', [{'anInt' : 1, 'aFloat' : 1.1},{'anInt' : 2, 'aFloat' : 2.2},{'anInt' : 3, 'aFloat' : 3.3}])\n\n") .def("getStructureArray", static_cast(&PvObject::getStructureArray), "Retrieves structure array value from a single-field structure, or from a structure that has structure array field named 'value'.\n\n" ":Returns: list of dictionaries\n\n" ":Raises: *InvalidRequest* - when single-field structure has no structure array field or multiple-field structure has no structure array 'value' field\n\n" "::\n\n" " pv = PvObject({'aStructArray' : [{'anInt' : INT, 'aFloat' : FLOAT}]})\n\n" " dictList = pv.getStructureArray()\n\n") .def("getStructureArray", static_cast(&PvObject::getStructureArray), args("fieldName"), "Retrieves structure array value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: list of dictionaries\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not a structure array\n\n" "::\n\n" " pv = PvObject({'aStructArray' : [{'anInt' : INT, 'aFloat' : FLOAT}], 'aString' : STRING})\n\n" " dictList = pv.getStructureArray('aStructArray')\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("valueObject"), "Sets union value for a single-field structure, or for a structure that has union field named 'value'.\n\n" ":Parameter: *valueObject* (PvObject) - union value\n\n" ":Raises: *InvalidArgument* - when object's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " value = PvObject({'anInt' : INT})\n\n" " value.setInt(10)\n\n" " pv.setUnion(value)\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("fieldName", "valueObject"), "Sets union value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *valueObject* (PvObject) - union value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidArgument* - when object's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when specified field is not a union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " value = PvObject({'anInt' : INT})\n\n" " value.setInt(10)\n\n" " pv.setUnion('anUnion', value)\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("valueDict"), "Sets union value for a single-field structure, or for a structure that has union field named 'value'.\n\n" ":Parameter: *valueDict* (dict) - union value\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " pv.setUnion({'anInt' : 10})\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("fieldName", "valueDict"), "Sets union for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *valueDict* (dict) - union value\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " pv.setUnion('anUnion', {'anInt' : 10})\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("valueDict"), "Sets union value for a single-field structure, or for a structure that has union field named 'value'.\n\n" ":Parameter: *valueTuple* (tuple) - union value, must contain dictionary as its only element\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " pv.setUnion(({'anInt' : 10},))\n\n") .def("setUnion", static_cast(&PvObject::setUnion), args("fieldName", "valueTuple"), "Sets union for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *valueTuple* (tuple) - union value, must contain dictionary as its only element\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " pv.setUnion('anUnion', ({'anInt' : 10},)\n\n") .def("getUnion", static_cast(&PvObject::getUnion), "Retrieves union value from a single-field structure, or from a structure that has union field named 'value'.\n\n" ":Returns: union PV object\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " value = pv.getUnion()\n\n") .def("getUnion", static_cast(&PvObject::getUnion), args("fieldName"), "Retrieves union assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: union PV object\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " value = pv.getUnion('anUnion')\n\n") .def("getUnionFieldNames", static_cast(&PvObject::getUnionFieldNames), args("fieldName"), "Retrieves list of field names for a union.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: list of union field names\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " fieldNameList = pv.getUnionFieldNames('anUnion')\n\n") .def("getUnionFieldNames", static_cast(&PvObject::getUnionFieldNames), "Retrieves list of union field names from a single-field structure, or from a structure that has union field named 'value'.\n\n" ":Returns: list of union field names\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " fieldNameList = pv.getUnionFieldNames()\n\n") .def("getSelectedUnionFieldName", static_cast(&PvObject::getSelectedUnionFieldName), args("fieldName"), "Retrieves selected field name for an union.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: selected union field name\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " fieldName = pv.getSelectedUnionFieldName('anUnion')\n\n") .def("getSelectedUnionFieldName", static_cast(&PvObject::getSelectedUnionFieldName), "Retrieves selected field name for an union from a single-field structure, or from a structure that has union field named 'value'.\n\n" ":Returns: selected union field name\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " fieldName = pv.getSelectedUnionFieldNames()\n\n") .def("selectUnionField", static_cast(&PvObject::selectUnionField), args("fieldName", "unionFieldName"), "Selects field for an union assigned to a given field name.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *unionFieldName* (str) - union field name to be selected\n\n" ":Returns: PV object for the selected union field\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " selectedPv = pv.selectUnionField('anUnion', 'anInt')\n\n") .def("selectUnionField", static_cast(&PvObject::selectUnionField), args("unionFieldName"), "Selects field for an union from a single-field structure, or from a structure that has union field named 'value'.\n\n" ":Parameter: *unionFieldName* (str) - union field name to be selected\n\n" ":Returns: PV object for the selected union field\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " selectedPv = pv.selectUnionField('anInt')\n\n") .def("isUnionVariant", static_cast(&PvObject::isUnionVariant), args("fieldName"), "Checks if an union assigned to a given field name is variant.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: true if union is variant, false otherwise\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " isVariant = pv.isUnionVariant('anUnion')\n\n") .def("isUnionVariant", static_cast(&PvObject::isUnionVariant), "Checks if an union from a single-field structure, or from a structure that has union field named 'value', is variant.\n\n" ":Returns: true if union is variant, false otherwise\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " isVariant = pv.isUnionVariant()\n\n") .def("createUnionField", static_cast(&PvObject::createUnionField), args("fieldName", "unionFieldName"), "Creates union field object for an union assigned to a given field name.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *unionFieldName* (str) - union field name to be created\n\n" ":Returns: PV object for new union field\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},), 'aString' : STRING})\n\n" " createdPv = pv.createUnionField('anUnion', 'anInt')\n\n") .def("createUnionField", static_cast(&PvObject::createUnionField), args("unionFieldName"), "Creates union field object for an union from a single-field structure, or from a structure that has union field named 'value'.\n\n" ":Parameter: *unionFieldName* (str) - union field name to be created\n\n" ":Returns: PV object for new union field\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union field or multiple-field structure has no union 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnion' : ({'anInt' : INT, 'aFloat' : FLOAT},)})\n\n" " createdPv = pv.createUnionField('anInt')\n\n") .def("setUnionArray", static_cast(&PvObject::setUnionArray), args("objectList"), "Sets union array value for a single-field structure, or for a structure that has union array field named 'value'.\n\n" ":Parameter: *objectList* (list) - list of PV objects, dictionaries, or tuples representing unions\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union array field or multiple-field structure has no union array 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)]})\n\n" " pv.setUnionArray([{'anInt' : 10}, {'aFloat' : 11.1}])\n\n") .def("setUnionArray", static_cast(&PvObject::setUnionArray), args("fieldName", "objectList"), "Sets union array value for the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *objectList* (list) - list of PV objects, dictionaries, or tuples representing unions\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidArgument* - when dictionary's field name/type do not match any of the union's fields\n\n" ":Raises: *InvalidRequest* - when specified field is not an union array\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)], 'aString' : STRING})\n\n" " pv.setUnionArray('anUnionArray', [{'anInt' : 10}, {'aFloat' : 11.1}])\n\n") .def("getUnionArray", static_cast(&PvObject::getUnionArray), "Retrieves union array value from a single-field structure, or from a structure that has union array field named 'value'.\n\n" ":Returns: list of union PV objects\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union array field or multiple-field structure has no union array 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)]})\n\n" " unionPvList = pv.getUnionArray()\n\n") .def("getUnionArray", static_cast(&PvObject::getUnionArray), args("fieldName"), "Retrieves union array value assigned to the given PV field.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: list of union PV objects\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union array\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)], 'aString' : STRING})\n\n" " unionPvList = pv.getUnionArray('anUnionArray')\n\n") .def("getUnionArrayFieldNames", static_cast(&PvObject::getUnionArrayFieldNames), args("fieldName"), "Retrieves list of field names for an union array.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: list of union array field names\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union array\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)], 'aString' : STRING})\n\n" " fieldNameList = pv.getUnionArrayFieldNames('anUnionArray')\n\n") .def("getUnionArrayFieldNames", static_cast(&PvObject::getUnionArrayFieldNames), "Retrieves list of union array field names from a single-field structure, or from a structure that has union array field named 'value'.\n\n" ":Returns: list of union array field names\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union array field or multiple-field structure has no union array 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)]})\n\n" " fieldNameList = pv.getUnionArrayFieldNames()\n\n") .def("isUnionArrayVariant", static_cast(&PvObject::isUnionArrayVariant), args("fieldName"), "Checks if an union array assigned to a given field name is variant.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Returns: true if union array is variant, false otherwise\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union array\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)], 'aString' : STRING})\n\n" " isVariant = pv.isUnionArrayVariant('anUnionArray')\n\n") .def("isUnionArrayVariant", static_cast(&PvObject::isUnionArrayVariant), "Checks if an union array from a single-field structure, or from a structure that has union array field named 'value', is variant.\n\n" ":Returns: true if union array is variant, false otherwise\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union array field or multiple-field structure has no union array 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)]})\n\n" " isVariant = pv.isUnionArrayVariant()\n\n") .def("createUnionArrayElementField", static_cast(&PvObject::createUnionArrayElementField), args("fieldName", "unionFieldName"), "Creates union field object for an union array assigned to a given field name.\n\n" ":Parameter: *fieldName* (str) - field name\n\n" ":Parameter: *unionFieldName* (str) - union field name to be created\n\n" ":Returns: PV object for new union field\n\n" ":Raises: *FieldNotFound* - when PV structure does not have specified field\n\n" ":Raises: *InvalidRequest* - when specified field is not an union array\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)], 'aString' : STRING})\n\n" " unionPv = pv.createUnionArrayElementField('anUnionArray', 'anInt')\n\n") .def("createUnionArrayElementField", static_cast(&PvObject::createUnionArrayElementField), args("unionFieldName"), "Creates union field object for an union array from a single-field structure, or from a structure that has union array field named 'value'.\n\n" ":Parameter: *unionFieldName* (str) - union field name to be created\n\n" ":Returns: PV object for new union field\n\n" ":Raises: *InvalidRequest* - when single-field structure has no union array field or multiple-field structure has no union array 'value' field\n\n" "::\n\n" " pv = PvObject({'anUnionArray' : [({'anInt' : INT, 'aFloat' : FLOAT},)]})\n\n" " unionPv = pv.createUnionArrayElementField('anInt')\n\n") .def("toDict", &PvObject::toDict, "Converts PV structure to python dictionary.\n\n:Returns: python key:value dictionary representing current PV structure in terms of field names and their values\n\n::\n\n valueDict = pv.toDict()\n\n") .def("getStructureDict", &PvObject::getStructureDict, "Retrieves PV structure definition as python dictionary.\n\n:Returns: python key:value dictionary representing PV structure definition in terms of field names and their types\n\n::\n\n structureDict = pv.getStructureDict()\n\n") ; // // PV Scalar // class_ >("PvScalar", "PvScalar is a base class for all scalar PV types. It cannot be instantiated directly from python.\n\n", no_init) // use __int__ instead of .def(int_(self)) which requires operator::long() // use __float__ instead of .def(float_(self)) .def("__int__", &PvScalar::toInt) .def("__long__", &PvScalar::toLongLong) .def("__float__", &PvScalar::toDouble) .def("__str__", &PvScalar::toString) ; // // PV Boolean // class_ >("PvBoolean", "PvBoolean represents PV boolean type.\n\n**PvBoolean([value=False])**\n\n\t:Parameter: *value* (bool) - boolean value\n\n\t::\n\n\t\tpv = PvBoolean(True)\n\n", init<>()) .def(init()) .def("get", &PvBoolean::get, "Retrieves boolean PV value.\n\n:Returns: boolean value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvBoolean::set, args("value"), "Sets boolean PV value.\n\n:Parameter: *value* (bool) - boolean value\n\n::\n\n pv.set(False)\n\n") ; // // PV Byte // class_ >("PvByte", "PvByte represents PV byte type.\n\n**PvByte([value=''])**\n\n\t:Parameter: *value* (str) - byte value\n\n\t::\n\n\t\tpv = PvByte('a')\n\n", init<>()) .def(init()) .def("get", &PvByte::get, "Retrieves byte PV value.\n\n:Returns: byte value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvByte::set, args("value"), "Sets byte PV value.\n\n:Parameter: *value* (str) - byte value\n\n::\n\n pv.set('a')\n\n") ; // // PV UByte // class_ >("PvUByte", "PvUByte represents PV unsigned byte type.\n\n**PvUByte([value=0])**\n\n\t:Parameter: *value* (int) - unsigned byte value\n\n\t::\n\n\t\tpv = PvUByte(10)\n\n", init<>()) .def(init()) .def("get", &PvUByte::get, "Retrieves unsigned byte PV value.\n\n:Returns: unsigned byte value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvUByte::set, args("value"), "Sets unsigned byte PV value.\n\n:Parameter: *value* (int) - unsigned byte value\n\n::\n\n pv.set(10)\n\n") ; // // PV Short // class_ >("PvShort", "PvShort represents PV short type.\n\n**PvShort([value=0])**\n\n\t:Parameter: *value* (int) - short value\n\n\t::\n\n\t\tpv = PvShort(-10)\n\n", init<>()) .def(init()) .def("get", &PvShort::get, "Retrieves short PV value.\n\n:Returns: short value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvShort::set, args("value"), "Sets short PV value.\n\n:Parameter: *value* (int) - short value\n\n::\n\n pv.set(-10)\n\n") ; // // PV UShort // class_ >("PvUShort", "PvUShort represents PV unsigned short type.\n\n**PvUShort([value=0])**\n\n\t:Parameter: *value* (int) - unsigned short value\n\n\t::\n\n\t\tpv = PvUShort(10)\n\n", init<>()) .def(init()) .def("get", &PvUShort::get, "Retrieves unsigned short PV value.\n\n:Returns: unsigned short value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvUShort::set, args("value"), "Sets unsigned short PV value.\n\n:Parameter: *value* (int) - unsigned short value\n\n::\n\n pv.set(10)\n\n") ; // // PV Int // class_ >("PvInt", "PvInt represents PV integer type.\n\n**PvInt([value=0])**\n\n\t:Parameter: *value* (int) - integer value\n\n\t::\n\n\t\tpv = PvInt(-1000)\n\n", init<>()) .def(init()) .def("get", &PvInt::get, "Retrieves integer PV value.\n\n:Returns: integer value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvInt::set, args("value"), "Sets integer PV value.\n\n:Parameter: *value* (int) - integer value\n\n::\n\n pv.set(-1000)\n\n") ; // // PV UInt // class_ >("PvUInt", "PvUInt represents PV unsigned int type.\n\n**PvUInt([value=0])**\n\n\t:Parameter: *value* (int) - unsigned integer value\n\n\t::\n\n\t\tpv = PvUInt(1000)\n\n", init<>()) .def(init()) .def("get", &PvUInt::get, "Retrieves unsigned integer PV value.\n\n:Returns: unsigned integer value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvUInt::set, args("value"), "Sets unsigned integer PV value.\n\n:Parameter: *value* (int) - unsigned integer value\n\n::\n\n pv.set(1000)\n\n") ; // // PV Long // class_ >("PvLong", "PvLong represents PV long type.\n\n**PvLong([value=0])**\n\n\t:Parameter: *value* (long) - long value\n\n\t::\n\n\t\tpv = PvLong(-100000L)\n\n", init<>()) .def(init()) .def("get", &PvLong::get, "Retrieves long PV value.\n\n:Returns: long value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvLong::set, "Sets long PV value.\n\n:Parameter: *value* (long) - long value\n\n::\n\n pv.set(-100000L)\n\n") ; // // PV ULong // class_ >("PvULong", "PvULong represents PV unsigned long type.\n\n**PvULong([value=0])**\n\n\t:Parameter: *value* (long) - unsigned long value\n\n\t::\n\n\t\tpv = PvULong(100000L)\n\n", init<>()) .def(init()) .def("get", &PvULong::get, "Retrieves unsigned long PV value.\n\n:Returns: unsigned long value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvULong::set, args("value"), "Sets unsigned long PV value.\n\n:Parameter: *value* (long) - unsigned long value\n\n::\n\n pv.set(100000L)\n\n") ; // // PV Float // class_ >("PvFloat", "PvFloat represents PV float type.\n\n**PvFloat([value=0])**\n\n\t:Parameter: *value* (float) - float value\n\n\t::\n\n\t\tpv = PvFloat(1.1)\n\n", init<>()) .def(init()) .def("get", &PvFloat::get, "Retrieves float PV value.\n\n:Returns: float value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvFloat::set, args("value"), "Sets float PV value.\n\n:Parameter: *value* (float) - float value\n\n::\n\n pv.set(1.1)\n\n") ; // // PV Double // class_ >("PvDouble", "PvDouble represents PV double type.\n\n**PvDouble([value=0])**\n\n\t:Parameter: *value* (float) - double value\n\n\t::\n\n\t\tpv = PvDouble(1.1)\n\n", init<>()) .def(init()) .def("get", &PvDouble::get, "Retrieves double PV value.\n\n:Returns: double value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvDouble::set, args("value"), "Sets double PV value.\n\n:Parameter: *value* (float) - double value\n\n::\n\n pv.set(1.1)\n\n") ; // // PV String // class_ >("PvString", "PvString represents PV string type.\n\n**PvString([value=''])**\n\n\t:Parameter: *value* (str) - string value\n\n\t::\n\n\t\tpv = PvString('stringValue')\n\n", init<>()) .def(init()) .def("get", &PvString::get, "Retrieves string PV value.\n\n:Returns: string value\n\n::\n\n value = pv.get()\n\n") .def("set", &PvString::set, args("value"), "Sets string PV value.\n\n:Parameter: *value* (str) - string value\n\n::\n\n pv.set('stringValue')\n\n") ; // // PV Scalar Array // class_ >("PvScalarArray", "PvScalarArray represents PV scalar array.\n\n**PvScalarArray(scalarType)**\n\n\t:Parameter: *scalarType* (PVTYPE) - scalar type of array elements\n\n\t- PVTYPE: scalar type, can be BOOLEAN, BYTE, UBYTE, SHORT, USHORT, INT, UINT, LONG, ULONG, FLOAT, DOUBLE, or STRING\n\n\t::\n\n\t\tpv = PvScalarArray(INT)\n\n", init()) .def("get", &PvScalarArray::get, "Retrieves PV value list.\n\n:Returns: list of scalar values\n\n::\n\n valueList = pv.get()\n\n") .def("set", &PvScalarArray::set, args("valueList"), "Sets PV value list.\n\n:Parameter: *valueList* (list) - list of scalar values\n\n::\n\n pv.set([1,2,3,4,5])\n\n") .def("toList", &PvScalarArray::toList, "Converts PV to value list.\n\n:Returns: list of scalar values\n\n::\n\n valueList = pv.toList()\n\n") ; // // Union // class_ >("PvUnion", "PvUnion represents PV union type.\n\n" "\n", init<>()) .def(init(args("structureDict"))) .def(init(args("pvObject"))) .def(str(self)) ; // // PV TimeStamp // class_ >("PvTimeStamp", "PvTimeStamp represents PV time stamp structure.\n\n**PvTimeStamp()**\n\n\t::\n\n\t\ttimestamp1 = PvTimeStamp()\n\n**PvTimeStamp(secondsPastEpoch, nanoseconds [, userTag=-1])**\n\n\t:Parameter: *secondsPastEpoch* (long) - seconds past epoch\n\n\t:Parameter: *nanoseconds* (int) - nanoseconds\n\n\t:Parameter: *userTag* (int) - user tag\n\n\t::\n\n\t\ttimeStamp2 = PvTimeStamp(1234567890, 10000)\n\n\t\ttimeStamp3 = PvTimeStamp(1234567890, 10000, 1)\n\n", init<>()) .def(init()) .def(init()) .def("getSecondsPastEpoch", &PvTimeStamp::getSecondsPastEpoch, "Retrieves time stamp value for seconds past epoch.\n\n:Returns: seconds past epoch\n\n::\n\n secondsPastEpoch = timeStamp.getSecondsPastEpoch()\n\n") .def("setSecondsPastEpoch", &PvTimeStamp::setSecondsPastEpoch, args("secondsPastEpoch"), "Sets time stamp value for seconds past epoch.\n\n:Parameter: *secondsPastEpoch* (long) - seconds past epoch\n\n::\n\n timeStamp.setSecondsPastEpoch(1234567890)\n\n") .def("getNanoseconds", &PvTimeStamp::getNanoseconds, "Retrieves time stamp value for nanoseconds.\n\n:Returns: nanoseconds\n\n::\n\n nanoseconds = timeStamp.getNanoseconds()\n\n") .def("setNanoseconds", &PvTimeStamp::setNanoseconds, args("nanoseconds"), "Sets time stamp value for nanoseconds.\n\n:Parameter: *nanoseconds* (int) - nanoseconds\n\n::\n\n timeStamp.setNanoseconds(10000)\n\n") .def("getUserTag", &PvTimeStamp::getUserTag, "Retrieves user tag.\n\n:Returns: user tag\n\n::\n\n userTag = timeStamp.getUserTag()\n\n") .def("setUserTag", &PvTimeStamp::setUserTag, args("userTag"), "Sets user tag.\n\n:Parameter: *userTag* (int) - user tag\n\n::\n\n timeStamp.setUserTag(1)\n\n") ; // // PV Alarm // class_ >("PvAlarm", "PvAlarm represents PV alarm structure.\n\n**PvAlarm()**\n\n\t::\n\n\t\talarm1 = PvAlarm()\n\n**PvAlarm(severity, status, message)**\n\n\t:Parameter: *severity* (int) - alarm severity\n\n\t:Parameter: *status* (int) - status code\n\n\t:Parameter: *message* (str) - alarm message\n\n\t::\n\n\t\talarm2 = PvAlarm(5, 1, 'alarm message')\n\n", init<>()) .def(init()) .def("getSeverity", &PvAlarm::getSeverity, "Retrieves alarm severity.\n\n:Returns: alarm severity\n\n::\n\n severity = alarm.getSeverity()\n\n") .def("setSeverity", &PvAlarm::setSeverity, args("severity"), "Sets alarm severity.\n\n:Parameter: *severity* (int) - alarm severity\n\n::\n\n alarm.setSeverity(1)\n\n") .def("getStatus", &PvAlarm::getStatus, "Retrieves status code.\n\n:Returns: status code\n\n::\n\n status = alarm.getStatusCode()\n\n") .def("setStatus", &PvAlarm::setStatus, args("status"), "Sets status code.\n\n:Parameter: *status* (int) - status code\n\n::\n\n alarm.setStatus(1)\n\n") .def("getMessage", &PvAlarm::getMessage, "Retrieves alarm message.\n\n:Returns: alarm message\n\n::\n\n message = alarm.getMessage()\n\n") .def("setMessage", &PvAlarm::setMessage, args("message"), "Sets alarm message.\n\n:Parameter: *message* (str) - alarm message\n\n::\n\n alarm.setmessage('alarm message')\n\n") ; // // NT Type // class_ >("NtType", "NtType is a base class for all NT structures. It cannot be instantiated directly from python.\n\n", no_init) ; // // NT Table // class_ >("NtTable", "NtTable represents NT table structure.\n\n**NtTable(nColumns, scalarType)**\n\n\t:Parameter: *nColumns* (int) - number of table columns\n\n\t:Parameter: *scalarType* (PVTYPE) - scalar type (BOOLEAN, BYTE, UBYTE, SHORT, USHORT, INT, UINT, LONG, ULONG, FLOAT, DOUBLE, or STRING)\n\n\tThis example creates NT Table with 3 columns of DOUBLE values:\n\n\t::\n\n\t\ttable1 = NtTable(3, DOUBLE)\n\n\t**NtTable(scalarTypeList)**\n\n\t:Parameter: *scalarTypeList* ([PVTYPE]) - list of column scalar types (BOOLEAN, BYTE, UBYTE, SHORT, USHORT, INT, UINT, LONG, ULONG, FLOAT, DOUBLE, or STRING)\n\n\tThis example creates NT Table with STRING, INT and DOUBLE columns:\n\n\t::\n\n\t\ttable2 = NtTable([STRING, INT, DOUBLE])\n\n**NtTable(pvObject)**\n\n\t:Parameter: *pvObject* (PvObject) - PV object that has a structure containing required NT Table elements:\n\n\t- labels ([STRING]) - list of column labels\n\n\t- value (dict) - dictionary of column:[PVTYPE] pairs, where is an integer in range [0,N-1], with N being NT Table dimension\n\n\tThe following example creates NT Table with 3 DOUBLE columns:\n\n\t::\n\n\t\tpvObject = PvObject({'labels' : [STRING], 'value' : {'column0' : [DOUBLE], 'column1' : [DOUBLE], 'column2' : [DOUBLE]}})\n\n\t\tpvObject.setScalarArray('labels', ['x', 'y', 'z'])\n\n\t\tpvObject.setStructure('value', {'column0' : [0.1, 0.2, 0.3], 'column1' : [1.1, 1.2, 1.3], 'column2' : [2.1, 2.2, 2.3]})\n\n\t\ttable3 = NtTable(pvObject)", init()) .def(init()) .def(init()) .def("getNColumns", &NtTable::getNColumns, "Retrieves number of columns.\n\n:Returns: number of table columns\n\n::\n\n nColumns = table.getNColumns()\n\n") .def("getLabels", &NtTable::getLabels, "Retrieves list of column labels.\n\n:Returns: list of column labels\n\n::\n\n labelList = table.getLabels()\n\n") .def("setLabels", &NtTable::setLabels, args("labelList"), "Sets column labels.\n\n:Parameter: *labelList* ([str]) - list of strings containing column labels (the list length must match number of table columns)\n\n::\n\n table.setLabels(['String', 'Int', 'Double'])\n\n") .def("getColumn", &NtTable::getColumn, args("index"), "Retrieves specified column.\n\n:Parameter: *index* (int) - column index (must be in range [0,N-1], where N is the number of table columns)\n\n:Returns: list of values stored in the specified table column\n\n::\n\n valueList = table.getColumn(0)\n\n") .def("setColumn", &NtTable::setColumn, args("index", "valueList"), "Sets column values.\n\n:Parameter: *index* (int) - column index\n\n:Parameter: *valueList* (list) - list of column values\n\n::\n\n table.setColumn(0, ['x', 'y', 'z'])\n\n") .def("getDescriptor", &NtTable::getDescriptor, "Retrieves table descriptor.\n\n:Returns: table descriptor\n\n::\n\n descriptor = table.getDescriptor()\n\n") .def("setDescriptor", &NtTable::setDescriptor, args("descriptor"), "Sets table descriptor.\n\n:Parameter: *descriptor* (str) - table descriptor\n\n::\n\n table.setDescriptor('myTable')\n\n") .def("getTimeStamp", &NtTable::getTimeStamp, "Retrieves table time stamp.\n\n:Returns: table time stamp object\n\n::\n\n timeStamp = table.getTimeStamp()\n\n") .def("setTimeStamp", &NtTable::setTimeStamp, args("timeStamp"), "Sets table time stamp.\n\n:Parameter: *timeStamp* (PvTimeStamp) - table time stamp object\n\n::\n\n timeStamp = PvTimeStamp(1234567890, 10000, 1)\n\n table.setTimeStamp(timeStamp)\n\n") .def("getAlarm", &NtTable::getAlarm, "Retrieves table alarm.\n\n:Returns: table alarm object\n\n::\n\n alarm = table.getAlarm()\n\n") .def("setAlarm", &NtTable::setAlarm, args("alarm"), "Sets table alarm.\n\n:Parameter: *alarm* (PvAlarm) - table alarm object\n\n::\n\n alarm = PvAlarm(11, 126, 'Server SegFault')\n\n table.setAlarm(alarm)\n\n") ; // Channel class_("Channel", "This class represents PV channels.\n\n**Channel(name [, providerType=PVA])**\n\n\t:Parameter: *fieldName* (str) - channel name\n\n\t:Parameter: *providerType* (PROVIDERTYPE) - provider type, either PVA (PV Access) or CA (Channel Access)\n\n\tNote that PV structures representing objects on CA channels always have a single key 'value'.\n\tThe following example creates PVA channel 'enum01':\n\n\t::\n\n\t\tpvaChannel = Channel('enum01')\n\n\tThis example allows access to CA channel 'CA:INT':\n\n\t::\n\n\t\tcaChannel = Channel('CA:INT', CA)\n\n", init()) .def(init()) .def("get", static_cast(&Channel::get), return_value_policy(), args("requestDescriptor"), "Retrieves PV data from the channel.\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n:Returns: channel PV data corresponding to the specified request descriptor\n\n::\n\n channel = Channel('enum01')\n\n pv = channel.get('field(value.index)')\n\n") .def("get", static_cast(&Channel::get), return_value_policy(), "Retrieves PV data from the channel using the default request descriptor 'field(value)'.\n\n:Returns: channel PV data\n\n::\n\n pv = channel.get()\n\n") .def("put", static_cast(&Channel::put), args("pvObject", "requestDescriptor"), "Assigns PV data to the channel process variable.\n\n:Parameter: *pvObject* (PvObject) - PV object that will be assigned to channel PV according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n::\n\n channel = Channel('enum01')\n\n channel.put(PvInt(1), 'field(value.index)')\n\n") .def("put", static_cast(&Channel::put), args("pvObject"), "Assigns PV data to the channel process variable using the default request descriptor 'field(value)'.\n\n:Parameter: *pvObject* (PvObject) - PV object that will be assigned to the channel process variable\n\n::\n\n channel = Channel('int01')\n\n channel.put(PvInt(1))\n\n") .def("putString", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns string data to the channel PV.\n\n:Parameter: *value* (str) - string value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns string data to the channel PV.\n\n:Parameter: *value* (str) - string value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putString", static_cast(&Channel::put), args("value"), "Assigns string data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (str) - string value that will be assigned to the channel PV\n\n::\n\n channel = Channel('string01')\n\n channel.putString('string value')\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns string data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (str) - string value that will be assigned to the channel PV\n\n::\n\n channel = Channel('string01')\n\n channel.put('string value')\n\n") .def("putScalarArray", static_cast(&Channel::put), args("valueList", "requestDescriptor"), "Assigns scalar array data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *valueList* (list) - list of scalar values that will be assigned to the channel PV\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("valueList", "requestDescriptor"), "Assigns scalar array data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *valueList* (list) - list of scalar values that will be assigned to the channel PV\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putScalarArray", static_cast(&Channel::put), args("valueList"), "Assigns scalar array data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *valueList* (list) - list of scalar values that will be assigned to the channel PV\n\n::\n\n channel = Channel('intArray01')\n\n channel.putScalarArray([0,1,2,3,4])\n\n") .def("put", static_cast(&Channel::put), args("valueList"), "Assigns scalar array data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *valueList* (list) - list of scalar values that will be assigned to the channel PV\n\n::\n\n channel = Channel('intArray01')\n\n channel.put([0,1,2,3,4])\n\n") .def("putBoolean", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns boolean data to the channel PV.\n\n:Parameter: *value* (bool) - boolean value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns boolean data to the channel PV.\n\n:Parameter: *value* (bool) - boolean value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putBoolean", static_cast(&Channel::put), args("value"), "Assigns boolean data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (bool) - boolean value that will be assigned to the channel PV\n\n::\n\n channel = Channel('boolean01')\n\n channel.putBoolean(True)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns boolean data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (bool) - boolean value that will be assigned to the channel PV\n\n::\n\n channel = Channel('boolean01')\n\n channel.put(True)\n\n") // Do not define simple put() for byte data type at the moment: byte is interpreted as string, and python cannot pickup // correct method for strings, so that put('my string') would not work // put() should still work even without explicit maping, but will not be documented .def("putByte", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns byte data to the channel PV.\n\n:Parameter: *value* (str) - byte value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") //.def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns byte data to the channel PV.\n\n:Parameter: *value* (str) - byte value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putByte", static_cast(&Channel::put), args("value"), "Assigns byte data to the channel using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (str) - byte value that will be assigned to the channel PV\n\n::\n\n channel = Channel('byte01')\n\n channel.putByte('x')\n\n") //.def("put", static_cast(&Channel::put), args("value"), "Assigns byte data to the channel using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (str) - byte value that will be assigned to the channel PV\n\n::\n\n channel = Channel('byte01')\n\n channel.put('10')\n\n") .def("putUByte", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned byte data to the channel PV.\n\n:Parameter: *value* (int) - unsigned byte value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned byte data to the channel PV.\n\n:Parameter: *value* (int) - unsigned byte value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putUByte", static_cast(&Channel::put), args("value"), "Assigns unsigned byte data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - unsigned byte value that will be assigned to the channel PV\n\n::\n\n channel = Channel('ubyte01')\n\n channel.putUByte(10)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns unsigned byte data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - unsigned byte value that will be assigned to the channel PV\n\n::\n\n channel = Channel('ubyte01')\n\n channel.put(10)\n\n") .def("putShort", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns short data to the channel PV.\n\n:Parameter: *value* (int) - short value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns short data to the channel PV.\n\n:Parameter: *value* (int) - short value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putShort", static_cast(&Channel::put), args("value"), "Assigns short data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - short value that will be assigned to the channel PV\n\n::\n\n channel = Channel('short01')\n\n channel.putShort(10)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns short data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - short value that will be assigned to the channel PV\n\n::\n\n channel = Channel('short01')\n\n channel.put(10)\n\n") .def("putUShort", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned short data to the channel PV.\n\n:Parameter: *value* (int) - unsigned short value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned short data to the channel PV.\n\n:Parameter: *value* (int) - unsigned short value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putUShort", static_cast(&Channel::put), args("value"), "Assigns unsigned short data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - unsigned short value that will be assigned to the channel PV\n\n::\n\n channel = Channel('ushort01')\n\n channel.putUShort(10)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns unsigned short data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - unsigned short value that will be assigned to the channel PV\n\n::\n\n channel = Channel('ushort01')\n\n channel.put(10)\n\n") .def("putInt", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns integer data to the channel PV.\n\n:Parameter: *value* (int) - integer value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns integer data to the channel PV.\n\n:Parameter: *value* (int) - integer value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putInt", static_cast(&Channel::put), args("value"), "Assigns integer data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - integer value that will be assigned to the channel PV\n\n::\n\n channel = Channel('int01')\n\n channel.putInt(1000)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns integer data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - integer value that will be assigned to the channel PV\n\n::\n\n channel = Channel('int01')\n\n channel.put(1000)\n\n") .def("putUInt", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned integer data to the channel PV.\n\n:Parameter: *value* (int) - unsigned integer value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putUInt", static_cast(&Channel::put), args("value"), "Assigns unsigned integer data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (int) - unsigned integer value that will be assigned to the channel PV\n\n::\n\n channel = Channel('uint01')\n\n channel.putUInt(1000)\n\n") .def("putLong", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns long data to the channel PV.\n\n:Parameter: *value* (long) - long value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns long data to the channel PV.\n\n:Parameter: *value* (long) - long value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putLong", static_cast(&Channel::put), args("value"), "Assigns long data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (long) - long value that will be assigned to the channel PV\n\n::\n\n channel = Channel('long01')\n\n channel.putLong(100000L)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns long data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (long) - long value that will be assigned to the channel PV\n\n::\n\n channel = Channel('long01')\n\n channel.put(100000L)\n\n") .def("putULong", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns unsigned long data to the channel PV.\n\n:Parameter: *value* (long) - unsigned long value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putULong", static_cast(&Channel::put), args("value"), "Assigns unsigned long data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (long) - unsigned long value that will be assigned to the channel PV\n\n::\n\n channel = Channel('ulong01')\n\n channel.putULong(100000L)\n\n") .def("putFloat", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns float data to the channel PV.\n\n:Parameter: *value* (float) - float value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns float data to the channel PV.\n\n:Parameter: *value* (float) - float value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putFloat", static_cast(&Channel::put), args("value"), "Assigns float data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (float) - float value that will be assigned to the channel PV\n\n::\n\n channel = Channel('float01')\n\n channel.putFloat(1.1)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Assigns float data to the channel PV using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (float) - float value that will be assigned to the channel PV\n\n::\n\n channel = Channel('float01')\n\n channel.put(1.1)\n\n") .def("putDouble", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns double data to the channel PV.\n\n:Parameter: *value* (float) - double value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("put", static_cast(&Channel::put), args("value", "requestDescriptor"), "Assigns double data to the channel PV.\n\n:Parameter: *value* (float) - double value that will be assigned to channel data according to the specified request descriptor\n\n:Parameter: *requestDescriptor* (str) - PV request descriptor\n\n") .def("putDouble", static_cast(&Channel::put), args("value"), "Puts double data into the channel using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (float) - double value that will be assigned to the channel PV\n\n::\n\n channel = Channel('double01')\n\n channel.putDouble(1.1)\n\n") .def("put", static_cast(&Channel::put), args("value"), "Puts double data into the channel using the default request descriptor 'field(value)'.\n\n:Parameter: *value* (float) - double value that will be assigned to the channel PV\n\n::\n\n channel = Channel('double01')\n\n channel.put(1.1)\n\n") .def("subscribe", &Channel::subscribe, args("subscriberName", "subscriber"), "Subscribes python object to notifications of changes in PV value. Channel can have any number of subscribers that start receiving PV updates after *startMonitor()* is invoked. Updates stop after channel monitor is stopped via *stopMonitor()* call, or object is unsubscribed from notifications using *unsubscribe()* call.\n\n:Parameter: *fieldName* (str) - subscriber object name\n\n:Parameter: *subscriber* (object) - reference to python subscriber object (e.g., python function) that will be executed when PV value changes\n\nThe following code snippet defines a simple subscriber object, subscribes it to PV value changes, and starts channel monitor:\n\n::\n\n def echo(x):\n\n print 'New PV value: ', x\n\n channel = Channel('float01')\n\n channel.subscribe('echo', echo)\n\n channel.startMonitor()\n\n") .def("unsubscribe", &Channel::unsubscribe, args("fieldName"), "Unsubscribes subscriber object from notifications of changes in PV value.\n\n:Parameter: *fieldName* (str) - subscriber name\n\n::\n\n channel.unsubscribe('echo')\n\n") .def("startMonitor", static_cast(&Channel::startMonitor), args("requestDescriptor"), "Starts channel monitor for PV value changes.\n\n:Parameter: *requestDescriptor* (str) - describes what PV data should be sent to subscribed channel clients\n\n::\n\n channel.startMonitor('field(value.index)')\n\n") .def("startMonitor", static_cast(&Channel::startMonitor), "Starts channel monitor for PV value changes using the default request descriptor 'field(value)'.\n\n::\n\n channel.startMonitor()\n\n") .def("stopMonitor", &Channel::stopMonitor, "Stops channel monitor for PV value changes.\n\n::\n\n channel.stopMonitor()\n\n") .def("getTimeout", &Channel::getTimeout, "Retrieves channel timeout.\n\n:Returns: channel timeout in seconds\n\n::\n\n timeout = channel.getTimeout()\n\n") .def("setTimeout", &Channel::setTimeout, args("timeout"), "Sets channel timeout.\n\n:Parameter: *timeout* (float) - channel timeout in seconds\n\n::\n\n channel.setTimeout(10.0)\n\n") .def("getMonitorMaxQueueLength", &Channel::getMonitorMaxQueueLength, "Retrieves maximum monitor queue length.\n\n:Returns: maximum monitor queue length\n\n::\n\n maxQueueLength = channel.getMonitorMaxQueueLength()\n\n") .def("setMonitorMaxQueueLength", &Channel::setMonitorMaxQueueLength, args("maxQueueLength"), "Sets maximum monitor queue length. In case subscribers cannot process incoming PV objects quickly enough, oldest PV object will be discarded after monitoring queue reaches maximum size. Default monitor queue length is unlimited.\n\n:Parameter: *maxQueueLength* (int) - maximum queue length\n\n::\n\n channel.setMonitorMaxQueueLengthTimeout(10)\n\n") ; // RPC Client class_("RpcClient", "RpcClient is a client class for PVA RPC services.\n\n**RpcClient(channelName)**\n\n\t:Parameter: *channelName* (str) - RPC service channel name\n\n\tThis example creates RPC client for channel 'createNtTable':\n\n\t::\n\n\t\trpcClient = RpcClient('createNtTable')\n\n", init()) .def("invoke", &RpcClient::invoke, return_value_policy(), args("pvRequest"), "Invokes RPC call against service registered on the PV specified channel.\n\n:Parameter: *pvRequest* (PvObject) - PV request object with a structure conforming to requirements of the RPC service registered on the given PV channel\n\n:Returns: PV response object\n\nThe following code works with the above RPC service example:\n\n::\n\n pvRequest = PvObject({'nRows' : INT, 'nColumns' : INT})\n\n pvRequest.set({'nRows' : 10, 'nColumns' : 10})\n\n pvResponse = rpcClient(pvRequest)\n\n ntTable = NtTable(pvRequest)\n\n") ; // RPC Service Impl //class_ >("RpcServiceImpl", init()) ; // RPC Server class_("RpcServer", "RpcServer is class used for hosting PVA RPC services. One instance of RpcServer can host multiple RPC services.\n\n**RpcServer()**:\n\n\t::\n\n\t\trpcServer = RpcServer()\n\n", init<>()) .def("registerService", &RpcServer::registerService, args("serviceName", "serviceImpl"), "Registers service implementation with RPC server. Typically, all services are registered before RPC server starts listening for client requests.\n\n:Parameter: *serviceName* (str) - service name (name of the PV channel used for RPC client/server communication)\n\n:Parameter: *serviceImpl* (object) - reference to service implementation object (e.g., python function) that returns PV Object upon invocation\n\nThe following is an example of RPC service that creates NT Table according to client specifications:\n\n::\n\n import pvaccess\n\n import random\n\n def createNtTable(pvRequest):\n\n nRows = x.getInt('nRows')\n\n nColumns = x.getInt('nColumns')\n\n print 'Creating table with %d rows and %d columns' % (nRows, nColumns)\n\n ntTable = pvaccess.NtTable(nColumns, pvaccess.DOUBLE)\n\n labels = []\n\n for j in range (0, nColumns):\n\n labels.append('Column%s' % j)\n\n column = []\n\n for i in range (0, nRows):\n\n column.append(random.uniform(0,1))\n\n ntTable.setColumn(j, column)\n\n ntTable.setLabels(labels)\n\n ntTable.setDescriptor('Automatically created by pvaPy RPC Server')\n\n return ntTable\n\n \n\n rpcServer = pvaccess.RpcServer()\n\n rpcServer.registerService('createNtTable', createNtTable)\n\n rpcServer.listen()\n\n") .def("unregisterService", &RpcServer::unregisterService, args("serviceName"), "Unregisters given service from RPC server.\n\n:Parameter: *serviceName* (str) - service name (name of the PV channel used for RPC client/server communication)\n\n::\n\n rpcServer.unregisterService('createNtTable')\n\n") .def("startListener", &RpcServer::startListener, "Starts RPC listener in its own thread. This method is typically used for multi-threaded programs, or for testing and debugging in python interactive mode. It should be used in conjunction with *stopListener()* call.\n\n::\n\n rpcServer.startListener()") .def("stopListener", &RpcServer::stopListener, "Stops RPC listener thread. This method is used in conjunction with *startListener()* call.\n\n::\n\n rpcServer.stopListener()\n\n") .def("start", &RpcServer::start, "Start serving RPC requests. This method is equivalent to *listen()*, and blocks until either *stop()* or *shutdown()* methods are invoked.\n\n::\n\n rpcServer.start()") .def("stop", &RpcServer::stop, "Stop serving RPC requests. This method is equivalent to *shutdown()*.\n\n::\n\n rpcServer.stop()") .def("listen", static_cast(&RpcServer::listen), RpcServerListen(args("seconds=0"), "Start serving RPC requests.\n\n:Parameter: *seconds* (int) - specifies the amount of time server should be listening for requests (0 indicates 'forever')\n\n::\n\n rpcServer.listen(60)\n\n")) .def("shutdown", &RpcServer::shutdown, "Stop serving RPC requests. This method is equivalent to *stop()*.\n\n::\n\n rpcServer.shutdown()") ; }