Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Types | Public Member Functions | Protected Member Functions | Private Attributes
mrpt::utils::CFileOutputStream Class Reference

Detailed Description

This CStream derived class allow using a file as a write-only, binary stream.

See also
CStream, CFileStream, CFileGZOutputStream

Definition at line 26 of file CFileOutputStream.h.

#include <mrpt/utils/CFileOutputStream.h>

Inheritance diagram for mrpt::utils::CFileOutputStream:
Inheritance graph

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...
 
 CFileOutputStream (const CFileOutputStream &)=delete
 
CFileOutputStreamoperator= (const CFileOutputStream &)=delete
 
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) override
 Introduces a pure virtual method for moving to a specified position in the streamed resource. More...
 
uint64_t getTotalBytesCount () override
 Method for getting the total number of bytes writen to buffer. More...
 
uint64_t getPosition () 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...
 
void WriteObject (const CSerializable &o)
 
CSerializable::Ptr ReadObject ()
 Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. More...
 
template<typename T >
T::Ptr 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...
 
template<typename... T>
mrpt::utils::variant< T... > ReadVariant ()
 Reads a variant from stream, its class determined at runtime, and returns a variant to the object. More...
 
template<typename T >
void WriteVariant (T t)
 Writes a Variant to the stream. More...
 
template<typename T >
ReadPOD ()
 Reads a simple POD type and returns by value. More...
 
CStreamoperator<< (const CSerializable::Ptr &pObj)
 Write an object to a stream in the binary MRPT format. More...
 
CStreamoperator<< (const CSerializable &obj)
 Write an object to a stream in the binary MRPT format. More...
 
CStreamoperator>> (CSerializable::Ptr &pObj)
 
CStreamoperator>> (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) override
 Introduces a pure virtual method responsible for reading from the stream. More...
 
size_t Write (const void *Buffer, size_t Count) override
 Introduces a pure virtual method responsible for writing to the stream. More...
 
void internal_ReadObject (CSerializable *newObj, const std::string &className, bool isOldFormat, int8_t version)
 Read the object. More...
 
void internal_ReadObjectHeader (std::string &className, bool &isOldFormat, int8_t &version)
 Read the object Header. More...
 

Private Attributes

std::ofstream m_of
 The actual output file stream. More...
 

Member Enumeration Documentation

◆ TSeekOrigin

Used in CStream::Seek.

Enumerator
sFromBeginning 
sFromCurrent 
sFromEnd 

Definition at line 45 of file CStream.h.

Constructor & Destructor Documentation

◆ CFileOutputStream() [1/3]

CFileOutputStream::CFileOutputStream ( const std::string fileName,
bool  append = false 
)

Constructor.

Parameters
fileNameThe file to be open in this stream
appendIf 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.
Exceptions
std::exceptionif the file cannot be opened.

Definition at line 26 of file CFileOutputStream.cpp.

References MRPT_END, MRPT_START, open(), and THROW_EXCEPTION_FMT.

Here is the call graph for this function:

◆ CFileOutputStream() [2/3]

CFileOutputStream::CFileOutputStream ( )

Default constructor.

Definition at line 41 of file CFileOutputStream.cpp.

◆ CFileOutputStream() [3/3]

mrpt::utils::CFileOutputStream::CFileOutputStream ( const CFileOutputStream )
delete

◆ ~CFileOutputStream()

CFileOutputStream::~CFileOutputStream ( )
virtual

Destructor.

Definition at line 68 of file CFileOutputStream.cpp.

References close().

Here is the call graph for this function:

Member Function Documentation

◆ close()

void CFileOutputStream::close ( )

Close the stream.

Definition at line 60 of file CFileOutputStream.cpp.

References m_of.

Referenced by open(), mrpt::obs::CObservationStereoImagesFeatures::saveFeaturesToTextFile(), and ~CFileOutputStream().

Here is the caller graph for this function:

◆ fileOpenCorrectly()

bool CFileOutputStream::fileOpenCorrectly ( )

Returns true if the file was open without errors.

Definition at line 151 of file CFileOutputStream.cpp.

References m_of.

Referenced by mrpt::hwdrivers::CGPSInterface::doProcess(), mrpt::utils::TMatchingPairList::dumpToFile(), getTotalBytesCount(), and is_open().

Here is the caller graph for this function:

◆ getline()

bool CStream::getline ( std::string out_str)
inherited

Reads from the stream until a '
' character is found ('' characters are ignored).

Returns
false on EOF or any other read error.

Definition at line 780 of file CStream.cpp.

◆ getPosition()

uint64_t CFileOutputStream::getPosition ( )
overridevirtual

Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.

Implements mrpt::utils::CStream.

Definition at line 140 of file CFileOutputStream.cpp.

References m_of.

Referenced by getTotalBytesCount(), and Seek().

Here is the caller graph for this function:

◆ getTotalBytesCount()

uint64_t CFileOutputStream::getTotalBytesCount ( )
overridevirtual

Method for getting the total number of bytes writen to buffer.

Implements mrpt::utils::CStream.

Definition at line 127 of file CFileOutputStream.cpp.

References fileOpenCorrectly(), getPosition(), Seek(), and mrpt::utils::CStream::sFromEnd.

Here is the call graph for this function:

◆ internal_ReadObject()

void CStream::internal_ReadObject ( CSerializable newObj,
const std::string className,
bool  isOldFormat,
int8_t  version 
)
protectedinherited

Read the object.

Definition at line 523 of file CStream.cpp.

References SERIALIZATION_END_FLAG, THROW_EXCEPTION, THROW_EXCEPTION_FMT, and THROW_TYPED_EXCEPTION.

Referenced by mrpt::utils::CStream::ReadObject(), and mrpt::utils::CStream::ReadVariant().

Here is the caller graph for this function:

◆ internal_ReadObjectHeader()

void CStream::internal_ReadObjectHeader ( std::string className,
bool &  isOldFormat,
int8_t version 
)
protectedinherited

Read the object Header.

Definition at line 420 of file CStream.cpp.

References ASSERT_, THROW_EXCEPTION, THROW_STACKED_EXCEPTION_CUSTOM_MSG2, and THROW_TYPED_EXCEPTION.

Referenced by mrpt::utils::CStream::ReadObject(), and mrpt::utils::CStream::ReadVariant().

Here is the caller graph for this function:

◆ is_open()

bool mrpt::utils::CFileOutputStream::is_open ( )
inline

Returns true if the file was open without errors.

Definition at line 71 of file CFileOutputStream.h.

References fileOpenCorrectly().

Referenced by mrpt::maps::CRandomFieldGridMap3D::saveAsCSV().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ open()

bool CFileOutputStream::open ( const std::string fileName,
bool  append = false 
)

Open the given file for write.

Parameters
fileNameThe file to be open in this stream
appendIf 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.
See also
fileOpenCorrectly
Returns
true on success.

Definition at line 45 of file CFileOutputStream.cpp.

References close(), and m_of.

Referenced by CFileOutputStream(), mrpt::hwdrivers::CGPSInterface::doProcess(), and mrpt::maps::CRandomFieldGridMap3D::saveAsCSV().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator<<() [1/2]

CStream & CStream::operator<< ( const CSerializable::Ptr pObj)
inherited

Write an object to a stream in the binary MRPT format.

Definition at line 201 of file CStream.cpp.

◆ operator<<() [2/2]

CStream & CStream::operator<< ( const CSerializable obj)
inherited

Write an object to a stream in the binary MRPT format.

Definition at line 208 of file CStream.cpp.

◆ operator=()

CFileOutputStream& mrpt::utils::CFileOutputStream::operator= ( const CFileOutputStream )
delete

◆ operator>>() [1/2]

CStream & CStream::operator>> ( CSerializable::Ptr pObj)
inherited

Definition at line 214 of file CStream.cpp.

◆ operator>>() [2/2]

CStream & CStream::operator>> ( CSerializable obj)
inherited

Definition at line 220 of file CStream.cpp.

◆ printf()

int CStream::printf ( const char *  fmt,
  ... 
)
virtualinherited

Writes a string to the stream in a textual form.

See also
CStdOutStream

Definition at line 597 of file CStream.cpp.

References MRPT_END, MRPT_START, and vsnprintf.

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), mrpt::utils::TMatchingPairList::dumpToFile(), mrpt::obs::gnss::Message_NMEA_GGA::dumpToStream(), mrpt::obs::gnss::Message_TOPCON_PZS::dumpToStream(), mrpt::obs::gnss::Message_TOPCON_SATS::dumpToStream(), mrpt::obs::gnss::Message_NMEA_GLL::dumpToStream(), mrpt::obs::gnss::Message_NMEA_RMC::dumpToStream(), mrpt::obs::gnss::Message_NV_OEM6_GENERIC_FRAME::dumpToStream(), mrpt::obs::CObservationGPS::dumpToStream(), mrpt::obs::gnss::Message_NMEA_VTG::dumpToStream(), mrpt::obs::gnss::Message_NV_OEM6_GENERIC_SHORT_FRAME::dumpToStream(), mrpt::obs::gnss::Message_NMEA_ZDA::dumpToStream(), mrpt::obs::gnss::Message_NV_OEM6_RANGECMP::dumpToStream(), mrpt::obs::gnss::Message_NV_OEM6_VERSION::dumpToStream(), mrpt::slam::TKLDParams::dumpToTextStream(), mrpt::slam::CMetricMapBuilderICP::TConfigParams::dumpToTextStream(), mrpt::maps::TMetricMapInitializer::dumpToTextStream(), mrpt::slam::CIncrementalMapPartitioner::TOptions::dumpToTextStream(), mrpt::maps::CGasConcentrationGridMap2D::TInsertionOptions::dumpToTextStream(), mrpt::maps::CWirelessPowerGridMap2D::TInsertionOptions::dumpToTextStream(), mrpt::maps::CHeightGridMap2D_MRF::TInsertionOptions::dumpToTextStream(), mrpt::hmtslam::CTopLCDetector_FabMap::TOptions::dumpToTextStream(), mrpt::hmtslam::CTopLCDetector_GridMatching::TOptions::dumpToTextStream(), mrpt::graphslam::TUncertaintyPath< GRAPH_T >::dumpToTextStream(), mrpt::maps::CReflectivityGridMap2D::TInsertionOptions::dumpToTextStream(), mrpt::slam::CICP::TConfigParams::dumpToTextStream(), mrpt::slam::CGridMapAligner::TConfigParams::dumpToTextStream(), mrpt::graphslam::TSlidingWindow::dumpToTextStream(), mrpt::slam::CMetricMapBuilderRBPF::TConstructionOptions::dumpToTextStream(), mrpt::bayes::TKF_options::dumpToTextStream(), mrpt::utils::CLoadableOptions::dumpToTextStream(), mrpt::graphslam::deciders::CIncrementalNodeRegistrationDecider< GRAPH_T >::TParams::dumpToTextStream(), mrpt::vision::CFeatureExtraction::TOptions::dumpToTextStream(), mrpt::maps::CHeightGridMap2D::TInsertionOptions::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::dumpToTextStream(), mrpt::slam::CRangeBearingKFSLAM2D::TOptions::dumpToTextStream(), mrpt::maps::CBeaconMap::TLikelihoodOptions::dumpToTextStream(), mrpt::maps::CMultiMetricMapPDF::TPredictionParams::dumpToTextStream(), mrpt::graphslam::deciders::CFixedIntervalsNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::maps::CRandomFieldGridMap3D::TInsertionOptions::dumpToTextStream(), mrpt::maps::CBeaconMap::TInsertionOptions::dumpToTextStream(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::slam::CRangeBearingKFSLAM::TOptions::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::OptimizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::maps::CPointsMap::TInsertionOptions::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::GraphVisualizationParams::dumpToTextStream(), mrpt::maps::CLandmarksMap::TInsertionOptions::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream(), mrpt::vision::TStereoSystemParams::dumpToTextStream(), mrpt::maps::CColouredPointsMap::TColourOptions::dumpToTextStream(), mrpt::maps::CPointsMap::TLikelihoodOptions::dumpToTextStream(), mrpt::vision::CFeature::dumpToTextStream(), mrpt::maps::TSetOfMetricMapInitializers::dumpToTextStream(), mrpt::maps::CLandmarksMap::TLikelihoodOptions::dumpToTextStream(), mrpt::hmtslam::CHMTSLAM::TOptions::dumpToTextStream(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLaserParams::dumpToTextStream(), mrpt::vision::TMatchingOptions::dumpToTextStream(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLoopClosureParams::dumpToTextStream(), mrpt::maps::COccupancyGridMap2D::TInsertionOptions::dumpToTextStream(), mrpt::maps::COccupancyGridMap2D::TLikelihoodOptions::dumpToTextStream(), mrpt::vision::TMultiResDescMatchOptions::dumpToTextStream(), mrpt::vision::TMultiResDescOptions::dumpToTextStream(), mrpt::maps::CWirelessPowerGridMap2D::TMapDefinition::dumpToTextStream_map_specific(), mrpt::maps::CHeightGridMap2D_MRF::TMapDefinition::dumpToTextStream_map_specific(), mrpt::maps::CHeightGridMap2D::TMapDefinition::dumpToTextStream_map_specific(), mrpt::maps::CGasConcentrationGridMap2D::TMapDefinition::dumpToTextStream_map_specific(), mrpt::maps::CLandmarksMap::TMapDefinition::dumpToTextStream_map_specific(), mrpt::utils::CLoadableOptions::dumpVar_bool(), mrpt::utils::CLoadableOptions::dumpVar_double(), mrpt::utils::CLoadableOptions::dumpVar_float(), mrpt::utils::CLoadableOptions::dumpVar_int(), mrpt::utils::CLoadableOptions::dumpVar_string(), generic_dump_BESTPOS(), generic_dump_MARKTIME(), mrpt::maps::CRandomFieldGridMap2D::TInsertionOptionsCommon::internal_dumpToTextStream_common(), mrpt::slam::CRangeBearingKFSLAM2D::OnGetObservationsAndDataAssociation(), mrpt::utils::CStream::printf_vector(), mrpt::maps::CRandomFieldGridMap3D::saveAsCSV(), mrpt::poses::CPoseInterpolatorBase< 3 >::saveInterpolatedToTextFile(), mrpt::utils::CTimeLogger::saveToCSVFile(), and mrpt::poses::CPoseInterpolatorBase< 3 >::saveToTextFile().

◆ printf_vector()

template<typename CONTAINER_TYPE >
virtual int void mrpt::utils::CStream::printf_vector ( const char *  fmt,
const CONTAINER_TYPE &  V,
char  separator = ',' 
)
inlineinherited

Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T.

Template Parameters
CONTAINER_TYPEcan be any vector<T>, deque<T> or alike.

Definition at line 370 of file CStream.h.

References mrpt::utils::CStream::printf().

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Read()

size_t CFileOutputStream::Read ( void Buffer,
size_t  Count 
)
overrideprotectedvirtual

Introduces a pure virtual method responsible for reading from the stream.

Implements mrpt::utils::CStream.

Definition at line 74 of file CFileOutputStream.cpp.

References MRPT_UNUSED_PARAM, and THROW_EXCEPTION.

◆ ReadAsAndCastTo()

template<typename STORED_TYPE , typename CAST_TO_TYPE >
void mrpt::utils::CStream::ReadAsAndCastTo ( CAST_TO_TYPE &  read_here)
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 353 of file CStream.h.

◆ ReadBuffer()

size_t CStream::ReadBuffer ( void Buffer,
size_t  Count 
)
inherited

Reads a block of bytes from the stream into Buffer.

Exceptions
std::exceptionOn any error, or if ZERO bytes are read.
Returns
The amound of bytes actually read.
Note
This method is endianness-dependent.
See also
ReadBufferImmediate ; Important, see: ReadBufferFixEndianness,

Definition at line 40 of file CStream.cpp.

References ASSERT_, and THROW_EXCEPTION.

Referenced by mrpt::hwdrivers::CHokuyoURG::assureBufferHasBytes(), mrpt::compress::zip::compress_gz_data_block(), mrpt::compress::zip::decompress(), mrpt::compress::zip::decompress_gz_file(), mrpt::hwdrivers::CGPSInterface::doProcess(), fill_input_buffer(), mrpt::system::loadBinaryFile(), mrpt::utils::CMemoryStream::loadBufferFromFile(), mrpt::hwdrivers::CHokuyoURG::purgeBuffers(), mrpt::utils::CStream::ReadBufferFixEndianness(), and mrpt::utils::CStream::ReadBufferImmediate().

Here is the caller graph for this function:

◆ ReadBufferFixEndianness()

template<typename T >
size_t mrpt::utils::CStream::ReadBufferFixEndianness ( T *  ptr,
size_t  ElementCount 
)
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.

Parameters
ElementCountThe number of elements (not bytes) to read.
ptrA pointer to the first output element in an array (or std::vector<>, etc...).
Returns
The amound of bytes (not elements) actually read (under error situations, the last element may be invalid if the data stream abruptly ends). Example of usage:
s >> N;
vector<float> vec(N);
if (N)
s.ReadBufferFixEndianness<float>(&vec[0],N);
Exceptions
std::exceptionOn any error, or if ZERO bytes are read.
See also
ReadBufferFixEndianness, ReadBuffer

Definition at line 108 of file CStream.h.

References mrpt::utils::CStream::ReadBuffer(), and mrpt::mrpt::utils::reverseBytesInPlace().

Referenced by mrpt::math::operator>>(), mrpt::utils::CStream::ReadPOD(), and triangle_readFromStream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadBufferImmediate()

virtual size_t mrpt::utils::CStream::ReadBufferImmediate ( void Buffer,
size_t  Count 
)
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.

Exceptions
std::exceptionOn any error, or if ZERO bytes are read.

Reimplemented in mrpt::comms::CInterfaceFTDI.

Definition at line 129 of file CStream.h.

References mrpt::utils::CStream::ReadBuffer().

Here is the call graph for this function:

◆ ReadObject() [1/3]

CSerializable::Ptr mrpt::utils::CStream::ReadObject ( )
inlineinherited

Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object.

Exceptions
std::exceptionOn I/O error or undefined class.
mrpt::utils::CExceptionEOFOn 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.

Definition at line 207 of file CStream.h.

Referenced by mrpt::utils::mrpt_recv_from_zmq(), mrpt::utils::mrpt_recv_from_zmq_into(), mrpt::utils::OctetVectorToObject(), mrpt::utils::operator>>(), mrpt::nav::CAbstractPTGBasedReactive::performNavigationStep(), mrpt::utils::RawStringToObject(), mrpt::utils::StringToObject(), and TEST().

Here is the caller graph for this function:

◆ ReadObject() [2/3]

template<typename T >
T::Ptr mrpt::utils::CStream::ReadObject ( )
inlineinherited

Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object.

This version is similar to mrpt::make_aligned_shared<T>.

Exceptions
std::exceptionOn I/O error or undefined class.
mrpt::utils::CExceptionEOFOn 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.

Definition at line 217 of file CStream.h.

References mrpt::utils::TRuntimeClassId::createObject(), mrpt::utils::findRegisteredClass(), mrpt::utils::CStream::internal_ReadObject(), and mrpt::utils::CStream::internal_ReadObjectHeader().

Here is the call graph for this function:

◆ ReadObject() [3/3]

void CStream::ReadObject ( CSerializable existingObj)
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.

Exceptions
std::exceptionOn I/O error or different class found.
mrpt::utils::CExceptionEOFOn 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.

Definition at line 566 of file CStream.cpp.

References ASSERT_, mrpt::utils::TRuntimeClassId::className, mrpt::utils::findRegisteredClass(), mrpt::format(), mrpt::utils::CSerializable::GetRuntimeClass(), THROW_EXCEPTION, and THROW_EXCEPTION_FMT.

Here is the call graph for this function:

◆ ReadPOD()

template<typename T >
T mrpt::utils::CStream::ReadPOD ( )
inlineinherited

Reads a simple POD type and returns by value.

Useful when stream >> var; cannot be used becuase of errors of misaligned reference binding. Use with macro MRPT_READ_POD to avoid typing the type T yourself.

Note
[New in MRPT 2.0.0]
Write operator s << var; is safe for misaligned variables.

Definition at line 325 of file CStream.h.

References mrpt::utils::CStream::ReadBufferFixEndianness().

Here is the call graph for this function:

◆ ReadVariant()

template<typename... T>
mrpt::utils::variant<T...> mrpt::utils::CStream::ReadVariant ( )
inlineinherited

Reads a variant from stream, its class determined at runtime, and returns a variant to the object.

To be compatible with the current polymorphic system this support smart pointer types. For pointer types, This will bind to the first possible pointer type. variant<CSerializable::Ptr, CRenderizable::Ptr>

Exceptions
std::exceptionOn I/O error or undefined class.
mrpt::utils::CExceptionEOFOn 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.

Definition at line 282 of file CStream.h.

References mrpt::utils::TRuntimeClassId::createObject(), mrpt::utils::findRegisteredClass(), mrpt::utils::CStream::internal_ReadObject(), mrpt::utils::CStream::internal_ReadObjectHeader(), mrpt::utils::CStream::ReadVariant_helper(), and THROW_EXCEPTION_FMT.

Referenced by mrpt::utils::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ receiveMessage()

bool CStream::receiveMessage ( utils::CMessage msg)
inherited

◆ Seek()

uint64_t CFileOutputStream::Seek ( uint64_t  Offset,
CStream::TSeekOrigin  Origin = sFromBeginning 
)
overridevirtual

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.
    Returns
    Seek returns the new value of the Position property.

Implements mrpt::utils::CStream.

Definition at line 98 of file CFileOutputStream.cpp.

References getPosition(), m_of, mrpt::utils::CStream::sFromBeginning, mrpt::utils::CStream::sFromCurrent, mrpt::utils::CStream::sFromEnd, and THROW_EXCEPTION.

Referenced by getTotalBytesCount().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sendMessage()

void CStream::sendMessage ( const utils::CMessage msg)
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:

<START_FLAG> <HEADER> <LENGTH> <BODY> <END_FLAG>
<START_FLAG> = 0x69
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 4

For frames of size > 255 the frame format is an array of bytes in this order:

<START_FLAG> <HEADER> <HIBYTE(LENGTH)> <LOBYTE(LENGTH)> <BODY>
<END_FLAG>
<START_FLAG> = 0x79
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 5
Exceptions
std::exceptionOn communication errors

Definition at line 649 of file CStream.cpp.

References mrpt::utils::CMessage::content, mrpt::system::os::memcpy(), MRPT_END, MRPT_START, and mrpt::utils::CMessage::type.

Referenced by mrpt::hwdrivers::CServoeNeck::disableServo(), mrpt::hwdrivers::CServoeNeck::enableServo(), mrpt::hwdrivers::CRoboticHeadInterface::Get3SoundBuffer(), mrpt::hwdrivers::CRoboticHeadInterface::GetGain(), mrpt::hwdrivers::CServoeNeck::getRegisterValue(), mrpt::hwdrivers::CRoboticHeadInterface::GetSoundLocation(), mrpt::hwdrivers::CServoeNeck::queryFirmwareVersion(), mrpt::hwdrivers::CBoardENoses::queryFirmwareVersion(), mrpt::hwdrivers::CRoboticHeadInterface::SetGain(), mrpt::hwdrivers::CServoeNeck::setRegisterValue(), and mrpt::hwdrivers::CServoeNeck::setRegisterValueAndSpeed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Write()

size_t CFileOutputStream::Write ( const void Buffer,
size_t  Count 
)
overrideprotectedvirtual

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.

Definition at line 85 of file CFileOutputStream.cpp.

References m_of.

◆ WriteBuffer()

void CStream::WriteBuffer ( const void Buffer,
size_t  Count 
)
inherited

Writes a block of bytes to the stream from Buffer.

Exceptions
std::exceptionOn any error
See also
Important, see: WriteBufferFixEndianness
Note
This method is endianness-dependent.

Definition at line 64 of file CStream.cpp.

References ASSERT_, and THROW_EXCEPTION.

Referenced by mrpt::compress::zip::compress(), mrpt::utils::CMessage::deserializeIntoExistingObject(), mrpt::utils::CMessage::deserializeIntoNewObject(), mrpt::hwdrivers::CHokuyoURG::displaySensorInfo(), mrpt::hwdrivers::CHokuyoURG::displayVersionInfo(), mrpt::hwdrivers::CNTRIPEmitter::doProcess(), mrpt::hwdrivers::CGPSInterface::doProcess(), empty_output_buffer(), mrpt::hwdrivers::CHokuyoURG::enableSCIP20(), mrpt::hwdrivers::CGPSInterface::implement_parser_NOVATEL_OEM6(), mrpt::obs::gnss::Message_NV_OEM6_GENERIC_FRAME::internal_writeToStream(), mrpt::obs::gnss::Message_NV_OEM6_GENERIC_SHORT_FRAME::internal_writeToStream(), mrpt::obs::gnss::Message_NV_OEM6_RANGECMP::internal_writeToStream(), mrpt::obs::gnss::Message_NV_OEM6_VERSION::internal_writeToStream(), mrpt::utils::mrpt_recv_from_zmq_buf(), mrpt::utils::ObjectToString(), mrpt::hwdrivers::CGPSInterface::OnConnectionEstablished(), mrpt::hwdrivers::CGPSInterface::OnConnectionShutdown(), mrpt::utils::operator<<(), mrpt::utils::CMemoryStream::saveBufferToFile(), mrpt::hwdrivers::CGPSInterface::sendCustomCommand(), mrpt::hwdrivers::CBoardENoses::setActiveChamber(), mrpt::hwdrivers::CHokuyoURG::setHighBaudrate(), mrpt::hwdrivers::CHokuyoURG::setHighSensitivityMode(), mrpt::hwdrivers::CHokuyoURG::setMotorSpeed(), mrpt::hwdrivers::CHokuyoURG::startScanningMode(), mrpt::utils::StringToObject(), mrpt::hwdrivers::CHokuyoURG::switchLaserOff(), mrpt::hwdrivers::CHokuyoURG::switchLaserOn(), term_destination(), mrpt::system::vectorToBinaryFile(), mrpt::utils::CStream::WriteBufferFixEndianness(), mrpt::nav::CLogFileRecord::writeToStream(), mrpt::maps::CGasConcentrationGridMap2D::writeToStream(), mrpt::maps::CWirelessPowerGridMap2D::writeToStream(), mrpt::maps::CHeightGridMap2D_MRF::writeToStream(), mrpt::maps::CReflectivityGridMap2D::writeToStream(), mrpt::obs::CObservation2DRangeScan::writeToStream(), mrpt::maps::COccupancyGridMap2D::writeToStream(), mrpt::obs::CObservationVelodyneScan::writeToStream(), mrpt::maps::CRandomFieldGridMap3D::writeToStream(), mrpt::utils::CImage::writeToStream(), and mrpt::opengl::CRenderizable::writeToStreamRender().

Here is the caller graph for this function:

◆ WriteBufferFixEndianness()

template<typename T >
void mrpt::utils::CStream::WriteBufferFixEndianness ( const T *  ptr,
size_t  ElementCount 
)
inlineinherited

Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness).

Parameters
ElementCountThe number of elements (not bytes) to write.
ptrA 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);
Exceptions
std::exceptionOn any error
See also
WriteBuffer

Definition at line 159 of file CStream.h.

References mrpt::utils::CStream::WriteBuffer().

Referenced by mrpt::math::operator<<(), triangle_writeToStream(), mrpt::math::CMatrix::writeToStream(), mrpt::math::CMatrixD::writeToStream(), mrpt::maps::CWeightedPointsMap::writeToStream(), mrpt::maps::CColouredPointsMap::writeToStream(), mrpt::maps::CSimplePointsMap::writeToStream(), mrpt::obs::CObservation2DRangeScan::writeToStream(), mrpt::maps::COccupancyGridMap2D::writeToStream(), and mrpt::obs::CObservation3DRangeScan::writeToStream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteObject() [1/2]

void CStream::WriteObject ( const CSerializable o)
inherited

◆ WriteObject() [2/2]

void mrpt::utils::CStream::WriteObject ( const CSerializable o)
inlineinherited

Definition at line 198 of file CStream.h.

References mrpt::utils::CStream::WriteObject().

Referenced by mrpt::utils::CStream::WriteObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteVariant()

template<typename T >
void mrpt::utils::CStream::WriteVariant ( t)
inlineinherited

Writes a Variant to the stream.

Definition at line 312 of file CStream.h.

References mrpt::utils::CStream::WriteObject().

Here is the call graph for this function:

Member Data Documentation

◆ m_of

std::ofstream mrpt::utils::CFileOutputStream::m_of
private

The actual output file stream.

Definition at line 34 of file CFileOutputStream.h.

Referenced by close(), fileOpenCorrectly(), getPosition(), open(), Seek(), and Write().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019