mrpt.pymrpt.mrpt.serialization
index
(built-in)

Bindings for mrpt::serialization namespace

 
Classes
       
mrpt.pymrpt.mrpt.rtti.CObject(pybind11_builtins.pybind11_object)
CSerializable
pybind11_builtins.pybind11_object(builtins.object)
CArchive
CArchiveStreamBase_mrpt_io_CFileGZInputStream_t
CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t
CArchiveStreamBase_mrpt_io_CFileInputStream_t
CArchiveStreamBase_mrpt_io_CFileOutputStream_t
CExceptionEOF
CMessage

 
class CArchive(pybind11_builtins.pybind11_object)
    Virtual base class for "archives": classes abstracting I/O streams.
This class separates the implementation details of serialization (in
CSerializable) and data storage (CArchive children: files, sockets,...).
 
Two main sets of implementations are provided:
- archiveFrom: for MRPT mrpt::io::CArchive objects, and
- CArchiveStdIStream and CArchiveStdOStream: for std::istream and
std::ostream, respectively.
 
 
mrpt::io::CArchive, mrpt::serialization::CSerializable
 
 
Method resolution order:
CArchive
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
ReadAs(...)
ReadAs(self: mrpt.pymrpt.mrpt.serialization.CArchive) -> int
 
C++: mrpt::serialization::CArchive::ReadAs() --> unsigned int
ReadBuffer(...)
ReadBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchive, Buffer: capsule, Count: int) -> int
 
@{ 
 
 Reads a block of bytes from the stream into Buffer
        
 
 std::exception On any error, or if ZERO bytes are read.
  
 
 The amound of bytes actually read.
 
 
 This method is endianness-dependent.
 
 
 ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,
 
C++: mrpt::serialization::CArchive::ReadBuffer(void *, size_t) --> size_t
ReadObject(...)
ReadObject(*args, **kwargs)
Overloaded function.
 
1. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
2. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
Reads an object from stream, its class determined at runtime, and
 returns a smart pointer to the object.
 
 
 std::exception On I/O error or undefined class.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
3. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchive, existingObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Reads an object from stream, where its class must be the same
    as the supplied object, where the loaded object will be stored in.
 
 
 std::exception On I/O error or different class found.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject(class mrpt::serialization::CSerializable *) --> void
WriteAs(...)
WriteAs(self: mrpt.pymrpt.mrpt.serialization.CArchive, value: int) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::WriteAs(const unsigned long &) --> class mrpt::serialization::CArchive &
WriteBuffer(...)
WriteBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchive, Buffer: capsule, Count: int) -> None
 
Writes a block of bytes to the stream from Buffer.
        
 
 std::exception On any error
  
 
 Important, see: WriteBufferFixEndianness
 
 
 This method is endianness-dependent.
 
C++: mrpt::serialization::CArchive::WriteBuffer(const void *, size_t) --> void
WriteObject(...)
WriteObject(*args, **kwargs)
Overloaded function.
 
1. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchive, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Writes an object to the stream.
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable *) --> void
 
2. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchive, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable &) --> void
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchive) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchive, arg0: mrpt.pymrpt.mrpt.serialization.CArchive) -> None
__lshift__(...)
__lshift__(*args, **kwargs)
Overloaded function.
 
1. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchive, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Write a CSerializable object to a stream in the binary MRPT format 
 
C++: mrpt::serialization::CArchive::operator<<(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchive, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator<<(const class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
__rshift__(...)
__rshift__(*args, **kwargs)
Overloaded function.
 
1. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchive, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Reads a CSerializable object from the stream 
 
C++: mrpt::serialization::CArchive::operator>>(class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchive, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator>>(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CArchive, : mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator=(const class mrpt::serialization::CArchive &) --> class mrpt::serialization::CArchive &
getArchiveDescription(...)
getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchive) -> str
 
If redefined in derived classes, allows finding a human-friendly
 description of the underlying stream (e.g. filename) 
 
C++: mrpt::serialization::CArchive::getArchiveDescription() const --> std::string
receiveMessage(...)
receiveMessage(self: mrpt.pymrpt.mrpt.serialization.CArchive, msg: mrpt::serialization::CMessage) -> bool
 
Tries to receive a message from the device.
 
 
 std::exception On communication errors
 
 
 True if successful, false if there is no new data from the
 device (but communications seem to work fine)
 
 
 The frame format is described in sendMessage()
 
C++: mrpt::serialization::CArchive::receiveMessage(class mrpt::serialization::CMessage &) --> bool
sendMessage(...)
sendMessage(self: mrpt.pymrpt.mrpt.serialization.CArchive, msg: mrpt::serialization::CMessage) -> None
 
Send a message to the device.
  Note that only the low byte from the "type" field will be used.
 
  For frames of size < 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
  For frames of size > 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
 
 
 std::exception On communication errors
 
C++: mrpt::serialization::CArchive::sendMessage(const class mrpt::serialization::CMessage &) --> void

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CArchiveStreamBase_mrpt_io_CFileGZInputStream_t(CArchive)
    
Method resolution order:
CArchiveStreamBase_mrpt_io_CFileGZInputStream_t
CArchive
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
ReadAs(...)
ReadAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> int
 
C++: mrpt::serialization::CArchive::ReadAs() --> unsigned int
ReadBuffer(...)
ReadBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, Buffer: capsule, Count: int) -> int
 
@{ 
 
 Reads a block of bytes from the stream into Buffer
        
 
 std::exception On any error, or if ZERO bytes are read.
  
 
 The amound of bytes actually read.
 
 
 This method is endianness-dependent.
 
 
 ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,
 
C++: mrpt::serialization::CArchive::ReadBuffer(void *, size_t) --> size_t
ReadObject(...)
ReadObject(*args, **kwargs)
Overloaded function.
 
1. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
2. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
Reads an object from stream, its class determined at runtime, and
 returns a smart pointer to the object.
 
 
 std::exception On I/O error or undefined class.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
3. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, existingObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Reads an object from stream, where its class must be the same
    as the supplied object, where the loaded object will be stored in.
 
 
 std::exception On I/O error or different class found.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject(class mrpt::serialization::CSerializable *) --> void
WriteAs(...)
WriteAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, value: int) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::WriteAs(const unsigned long &) --> class mrpt::serialization::CArchive &
WriteBuffer(...)
WriteBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, Buffer: capsule, Count: int) -> None
 
Writes a block of bytes to the stream from Buffer.
        
 
 std::exception On any error
  
 
 Important, see: WriteBufferFixEndianness
 
 
 This method is endianness-dependent.
 
C++: mrpt::serialization::CArchive::WriteBuffer(const void *, size_t) --> void
WriteObject(...)
WriteObject(*args, **kwargs)
Overloaded function.
 
1. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Writes an object to the stream.
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable *) --> void
 
2. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable &) --> void
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, s: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> None
 
3. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> None
__lshift__(...)
__lshift__(*args, **kwargs)
Overloaded function.
 
1. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Write a CSerializable object to a stream in the binary MRPT format 
 
C++: mrpt::serialization::CArchive::operator<<(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator<<(const class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
__rshift__(...)
__rshift__(*args, **kwargs)
Overloaded function.
 
1. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Reads a CSerializable object from the stream 
 
C++: mrpt::serialization::CArchive::operator>>(class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator>>(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, : mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator=(const class mrpt::serialization::CArchive &) --> class mrpt::serialization::CArchive &
getArchiveDescription(...)
getArchiveDescription(*args, **kwargs)
Overloaded function.
 
1. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> str
 
C++: mrpt::serialization::CArchiveStreamBase<mrpt::io::CFileGZInputStream>::getArchiveDescription() const --> std::string
 
2. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t) -> str
 
If redefined in derived classes, allows finding a human-friendly
 description of the underlying stream (e.g. filename) 
 
C++: mrpt::serialization::CArchive::getArchiveDescription() const --> std::string
receiveMessage(...)
receiveMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, msg: mrpt::serialization::CMessage) -> bool
 
Tries to receive a message from the device.
 
 
 std::exception On communication errors
 
 
 True if successful, false if there is no new data from the
 device (but communications seem to work fine)
 
 
 The frame format is described in sendMessage()
 
C++: mrpt::serialization::CArchive::receiveMessage(class mrpt::serialization::CMessage &) --> bool
sendMessage(...)
sendMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t, msg: mrpt::serialization::CMessage) -> None
 
Send a message to the device.
  Note that only the low byte from the "type" field will be used.
 
  For frames of size < 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
  For frames of size > 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
 
 
 std::exception On communication errors
 
C++: mrpt::serialization::CArchive::sendMessage(const class mrpt::serialization::CMessage &) --> void

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t(CArchive)
    
Method resolution order:
CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t
CArchive
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
ReadAs(...)
ReadAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> int
 
C++: mrpt::serialization::CArchive::ReadAs() --> unsigned int
ReadBuffer(...)
ReadBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, Buffer: capsule, Count: int) -> int
 
@{ 
 
 Reads a block of bytes from the stream into Buffer
        
 
 std::exception On any error, or if ZERO bytes are read.
  
 
 The amound of bytes actually read.
 
 
 This method is endianness-dependent.
 
 
 ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,
 
C++: mrpt::serialization::CArchive::ReadBuffer(void *, size_t) --> size_t
ReadObject(...)
ReadObject(*args, **kwargs)
Overloaded function.
 
1. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
2. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
Reads an object from stream, its class determined at runtime, and
 returns a smart pointer to the object.
 
 
 std::exception On I/O error or undefined class.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
3. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, existingObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Reads an object from stream, where its class must be the same
    as the supplied object, where the loaded object will be stored in.
 
 
 std::exception On I/O error or different class found.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject(class mrpt::serialization::CSerializable *) --> void
WriteAs(...)
WriteAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, value: int) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::WriteAs(const unsigned long &) --> class mrpt::serialization::CArchive &
WriteBuffer(...)
WriteBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, Buffer: capsule, Count: int) -> None
 
Writes a block of bytes to the stream from Buffer.
        
 
 std::exception On any error
  
 
 Important, see: WriteBufferFixEndianness
 
 
 This method is endianness-dependent.
 
C++: mrpt::serialization::CArchive::WriteBuffer(const void *, size_t) --> void
WriteObject(...)
WriteObject(*args, **kwargs)
Overloaded function.
 
1. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Writes an object to the stream.
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable *) --> void
 
2. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable &) --> void
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, s: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> None
 
3. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> None
__lshift__(...)
__lshift__(*args, **kwargs)
Overloaded function.
 
1. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Write a CSerializable object to a stream in the binary MRPT format 
 
C++: mrpt::serialization::CArchive::operator<<(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator<<(const class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
__rshift__(...)
__rshift__(*args, **kwargs)
Overloaded function.
 
1. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Reads a CSerializable object from the stream 
 
C++: mrpt::serialization::CArchive::operator>>(class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator>>(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, : mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator=(const class mrpt::serialization::CArchive &) --> class mrpt::serialization::CArchive &
getArchiveDescription(...)
getArchiveDescription(*args, **kwargs)
Overloaded function.
 
1. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> str
 
C++: mrpt::serialization::CArchiveStreamBase<mrpt::io::CFileGZOutputStream>::getArchiveDescription() const --> std::string
 
2. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t) -> str
 
If redefined in derived classes, allows finding a human-friendly
 description of the underlying stream (e.g. filename) 
 
C++: mrpt::serialization::CArchive::getArchiveDescription() const --> std::string
receiveMessage(...)
receiveMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, msg: mrpt::serialization::CMessage) -> bool
 
Tries to receive a message from the device.
 
 
 std::exception On communication errors
 
 
 True if successful, false if there is no new data from the
 device (but communications seem to work fine)
 
 
 The frame format is described in sendMessage()
 
C++: mrpt::serialization::CArchive::receiveMessage(class mrpt::serialization::CMessage &) --> bool
sendMessage(...)
sendMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t, msg: mrpt::serialization::CMessage) -> None
 
Send a message to the device.
  Note that only the low byte from the "type" field will be used.
 
  For frames of size < 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
  For frames of size > 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
 
 
 std::exception On communication errors
 
C++: mrpt::serialization::CArchive::sendMessage(const class mrpt::serialization::CMessage &) --> void

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CArchiveStreamBase_mrpt_io_CFileInputStream_t(CArchive)
    
Method resolution order:
CArchiveStreamBase_mrpt_io_CFileInputStream_t
CArchive
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
ReadAs(...)
ReadAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> int
 
C++: mrpt::serialization::CArchive::ReadAs() --> unsigned int
ReadBuffer(...)
ReadBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, Buffer: capsule, Count: int) -> int
 
@{ 
 
 Reads a block of bytes from the stream into Buffer
        
 
 std::exception On any error, or if ZERO bytes are read.
  
 
 The amound of bytes actually read.
 
 
 This method is endianness-dependent.
 
 
 ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,
 
C++: mrpt::serialization::CArchive::ReadBuffer(void *, size_t) --> size_t
ReadObject(...)
ReadObject(*args, **kwargs)
Overloaded function.
 
1. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
2. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
Reads an object from stream, its class determined at runtime, and
 returns a smart pointer to the object.
 
 
 std::exception On I/O error or undefined class.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
3. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, existingObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Reads an object from stream, where its class must be the same
    as the supplied object, where the loaded object will be stored in.
 
 
 std::exception On I/O error or different class found.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject(class mrpt::serialization::CSerializable *) --> void
WriteAs(...)
WriteAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, value: int) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::WriteAs(const unsigned long &) --> class mrpt::serialization::CArchive &
WriteBuffer(...)
WriteBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, Buffer: capsule, Count: int) -> None
 
Writes a block of bytes to the stream from Buffer.
        
 
 std::exception On any error
  
 
 Important, see: WriteBufferFixEndianness
 
 
 This method is endianness-dependent.
 
C++: mrpt::serialization::CArchive::WriteBuffer(const void *, size_t) --> void
WriteObject(...)
WriteObject(*args, **kwargs)
Overloaded function.
 
1. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Writes an object to the stream.
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable *) --> void
 
2. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable &) --> void
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, s: mrpt.pymrpt.mrpt.io.CFileInputStream) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> None
 
3. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> None
__lshift__(...)
__lshift__(*args, **kwargs)
Overloaded function.
 
1. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Write a CSerializable object to a stream in the binary MRPT format 
 
C++: mrpt::serialization::CArchive::operator<<(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator<<(const class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
__rshift__(...)
__rshift__(*args, **kwargs)
Overloaded function.
 
1. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Reads a CSerializable object from the stream 
 
C++: mrpt::serialization::CArchive::operator>>(class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator>>(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, : mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator=(const class mrpt::serialization::CArchive &) --> class mrpt::serialization::CArchive &
getArchiveDescription(...)
getArchiveDescription(*args, **kwargs)
Overloaded function.
 
1. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> str
 
C++: mrpt::serialization::CArchiveStreamBase<mrpt::io::CFileInputStream>::getArchiveDescription() const --> std::string
 
2. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t) -> str
 
If redefined in derived classes, allows finding a human-friendly
 description of the underlying stream (e.g. filename) 
 
C++: mrpt::serialization::CArchive::getArchiveDescription() const --> std::string
receiveMessage(...)
receiveMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, msg: mrpt::serialization::CMessage) -> bool
 
Tries to receive a message from the device.
 
 
 std::exception On communication errors
 
 
 True if successful, false if there is no new data from the
 device (but communications seem to work fine)
 
 
 The frame format is described in sendMessage()
 
C++: mrpt::serialization::CArchive::receiveMessage(class mrpt::serialization::CMessage &) --> bool
sendMessage(...)
sendMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t, msg: mrpt::serialization::CMessage) -> None
 
Send a message to the device.
  Note that only the low byte from the "type" field will be used.
 
  For frames of size < 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
  For frames of size > 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
 
 
 std::exception On communication errors
 
C++: mrpt::serialization::CArchive::sendMessage(const class mrpt::serialization::CMessage &) --> void

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CArchiveStreamBase_mrpt_io_CFileOutputStream_t(CArchive)
    
Method resolution order:
CArchiveStreamBase_mrpt_io_CFileOutputStream_t
CArchive
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
ReadAs(...)
ReadAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> int
 
C++: mrpt::serialization::CArchive::ReadAs() --> unsigned int
ReadBuffer(...)
ReadBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, Buffer: capsule, Count: int) -> int
 
@{ 
 
 Reads a block of bytes from the stream into Buffer
        
 
 std::exception On any error, or if ZERO bytes are read.
  
 
 The amound of bytes actually read.
 
 
 This method is endianness-dependent.
 
 
 ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,
 
C++: mrpt::serialization::CArchive::ReadBuffer(void *, size_t) --> size_t
ReadObject(...)
ReadObject(*args, **kwargs)
Overloaded function.
 
1. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
2. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
Reads an object from stream, its class determined at runtime, and
 returns a smart pointer to the object.
 
 
 std::exception On I/O error or undefined class.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject() --> class std::shared_ptr<class mrpt::serialization::CSerializable>
 
3. ReadObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, existingObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Reads an object from stream, where its class must be the same
    as the supplied object, where the loaded object will be stored in.
 
 
 std::exception On I/O error or different class found.
 
 
 CExceptionEOF On an End-Of-File condition found
 at a correct place: an EOF that abruptly finishes in the middle of one
 object raises a plain std::exception instead.
 
C++: mrpt::serialization::CArchive::ReadObject(class mrpt::serialization::CSerializable *) --> void
WriteAs(...)
WriteAs(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, value: int) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::WriteAs(const unsigned long &) --> class mrpt::serialization::CArchive &
WriteBuffer(...)
WriteBuffer(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, Buffer: capsule, Count: int) -> None
 
Writes a block of bytes to the stream from Buffer.
        
 
 std::exception On any error
  
 
 Important, see: WriteBufferFixEndianness
 
 
 This method is endianness-dependent.
 
C++: mrpt::serialization::CArchive::WriteBuffer(const void *, size_t) --> void
WriteObject(...)
WriteObject(*args, **kwargs)
Overloaded function.
 
1. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Writes an object to the stream.
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable *) --> void
 
2. WriteObject(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, o: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
C++: mrpt::serialization::CArchive::WriteObject(const class mrpt::serialization::CSerializable &) --> void
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, s: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> None
 
3. __init__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, arg0: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> None
__lshift__(...)
__lshift__(*args, **kwargs)
Overloaded function.
 
1. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Write a CSerializable object to a stream in the binary MRPT format 
 
C++: mrpt::serialization::CArchive::operator<<(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __lshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator<<(const class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
__rshift__(...)
__rshift__(*args, **kwargs)
Overloaded function.
 
1. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
Reads a CSerializable object from the stream 
 
C++: mrpt::serialization::CArchive::operator>>(class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CArchive &
 
2. __rshift__(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, pObj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator>>(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> class mrpt::serialization::CArchive &
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, : mrpt.pymrpt.mrpt.serialization.CArchive) -> mrpt.pymrpt.mrpt.serialization.CArchive
 
C++: mrpt::serialization::CArchive::operator=(const class mrpt::serialization::CArchive &) --> class mrpt::serialization::CArchive &
getArchiveDescription(...)
getArchiveDescription(*args, **kwargs)
Overloaded function.
 
1. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> str
 
C++: mrpt::serialization::CArchiveStreamBase<mrpt::io::CFileOutputStream>::getArchiveDescription() const --> std::string
 
2. getArchiveDescription(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t) -> str
 
If redefined in derived classes, allows finding a human-friendly
 description of the underlying stream (e.g. filename) 
 
C++: mrpt::serialization::CArchive::getArchiveDescription() const --> std::string
receiveMessage(...)
receiveMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, msg: mrpt::serialization::CMessage) -> bool
 
Tries to receive a message from the device.
 
 
 std::exception On communication errors
 
 
 True if successful, false if there is no new data from the
 device (but communications seem to work fine)
 
 
 The frame format is described in sendMessage()
 
C++: mrpt::serialization::CArchive::receiveMessage(class mrpt::serialization::CMessage &) --> bool
sendMessage(...)
sendMessage(self: mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t, msg: mrpt::serialization::CMessage) -> None
 
Send a message to the device.
  Note that only the low byte from the "type" field will be used.
 
  For frames of size < 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
  For frames of size > 255 the frame format is an array of bytes in this
 order:
  
 
 
 
 
 
 
 
 
 
 
 
 std::exception On communication errors
 
C++: mrpt::serialization::CArchive::sendMessage(const class mrpt::serialization::CMessage &) --> void

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CExceptionEOF(pybind11_builtins.pybind11_object)
    Used in mrpt::serialization::CArchive
 
 
Method resolution order:
CExceptionEOF
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CExceptionEOF, s: str) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CExceptionEOF, arg0: mrpt.pymrpt.mrpt.serialization.CExceptionEOF) -> None
 
3. __init__(self: mrpt.pymrpt.mrpt.serialization.CExceptionEOF, arg0: mrpt.pymrpt.mrpt.serialization.CExceptionEOF) -> None
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CExceptionEOF, : mrpt.pymrpt.mrpt.serialization.CExceptionEOF) -> mrpt.pymrpt.mrpt.serialization.CExceptionEOF
 
C++: mrpt::serialization::CExceptionEOF::operator=(const class mrpt::serialization::CExceptionEOF &) --> class mrpt::serialization::CExceptionEOF &

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CMessage(pybind11_builtins.pybind11_object)
    A class that contain generic messages, that can be sent and received from a
"CClientTCPSocket" object.
 A message consists of a "header" (or type), and a "body" (or content).
 Apart from arbitrary data, specific methods are provided for easing the
serialization of MRPT's "CSerializable" objects.
 This class is also used for passing data to hardware interfaces (see
mrpt::comms::CSerialPort)
 
 
CClientTCPSocket
 
 
Method resolution order:
CMessage
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CMessage) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CMessage, arg0: mrpt.pymrpt.mrpt.serialization.CMessage) -> None
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CMessage, : mrpt.pymrpt.mrpt.serialization.CMessage) -> mrpt.pymrpt.mrpt.serialization.CMessage
 
C++: mrpt::serialization::CMessage::operator=(const class mrpt::serialization::CMessage &) --> class mrpt::serialization::CMessage &
deserializeIntoExistingObject(...)
deserializeIntoExistingObject(self: mrpt.pymrpt.mrpt.serialization.CMessage, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
A method that parse the data in the message into an existing object.
  Note that the class of the object must be known and must match the one
 of the serialized object.
  std::exception On corrupt data, unknown serialized objects,
 unknown serialized object version, non-matching classes,...
 
C++: mrpt::serialization::CMessage::deserializeIntoExistingObject(class mrpt::serialization::CSerializable *) --> void
deserializeIntoNewObject(...)
deserializeIntoNewObject(self: mrpt.pymrpt.mrpt.serialization.CMessage, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
A method that parse the data in the message into a new object of (a
 priori) unknown class.
  The pointer will contain on return a copy of the reconstructed object.
 Deleting this object when
   no longer required is the responsability of the user. Note that
 previous contents of the pointer
   will be ignored (it should be nullptr).
  std::exception On corrupt data, unknown serialized objects,
 unknown serialized object version,...
 
C++: mrpt::serialization::CMessage::deserializeIntoNewObject(class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> void
getContentAsString(...)
getContentAsString(self: mrpt.pymrpt.mrpt.serialization.CMessage, str: str) -> None
 
Gets the contents of the message as a string
 
 
 setContentFromString
 
C++: mrpt::serialization::CMessage::getContentAsString(std::string &) --> void
serializeObject(...)
serializeObject(self: mrpt.pymrpt.mrpt.serialization.CMessage, obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
A method for serializing a MRPT's object into the content.
  Any modification to data in "content" after this will corrupt the
 object serialization.
  Member "type" is unmodified in this method.
 
C++: mrpt::serialization::CMessage::serializeObject(const class mrpt::serialization::CSerializable *) --> void
setContentFromString(...)
setContentFromString(self: mrpt.pymrpt.mrpt.serialization.CMessage, str: str) -> None
 
Sets the contents of the message from a string
 
 
 getContentAsString
 
C++: mrpt::serialization::CMessage::setContentFromString(const std::string &) --> void

Data descriptors defined here:
content
type

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class CSerializable(mrpt.pymrpt.mrpt.rtti.CObject)
    The virtual base class which provides a unified interface for all persistent
objects in MRPT.
  Many important properties of this class are inherited from
mrpt::rtti::CObject.
 Refer to the library tutorial: 
 
 
 CArchive
 
 
Method resolution order:
CSerializable
mrpt.pymrpt.mrpt.rtti.CObject
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
GetRuntimeClass(...)
GetRuntimeClass(self: mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId
 
C++: mrpt::serialization::CSerializable::GetRuntimeClass() const --> const struct mrpt::rtti::TRuntimeClassId *
__init__(...)
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(self: mrpt.pymrpt.mrpt.serialization.CSerializable, arg0: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
2. __init__(self: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
assign(...)
assign(self: mrpt.pymrpt.mrpt.serialization.CSerializable, : mrpt.pymrpt.mrpt.serialization.CSerializable) -> mrpt.pymrpt.mrpt.serialization.CSerializable
 
C++: mrpt::serialization::CSerializable::operator=(const class mrpt::serialization::CSerializable &) --> class mrpt::serialization::CSerializable &

Static methods defined here:
GetRuntimeClassIdStatic(...) from builtins.PyCapsule
GetRuntimeClassIdStatic() -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId
 
C++: mrpt::serialization::CSerializable::GetRuntimeClassIdStatic() --> const struct mrpt::rtti::TRuntimeClassId &

Methods inherited from mrpt.pymrpt.mrpt.rtti.CObject:
clone(...)
clone(self: mrpt.pymrpt.mrpt.rtti.CObject) -> mrpt.pymrpt.mrpt.rtti.CObject
 
Returns a deep copy (clone) of the object, indepently of its class. 
 
C++: mrpt::rtti::CObject::clone() const --> class mrpt::rtti::CObject *
duplicateGetSmartPtr(...)
duplicateGetSmartPtr(self: mrpt.pymrpt.mrpt.rtti.CObject) -> mrpt.pymrpt.mrpt.rtti.CObject
 
Makes a deep copy of the object and returns a smart pointer to it 
 
C++: mrpt::rtti::CObject::duplicateGetSmartPtr() const --> class std::shared_ptr<class mrpt::rtti::CObject>

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
Functions
       
ObjectToOctetVector(...) method of builtins.PyCapsule instance
ObjectToOctetVector(o: mrpt.pymrpt.mrpt.serialization.CSerializable, out_vector: List[int]) -> None
 
Converts (serializes) an MRPT object into an array of bytes.
 
 
 The object to be serialized.
 
 
 The vector which at return will contain the data. Size will
 be set automatically.
 
 
 OctetVectorToObject, ObjectToString
 
C++: mrpt::serialization::ObjectToOctetVector(const class mrpt::serialization::CSerializable *, class std::vector<unsigned char> &) --> void
OctetVectorToObject(...) method of builtins.PyCapsule instance
OctetVectorToObject(in_data: List[int], obj: mrpt.pymrpt.mrpt.serialization.CSerializable) -> None
 
Converts back (de-serializes) a sequence of binary data into a MRPT object,
 without prior information about the object's class.
 
 
 The serialized input data representing the object.
 
 
 The newly created object will be stored in this smart pointer.
 
 
 None On any internal exception, this function returns a nullptr
 pointer.
 
 
 ObjectToOctetVector, StringToObject
 
C++: mrpt::serialization::OctetVectorToObject(const class std::vector<unsigned char> &, class std::shared_ptr<class mrpt::serialization::CSerializable> &) --> void
archiveFrom(...) method of builtins.PyCapsule instance
archiveFrom(*args, **kwargs)
Overloaded function.
 
1. archiveFrom(s: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZInputStream_t
 
C++: mrpt::serialization::archiveFrom(class mrpt::io::CFileGZInputStream &) --> class mrpt::serialization::CArchiveStreamBase<class mrpt::io::CFileGZInputStream>
 
2. archiveFrom(s: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileGZOutputStream_t
 
C++: mrpt::serialization::archiveFrom(class mrpt::io::CFileGZOutputStream &) --> class mrpt::serialization::CArchiveStreamBase<class mrpt::io::CFileGZOutputStream>
 
3. archiveFrom(s: mrpt.pymrpt.mrpt.io.CFileInputStream) -> mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileInputStream_t
 
C++: mrpt::serialization::archiveFrom(class mrpt::io::CFileInputStream &) --> class mrpt::serialization::CArchiveStreamBase<class mrpt::io::CFileInputStream>
 
4. archiveFrom(s: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> mrpt.pymrpt.mrpt.serialization.CArchiveStreamBase_mrpt_io_CFileOutputStream_t
 
C++: mrpt::serialization::archiveFrom(class mrpt::io::CFileOutputStream &) --> class mrpt::serialization::CArchiveStreamBase<class mrpt::io::CFileOutputStream>