| | |
- pybind11_builtins.pybind11_object(builtins.object)
-
- CStream
-
- CFileGZInputStream
- CFileGZOutputStream
- CFileInputStream
- CFileOutputStream
- CFileStream
- CMemoryStream
- CPipeBaseEndPoint
-
- CPipeReadEndPoint
- CPipeWriteEndPoint
- CTextFileLinesParser
- OpenMode
class CFileGZInputStream(CStream) |
| |
Transparently opens a compressed "gz" file and reads uncompressed data from
it.
If the file is not a .gz file, it silently reads data from the file.
CFileInputStream
|
| |
- Method resolution order:
- CFileGZInputStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileGZInputStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream, : int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream, : int, : mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
This method is not implemented in this class
C++: mrpt::io::CFileGZInputStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileGZInputStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream, fileName: str) -> None
- checkEOF(...)
- checkEOF(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> bool
Will be true if EOF has been already reached.
C++: mrpt::io::CFileGZInputStream::checkEOF() --> bool
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> None
Closes the file
C++: mrpt::io::CFileGZInputStream::close() --> void
- fileOpenCorrectly(...)
- fileOpenCorrectly(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileGZInputStream::fileOpenCorrectly() const --> bool
- filePathAtUse(...)
- filePathAtUse(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> str
Returns the path of the filename passed to open(), or empty if none.
C++: mrpt::io::CFileGZInputStream::filePathAtUse() const --> std::string
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> int
Method for getting the current cursor position in the compressed,
where 0 is the first byte and TotalBytesCount-1 the last one.
C++: mrpt::io::CFileGZInputStream::getPosition() const --> uint64_t
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> str
C++: mrpt::io::CFileGZInputStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> int
Method for getting the total number of compressed bytes of in the
file (the physical size of the compressed file).
C++: mrpt::io::CFileGZInputStream::getTotalBytesCount() const --> uint64_t
- is_open(...)
- is_open(self: mrpt.pymrpt.mrpt.io.CFileGZInputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileGZInputStream::is_open() --> bool
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CFileGZOutputStream(CStream) |
| |
Saves data to a file and transparently compress the data using the given
compression level.
The generated files are in gzip format ("file.gz").
CFileOutputStream
|
| |
- Method resolution order:
- CFileGZOutputStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileGZOutputStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, : int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, : int, : mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
This method is not implemented in this class
C++: mrpt::io::CFileGZOutputStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileGZOutputStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, arg0: str) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, arg0: str, arg1: mrpt.pymrpt.mrpt.io.OpenMode) -> None
doc
3. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream, fileName: str, mode: mrpt.pymrpt.mrpt.io.OpenMode, compressionLevel: int) -> None
4. __init__(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> None
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> None
Close the file
C++: mrpt::io::CFileGZOutputStream::close() --> void
- fileOpenCorrectly(...)
- fileOpenCorrectly(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileGZOutputStream::fileOpenCorrectly() const --> bool
- filePathAtUse(...)
- filePathAtUse(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> str
Returns the path of the filename passed to open(), or empty if none.
C++: mrpt::io::CFileGZOutputStream::filePathAtUse() const --> std::string
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> int
Method for getting the current cursor position, where 0 is the first
byte and TotalBytesCount-1 the last one.
C++: mrpt::io::CFileGZOutputStream::getPosition() const --> uint64_t
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> str
C++: mrpt::io::CFileGZOutputStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> int
This method is not implemented in this class
C++: mrpt::io::CFileGZOutputStream::getTotalBytesCount() const --> uint64_t
- is_open(...)
- is_open(self: mrpt.pymrpt.mrpt.io.CFileGZOutputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileGZOutputStream::is_open() --> bool
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CFileInputStream(CStream) |
| |
This CStream derived class allow using a file as a read-only, binary stream.
CStream, CFileStream, CFileGZInputStream
|
| |
- Method resolution order:
- CFileInputStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CFileInputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileInputStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CFileInputStream, off: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CFileInputStream, off: int, Origin: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
C++: mrpt::io::CFileInputStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CFileInputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileInputStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CFileInputStream, fileName: str) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> None
- checkEOF(...)
- checkEOF(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> bool
Will be true if EOF has been already reached.
C++: mrpt::io::CFileInputStream::checkEOF() --> bool
- clearError(...)
- clearError(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> None
Resets stream error status bits (e.g. after an EOF)
C++: mrpt::io::CFileInputStream::clearError() --> void
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> None
Close the stream
C++: mrpt::io::CFileInputStream::close() --> void
- fileOpenCorrectly(...)
- fileOpenCorrectly(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileInputStream::fileOpenCorrectly() const --> bool
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> int
C++: mrpt::io::CFileInputStream::getPosition() const --> uint64_t
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> str
C++: mrpt::io::CFileInputStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> int
C++: mrpt::io::CFileInputStream::getTotalBytesCount() const --> uint64_t
- is_open(...)
- is_open(self: mrpt.pymrpt.mrpt.io.CFileInputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileInputStream::is_open() --> bool
- open(...)
- open(self: mrpt.pymrpt.mrpt.io.CFileInputStream, fileName: str) -> bool
Open a file for reading
The file to be open in this stream
true on success.
C++: mrpt::io::CFileInputStream::open(const std::string &) --> bool
- readLine(...)
- readLine(self: mrpt.pymrpt.mrpt.io.CFileInputStream, str: str) -> bool
Reads one string line from the file (until a new-line character)
true if a line has been read, false on EOF or error.
C++: mrpt::io::CFileInputStream::readLine(std::string &) --> bool
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CFileOutputStream(CStream) |
| |
This CStream derived class allow using a file as a write-only, binary
stream.
CStream, CFileStream, CFileGZOutputStream
|
| |
- Method resolution order:
- CFileOutputStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileOutputStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, Offset: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, Offset: int, Origin: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
C++: mrpt::io::CFileOutputStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileOutputStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, arg0: str) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, fileName: str, mode: mrpt.pymrpt.mrpt.io.OpenMode) -> None
3. __init__(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> None
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> None
Close the stream.
C++: mrpt::io::CFileOutputStream::close() --> void
- fileOpenCorrectly(...)
- fileOpenCorrectly(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileOutputStream::fileOpenCorrectly() const --> bool
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> int
Method for getting the current cursor position, where 0 is the first
byte and TotalBytesCount-1 the last one
C++: mrpt::io::CFileOutputStream::getPosition() const --> uint64_t
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> str
C++: mrpt::io::CFileOutputStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> int
Method for getting the total number of bytes written to buffer
C++: mrpt::io::CFileOutputStream::getTotalBytesCount() const --> uint64_t
- is_open(...)
- is_open(self: mrpt.pymrpt.mrpt.io.CFileOutputStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileOutputStream::is_open() --> bool
- open(...)
- open(*args, **kwargs)
Overloaded function.
1. open(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, fileName: str) -> bool
2. open(self: mrpt.pymrpt.mrpt.io.CFileOutputStream, fileName: str, mode: mrpt.pymrpt.mrpt.io.OpenMode) -> bool
C++: mrpt::io::CFileOutputStream::open(const std::string &, const enum mrpt::io::OpenMode) --> bool
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CFileStream(CStream) |
| |
This CStream derived class allow using a file as a read/write binary stream,
creating it if the file didn't exist.
The default behavior can be change to open as read, write, read and
write,... in the constructor.
CStream, CFileInputStream, CFileOutputStrea, CFileGZInputStream
|
| |
- Method resolution order:
- CFileStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CFileStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CFileStream, off: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CFileStream, off: int, org: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
C++: mrpt::io::CFileStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CFileStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CFileStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CFileStream, arg0: str) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.io.CFileStream, fileName: str, mode: int) -> None
3. __init__(self: mrpt.pymrpt.mrpt.io.CFileStream) -> None
- checkEOF(...)
- checkEOF(self: mrpt.pymrpt.mrpt.io.CFileStream) -> bool
Will be true if EOF has been already reached.
C++: mrpt::io::CFileStream::checkEOF() --> bool
- clearError(...)
- clearError(self: mrpt.pymrpt.mrpt.io.CFileStream) -> None
Resets stream error status bits (e.g. after an EOF)
C++: mrpt::io::CFileStream::clearError() --> void
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CFileStream) -> None
Closes the file
C++: mrpt::io::CFileStream::close() --> void
- fileOpenCorrectly(...)
- fileOpenCorrectly(self: mrpt.pymrpt.mrpt.io.CFileStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileStream::fileOpenCorrectly() const --> bool
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CFileStream) -> int
C++: mrpt::io::CFileStream::getPosition() const --> uint64_t
- getPositionI(...)
- getPositionI(self: mrpt.pymrpt.mrpt.io.CFileStream) -> int
The current Input cursor position, where 0 is the first byte
C++: mrpt::io::CFileStream::getPositionI() --> uint64_t
- getPositionO(...)
- getPositionO(self: mrpt.pymrpt.mrpt.io.CFileStream) -> int
The current Input cursor position, where 0 is the first byte
C++: mrpt::io::CFileStream::getPositionO() --> uint64_t
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CFileStream) -> int
C++: mrpt::io::CFileStream::getTotalBytesCount() const --> uint64_t
- is_open(...)
- is_open(self: mrpt.pymrpt.mrpt.io.CFileStream) -> bool
Returns true if the file was open without errors.
C++: mrpt::io::CFileStream::is_open() --> bool
- open(...)
- open(*args, **kwargs)
Overloaded function.
1. open(self: mrpt.pymrpt.mrpt.io.CFileStream, fileName: str) -> bool
2. open(self: mrpt.pymrpt.mrpt.io.CFileStream, fileName: str, mode: int) -> bool
Opens the file, returning true on success.
The file to be open in this stream
The open mode: can be an or'd conbination of different
values.
By default the file is opened for open and write and created if not
found.
C++: mrpt::io::CFileStream::open(const std::string &, int) --> bool
- readLine(...)
- readLine(self: mrpt.pymrpt.mrpt.io.CFileStream, str: str) -> bool
Reads one string line from the file (until a new-line character)
true if a line has been read, false on EOF or error
C++: mrpt::io::CFileStream::readLine(std::string &) --> bool
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CStream) -> str
Returns a human-friendly description of the stream, e.g. a filename.
C++: mrpt::io::CStream::getStreamDescription() const --> std::string
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CMemoryStream(CStream) |
| |
This CStream derived class allow using a memory buffer as a CStream.
This class is useful for storing any required set of variables or objects,
and then read them to other objects, or storing them to a file, for
example.
CStream
|
| |
- Method resolution order:
- CMemoryStream
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CMemoryStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CMemoryStream::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CMemoryStream, Offset: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CMemoryStream, Offset: int, Origin: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
C++: mrpt::io::CMemoryStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CMemoryStream, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CMemoryStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CMemoryStream, data: capsule, nBytesInData: int) -> None
3. __init__(self: mrpt.pymrpt.mrpt.io.CMemoryStream, arg0: mrpt.pymrpt.mrpt.io.CMemoryStream) -> None
4. __init__(self: mrpt.pymrpt.mrpt.io.CMemoryStream, arg0: mrpt.pymrpt.mrpt.io.CMemoryStream) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CMemoryStream, : mrpt.pymrpt.mrpt.io.CMemoryStream) -> mrpt.pymrpt.mrpt.io.CMemoryStream
C++: mrpt::io::CMemoryStream::operator=(const class mrpt::io::CMemoryStream &) --> class mrpt::io::CMemoryStream &
- assignMemoryNotOwn(...)
- assignMemoryNotOwn(self: mrpt.pymrpt.mrpt.io.CMemoryStream, data: capsule, nBytesInData: int) -> None
Initilize the data in the stream from a block of memory which is NEITHER
OWNED NOR COPIED by the object, so it must exist during the whole live of
the object.
After assigning a block of data with this method, the object becomes
"read-only", so further attempts to change the size of the buffer will
raise an exception.
This method resets the write and read positions to the beginning.
C++: mrpt::io::CMemoryStream::assignMemoryNotOwn(const void *, const unsigned long) --> void
- clear(...)
- clear(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> None
Clears the memory buffer.
C++: mrpt::io::CMemoryStream::clear() --> void
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> int
Method for getting the current cursor position, where 0 is the first
byte and TotalBytesCount-1 the last one
C++: mrpt::io::CMemoryStream::getPosition() const --> uint64_t
- getRawBufferData(...)
- getRawBufferData(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> capsule
Method for getting a pointer to the raw stored data. The lenght in bytes
is given by getTotalBytesCount
C++: mrpt::io::CMemoryStream::getRawBufferData() --> void *
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> str
C++: mrpt::io::CMemoryStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CMemoryStream) -> int
Returns the total size of the internal buffer
C++: mrpt::io::CMemoryStream::getTotalBytesCount() const --> uint64_t
- loadBufferFromFile(...)
- loadBufferFromFile(self: mrpt.pymrpt.mrpt.io.CMemoryStream, file_name: str) -> bool
Loads the entire buffer from a file
true on success
C++: mrpt::io::CMemoryStream::loadBufferFromFile(const std::string &) --> bool
- saveBufferToFile(...)
- saveBufferToFile(self: mrpt.pymrpt.mrpt.io.CMemoryStream, file_name: str) -> bool
Saves the entire buffer to a file
true on success
C++: mrpt::io::CMemoryStream::saveBufferToFile(const std::string &) --> bool
- setAllocBlockSize(...)
- setAllocBlockSize(self: mrpt.pymrpt.mrpt.io.CMemoryStream, alloc_block_size: int) -> None
Change the size of the additional memory block that is reserved whenever
the current block runs too short (default=0x10000 bytes)
C++: mrpt::io::CMemoryStream::setAllocBlockSize(uint64_t) --> void
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CPipeBaseEndPoint(CStream) |
| |
Common interface of read & write pipe end-points
|
| |
- Method resolution order:
- CPipeBaseEndPoint
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CPipeBaseEndPoint::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int, o: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CPipeBaseEndPoint::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, serialized: str) -> None
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> None
Closes the pipe (normally not needed to be called by users,
automatically done at destructor)
C++: mrpt::io::CPipeBaseEndPoint::close() --> void
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getPosition() const --> uint64_t
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getTotalBytesCount() const --> uint64_t
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> bool
Returns false if the pipe was closed due to some error.
C++: mrpt::io::CPipeBaseEndPoint::isOpen() const --> bool
- serialize(...)
- serialize(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> str
Converts the end-point into a string suitable for reconstruction at a
child process.
This *invalidates* this object, since only one real end-point can exist
at once.
C++: mrpt::io::CPipeBaseEndPoint::serialize() --> std::string
Data descriptors defined here:
- timeout_read_between_us
- timeout_read_start_us
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CStream) -> str
Returns a human-friendly description of the stream, e.g. a filename.
C++: mrpt::io::CStream::getStreamDescription() const --> std::string
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CPipeReadEndPoint(CPipeBaseEndPoint) |
| |
The read end-point in a pipe created with mrpt::synch::CPipe.
Use the method CStream::Read() of the base class CStream
for blocking reading.
|
| |
- Method resolution order:
- CPipeReadEndPoint
- CPipeBaseEndPoint
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CPipeReadEndPoint, Buffer: capsule, Count: int) -> int
Read-only pipe, don't call this method
C++: mrpt::io::CPipeReadEndPoint::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(self: mrpt.pymrpt.mrpt.io.CPipeReadEndPoint, serialized: str) -> None
Methods inherited from CPipeBaseEndPoint:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CPipeBaseEndPoint::Read(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int, o: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> None
Closes the pipe (normally not needed to be called by users,
automatically done at destructor)
C++: mrpt::io::CPipeBaseEndPoint::close() --> void
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getPosition() const --> uint64_t
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getTotalBytesCount() const --> uint64_t
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> bool
Returns false if the pipe was closed due to some error.
C++: mrpt::io::CPipeBaseEndPoint::isOpen() const --> bool
- serialize(...)
- serialize(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> str
Converts the end-point into a string suitable for reconstruction at a
child process.
This *invalidates* this object, since only one real end-point can exist
at once.
C++: mrpt::io::CPipeBaseEndPoint::serialize() --> std::string
Data descriptors inherited from CPipeBaseEndPoint:
- timeout_read_between_us
- timeout_read_start_us
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CStream) -> str
Returns a human-friendly description of the stream, e.g. a filename.
C++: mrpt::io::CStream::getStreamDescription() const --> std::string
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CPipeWriteEndPoint(CPipeBaseEndPoint) |
| |
The write end-point in a pipe created with mrpt::synch::CPipe.
Use the method CStream::Write() of the base class CStream
for blocking writing.
|
| |
- Method resolution order:
- CPipeWriteEndPoint
- CPipeBaseEndPoint
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CPipeWriteEndPoint, Buffer: capsule, Count: int) -> int
Write-only pipe: read launches exception
C++: mrpt::io::CPipeWriteEndPoint::Read(void *, size_t) --> size_t
- __init__(...)
- __init__(self: mrpt.pymrpt.mrpt.io.CPipeWriteEndPoint, serialized: str) -> None
Methods inherited from CPipeBaseEndPoint:
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, of: int, o: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint, Buffer: capsule, Count: int) -> int
C++: mrpt::io::CPipeBaseEndPoint::Write(const void *, size_t) --> size_t
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> None
Closes the pipe (normally not needed to be called by users,
automatically done at destructor)
C++: mrpt::io::CPipeBaseEndPoint::close() --> void
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getPosition() const --> uint64_t
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> int
Without effect in this class
C++: mrpt::io::CPipeBaseEndPoint::getTotalBytesCount() const --> uint64_t
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> bool
Returns false if the pipe was closed due to some error.
C++: mrpt::io::CPipeBaseEndPoint::isOpen() const --> bool
- serialize(...)
- serialize(self: mrpt.pymrpt.mrpt.io.CPipeBaseEndPoint) -> str
Converts the end-point into a string suitable for reconstruction at a
child process.
This *invalidates* this object, since only one real end-point can exist
at once.
C++: mrpt::io::CPipeBaseEndPoint::serialize() --> std::string
Data descriptors inherited from CPipeBaseEndPoint:
- timeout_read_between_us
- timeout_read_start_us
Methods inherited from CStream:
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CStream) -> str
Returns a human-friendly description of the stream, e.g. a filename.
C++: mrpt::io::CStream::getStreamDescription() const --> std::string
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes inherited from CStream:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CStream(pybind11_builtins.pybind11_object) |
| |
This base class is used to provide a unified interface to
files,memory buffers,..Please see the derived classes. This class is
largely inspired by Borland VCL "TStream" class.
Apart of the "VCL like" methods, operators ">>" and "<<" have been
defined so that simple types (int,bool,char,float,char *,std::string,...)
can be directly written and read to and from any CStream easily.
Please, it is recomendable to read CSerializable documentation also.
CFileStream, CMemoryStream,CSerializable
|
| |
- Method resolution order:
- CStream
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- Read(...)
- Read(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Introduces a pure virtual method responsible for reading from the
stream.
C++: mrpt::io::CStream::Read(void *, size_t) --> size_t
- ReadBufferImmediate(...)
- ReadBufferImmediate(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Reads a block of bytes from the stream into Buffer, and returns the
amound of bytes actually read, without waiting for more extra bytes to
arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream
classes but in some hardware-related classes.
std::exception On any error, or if ZERO bytes are read.
C++: mrpt::io::CStream::ReadBufferImmediate(void *, size_t) --> size_t
- Seek(...)
- Seek(*args, **kwargs)
Overloaded function.
1. Seek(self: mrpt.pymrpt.mrpt.io.CStream, Offset: int) -> int
2. Seek(self: mrpt.pymrpt.mrpt.io.CStream, Offset: int, Origin: mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin) -> int
Introduces a pure virtual method for moving to a specified position in
the streamed resource.
he Origin parameter indicates how to interpret the Offset parameter.
Origin should be one of the following values:
- sFromBeginning (Default) Offset is from the beginning of the
resource. Seek moves to the position Offset. Offset must be >= 0.
- sFromCurrent Offset is from the current position in the resource.
Seek moves to Position + Offset.
- sFromEnd Offset is from the end of the resource. Offset must
be
<= 0 to indicate a number of bytes before the end of the file.
Seek returns the new value of the Position property.
C++: mrpt::io::CStream::Seek(int64_t, enum mrpt::io::CStream::TSeekOrigin) --> uint64_t
- Write(...)
- Write(self: mrpt.pymrpt.mrpt.io.CStream, Buffer: capsule, Count: int) -> int
Introduces a pure virtual method responsible for writing to the stream.
Write attempts to write up to Count bytes to Buffer, and returns the
number of bytes actually written.
C++: mrpt::io::CStream::Write(const void *, size_t) --> size_t
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CStream) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CStream, arg0: mrpt.pymrpt.mrpt.io.CStream) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CStream, : mrpt.pymrpt.mrpt.io.CStream) -> mrpt.pymrpt.mrpt.io.CStream
C++: mrpt::io::CStream::operator=(const class mrpt::io::CStream &) --> class mrpt::io::CStream &
- getPosition(...)
- getPosition(self: mrpt.pymrpt.mrpt.io.CStream) -> int
Method for getting the current cursor position, where 0 is the first
byte and TotalBytesCount-1 the last one.
C++: mrpt::io::CStream::getPosition() const --> uint64_t
- getStreamDescription(...)
- getStreamDescription(self: mrpt.pymrpt.mrpt.io.CStream) -> str
Returns a human-friendly description of the stream, e.g. a filename.
C++: mrpt::io::CStream::getStreamDescription() const --> std::string
- getTotalBytesCount(...)
- getTotalBytesCount(self: mrpt.pymrpt.mrpt.io.CStream) -> int
Returns the total amount of bytes in the stream.
C++: mrpt::io::CStream::getTotalBytesCount() const --> uint64_t
- getline(...)
- getline(self: mrpt.pymrpt.mrpt.io.CStream, out_str: str) -> bool
Reads from the stream until a `` character is found (`` characters
are ignored).
false on EOF or any other read error.
C++: mrpt::io::CStream::getline(std::string &) --> bool
Data and other attributes defined here:
- TSeekOrigin = <class 'mrpt.pymrpt.mrpt.io.CStream.TSeekOrigin'>
- sFromBeginning = <TSeekOrigin.sFromBeginning: 0>
- sFromCurrent = <TSeekOrigin.sFromCurrent: 1>
- sFromEnd = <TSeekOrigin.sFromEnd: 2>
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 CTextFileLinesParser(pybind11_builtins.pybind11_object) |
| |
A class for parsing text files, returning each non-empty and non-comment
line, along its line number. Lines are strip out of leading and trailing
whitespaces. By default, lines starting with either "#", "//" or "%" are
skipped as comment lines, unless this behavior is explicitly disabled with
|
| |
- Method resolution order:
- CTextFileLinesParser
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> None
2. __init__(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, filename: str) -> None
3. __init__(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, arg0: mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, : mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> mrpt.pymrpt.mrpt.io.CTextFileLinesParser
C++: mrpt::io::CTextFileLinesParser::operator=(const class mrpt::io::CTextFileLinesParser &) --> class mrpt::io::CTextFileLinesParser &
- close(...)
- close(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> None
Close the file (no need to call it normally, the file is closed upon
destruction)
C++: mrpt::io::CTextFileLinesParser::close() --> void
- enableCommentFilters(...)
- enableCommentFilters(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, filter_MATLAB_comments: bool, filter_C_comments: bool, filter_SH_comments: bool) -> None
Enable/disable filtering of lines starting with "%", "//" or "#",
respectively.
C++: mrpt::io::CTextFileLinesParser::enableCommentFilters(bool, bool, bool) --> void
- getCurrentLineNumber(...)
- getCurrentLineNumber(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> int
Return the line number of the last line returned with
C++: mrpt::io::CTextFileLinesParser::getCurrentLineNumber() const --> size_t
- getNextLine(...)
- getNextLine(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, out_str: str) -> bool
Reads from the file and return the next (non-comment) line, as a
std::string
false on EOF.
C++: mrpt::io::CTextFileLinesParser::getNextLine(std::string &) --> bool
- open(...)
- open(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser, fil: str) -> None
Open a file (an alternative to the constructor with a file name)
C++: mrpt::io::CTextFileLinesParser::open(const std::string &) --> void
- rewind(...)
- rewind(self: mrpt.pymrpt.mrpt.io.CTextFileLinesParser) -> None
Reset the read pointer to the beginning of the file
C++: mrpt::io::CTextFileLinesParser::rewind() --> 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.
|
|