adtf::streaming::ant::cSampleLogEntryList Class Reference

#include <samplelogentrylist.h>

Inherits adtf::streaming::ant::ISampleLog::IGetLogEntryCallback.

Public Member Functions
	cSampleLogEntryList ()
	default CTOR.
	cSampleLogEntryList (const cSampleLogEntryList &oCopyList)
	cSampleLogEntryList (cSampleLogEntryList &&oMoveList)
cSampleLogEntryList &	operator= (const cSampleLogEntryList &oCopyList)
cSampleLogEntryList &	operator= (cSampleLogEntryList &&oMoveList)
virtual	~cSampleLogEntryList ()
	DTOR.
tResult	AddEntry (const ISampleLog::tSampleLogEntry &sEntry)
tResult	GetLogEntries (ISampleLog::IGetLogEntryCallback &pGetCallback) const
tResult	Clear ()
tResult	GetIt (const ISampleLog::tSampleLogEntry &sLogEntry)
tResult	ToStream (ucom::ant::IStream &oOutStream, size_t &szSizeWritten)
tResult	FromStream (const ucom::ant::IStream &oInStream, size_t &szSizeRead)

Protected Attributes
std::list< cSampleLogEntry >	m_lstLogList
	current list of logs

Detailed Description

Helper class to serialize and handle an ISampleLog. Implements the ISampleLog::IGetLogEntryCallback to retrieve the entries of ISampleLog.

Remarks

This implementation is NOT thread safe !

Constructor & Destructor Documentation

cSampleLogEntryList() [1/2]

adtf::streaming::ant::cSampleLogEntryList::cSampleLogEntryList

(

const cSampleLogEntryList &

oCopyList

)

Copy CTOR which will copy the given oCopyList to this list.

Parameters

oCopyList

[in] The list to copy.

cSampleLogEntryList() [2/2]

adtf::streaming::ant::cSampleLogEntryList::cSampleLogEntryList

(

cSampleLogEntryList &&

oMoveList

)

Move CTOR which will move the internal m_List to this list.

Parameters

oMoveList

[in] The list to copy.

Member Function Documentation

AddEntry()

tResult adtf::streaming::ant::cSampleLogEntryList::AddEntry

(

const ISampleLog::tSampleLogEntry &

sEntry

)

Adds an entry to the list. The entry will be copied. (deep copy!)

Parameters

sEntry

[in] The entry to add.

Return values

ERR_NOERROR	entry added successfully.
ERR_NEMORY	additional information buffer can not be copied due to high memory consumption.

Clear()

tResult adtf::streaming::ant::cSampleLogEntryList::Clear

(

)

Clear this list.

Return values

ERR_NOERROR

cleared.

FromStream()

tResult adtf::streaming::ant::cSampleLogEntryList::FromStream	(	const ucom::ant::IStream &	oInStream,
		size_t &	szSizeRead )

Deserializes the internal entry from an input stream. It immediately starts with reading. No Seek call in pInStream.

Parameters

oInStream	[in] The Input Stream where to read the data from.
szSizeRead	[out] Number of bytes read from pInStream.

Returns

Standard result Code.

GetIt()

tResult adtf::streaming::ant::cSampleLogEntryList::GetIt ( const ISampleLog::tSampleLogEntry & sLogEntry )

virtual

Implementation of the ISampleLog::IGetLogEntryCallback to get the entries of a ISampleLog. The entry will be copied. (deep copy!)

Parameters

sLogEntry

[in] The current entry to add.

Return values

ERR_NOERROR	entry added successfully.
ERR_NEMORY	additional information buffer can not be copied due to high memory consumption.

Implements adtf::streaming::ant::ISampleLog::IGetLogEntryCallback.

GetLogEntries()

tResult adtf::streaming::ant::cSampleLogEntryList::GetLogEntries

(

ISampleLog::IGetLogEntryCallback &

pGetCallback

)

const

Copies all entries to the given pGetCallback implementation.

Parameters

pGetCallback

[in] callback interface to call the ISampleLog::IGetLogEntryCallback::GetIt.

Return values

ERR_NOERROR	entry added successfully.
an	error error forwarded from the ISampleLog::IGetLogEntryCallback::GetIt call.

operator=() [1/2]

cSampleLogEntryList & adtf::streaming::ant::cSampleLogEntryList::operator=

(

const cSampleLogEntryList &

oCopyList

)

Copy assignment which will copy the given oCopyList to this list.

Parameters

oCopyList

[in] The list to copy.

Returns

the new entry

operator=() [2/2]

cSampleLogEntryList & adtf::streaming::ant::cSampleLogEntryList::operator=

(

cSampleLogEntryList &&

oMoveList

)

Move assignment which will move the given oCopyList to this list.

Parameters

oMoveList

[in] The list to copy.

Returns

the new entry

ToStream()

tResult adtf::streaming::ant::cSampleLogEntryList::ToStream	(	ucom::ant::IStream &	oOutStream,
		size_t &	szSizeWritten )

Serializes all entries to an output stream. It immediately starts writing. No Seek call in pOutStream.

Parameters

oOutStream	[in] The Output Stream where to write the data to.
szSizeWritten	[out] Number of bytes written to pOutStream.

Returns

Standard result Code.

---

The documentation for this class was generated from the following file:

• src/libraries/streaming3/include/adtfstreaming3/samplelog/samplelogentrylist.h