This CStream derived class allow using a file as a write-only, binary stream.
Definition at line 25 of file CFileOutputStream.h.
#include <mrpt/utils/CFileOutputStream.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |
CFileOutputStream (const std::string &fileName, bool append=false) | |
Constructor. More... | |
CFileOutputStream () | |
Default constructor. More... | |
bool | open (const std::string &fileName, bool append=false) |
Open the given file for write. More... | |
void | close () |
Close the stream. More... | |
virtual | ~CFileOutputStream () |
Destructor. More... | |
bool | fileOpenCorrectly () |
Returns true if the file was open without errors. More... | |
bool | is_open () |
Returns true if the file was open without errors. More... | |
uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning) MRPT_OVERRIDE |
Introduces a pure virtual method for moving to a specified position in the streamed resource. More... | |
uint64_t | getTotalBytesCount () MRPT_OVERRIDE |
Method for getting the total number of bytes writen to buffer. More... | |
uint64_t | getPosition () MRPT_OVERRIDE |
Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one. More... | |
size_t | ReadBuffer (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer. More... | |
template<typename T > | |
size_t | ReadBufferFixEndianness (T *ptr, size_t ElementCount) |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. More... | |
virtual size_t | ReadBufferImmediate (void *Buffer, size_t Count) |
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). More... | |
void | WriteBuffer (const void *Buffer, size_t Count) |
Writes a block of bytes to the stream from Buffer. More... | |
template<typename T > | |
void | WriteBufferFixEndianness (const T *ptr, size_t ElementCount) |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). More... | |
void | WriteObject (const CSerializable *o) |
Writes an object to the stream. More... | |
CSerializablePtr | ReadObject () |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. More... | |
void | ReadObject (CSerializable *existingObj) |
Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. More... | |
CStream & | operator<< (const CSerializablePtr &pObj) |
Write an object to a stream in the binary MRPT format. More... | |
CStream & | operator<< (const CSerializable &obj) |
Write an object to a stream in the binary MRPT format. More... | |
CStream & | operator>> (CSerializablePtr &pObj) |
CStream & | operator>> (CSerializable &obj) |
template<typename STORED_TYPE , typename CAST_TO_TYPE > | |
void | ReadAsAndCastTo (CAST_TO_TYPE &read_here) |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast. More... | |
virtual int | printf (const char *fmt,...) MRPT_printf_format_check(2 |
Writes a string to the stream in a textual form. More... | |
template<typename CONTAINER_TYPE > | |
virtual int void | printf_vector (const char *fmt, const CONTAINER_TYPE &V, char separator=',') |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T . More... | |
void | sendMessage (const utils::CMessage &msg) |
Send a message to the device. More... | |
bool | receiveMessage (utils::CMessage &msg) |
Tries to receive a message from the device. More... | |
bool | getline (std::string &out_str) |
Reads from the stream until a ' ' character is found ('' characters are ignored). More... | |
Protected Member Functions | |
size_t | Read (void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for reading from the stream. More... | |
size_t | Write (const void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for writing to the stream. More... | |
template<bool EXISTING_OBJ> | |
void | internal_ReadObject (CSerializablePtr &newObj, CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() More... | |
Private Attributes | |
std::ofstream | m_of |
The actual output file stream. More... | |
|
inherited |
Used in CStream::Seek.
Enumerator | |
---|---|
sFromBeginning | |
sFromCurrent | |
sFromEnd |
mrpt::utils::CFileOutputStream::CFileOutputStream | ( | const std::string & | fileName, |
bool | append = false |
||
) |
Constructor.
fileName | The file to be open in this stream |
append | If set to true, the file will be opened for writing and the current cursor position set at the end of the file. Otherwise, previous contents will be lost. |
std::exception | if the file cannot be opened. |
mrpt::utils::CFileOutputStream::CFileOutputStream | ( | ) |
Default constructor.
|
virtual |
Destructor.
void mrpt::utils::CFileOutputStream::close | ( | ) |
Close the stream.
bool mrpt::utils::CFileOutputStream::fileOpenCorrectly | ( | ) |
Returns true if the file was open without errors.
|
inherited |
Reads from the stream until a '
' character is found ('' characters are ignored).
|
virtual |
Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.
Implements mrpt::utils::CStream.
|
virtual |
Method for getting the total number of bytes writen to buffer.
Implements mrpt::utils::CStream.
|
protectedinherited |
A common template code for both versions of CStream::ReadObject()
|
inline |
Returns true if the file was open without errors.
Definition at line 62 of file CFileOutputStream.h.
References MRPT_OVERRIDE.
bool mrpt::utils::CFileOutputStream::open | ( | const std::string & | fileName, |
bool | append = false |
||
) |
Open the given file for write.
fileName | The file to be open in this stream |
append | If set to true, the file will be opened for writing and the current cursor position set at the end of the file. Otherwise, previous contents will be lost. |
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
|
inherited |
|
virtualinherited |
Writes a string to the stream in a textual form.
Referenced by mrpt::graphslam::TUncertaintyPath< GRAPH_T >::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::dumpToTextStream(), mrpt::graphslam::deciders::CFixedIntervalsNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::TParams::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::OptimizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::GraphVisualizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLaserParams::dumpToTextStream(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLoopClosureParams::dumpToTextStream().
|
inlineinherited |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T
.
CONTAINER_TYPE | can be any vector<T>, deque<T> or alike. |
|
protectedvirtual |
Introduces a pure virtual method responsible for reading from the stream.
Implements mrpt::utils::CStream.
|
inlineinherited |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast.
Useful for coding backwards compatible de-serialization blocks
Definition at line 194 of file CStream.h.
References MRPT_printf_format_check.
|
inherited |
Reads a block of bytes from the stream into Buffer.
std::exception | On any error, or if ZERO bytes are read. |
|
inlineinherited |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture.
ElementCount | The number of elements (not bytes) to read. |
ptr | A pointer to the first output element in an array (or std::vector<>, etc...). |
std::exception | On any error, or if ZERO bytes are read. |
Definition at line 95 of file CStream.h.
References mrpt::mrpt::utils::reverseBytesInPlace().
Referenced by mrpt::math::operator>>().
|
inlinevirtualinherited |
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. |
Reimplemented in mrpt::hwdrivers::CInterfaceFTDI.
|
inherited |
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. |
mrpt::utils::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. |
Referenced by mrpt::utils::mrpt_recv_from_zmq(), mrpt::utils::mrpt_recv_from_zmq_into(), and mrpt::math::operator>>().
|
inherited |
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. |
mrpt::utils::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. |
|
inherited |
Tries to receive a message from the device.
std::exception | On communication errors |
|
virtual |
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:
Implements mrpt::utils::CStream.
|
inherited |
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 |
|
protectedvirtual |
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.
Implements mrpt::utils::CStream.
|
inherited |
Writes a block of bytes to the stream from Buffer.
std::exception | On any error |
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
|
inlineinherited |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness).
ElementCount | The number of elements (not bytes) to write. |
ptr | A pointer to the first input element in an array (or std::vector<>, etc...). Example of usage: vector<float> vec = ... uint32_t N = vec.size(); s << N if (N) s.WriteBufferFixEndianness<float>(&vec[0],N); |
std::exception | On any error |
Definition at line 139 of file CStream.h.
References mrpt::utils::operator<<(), and mrpt::utils::operator>>().
|
inherited |
Writes an object to the stream.
Referenced by mrpt::utils::mrpt_send_to_zmq().
|
private |
The actual output file stream.
Definition at line 31 of file CFileOutputStream.h.
Page generated by Doxygen 1.8.13 for MRPT 1.5.3 at Mon Oct 30 10:27:08 UTC 2017 |