Devel Lib
Devel::Serializing::IWString< IsHidden, T > Class Template Reference

A class representing a wide string value for serialization. More...

#include <SerializableWString.h>

Inheritance diagram for Devel::Serializing::IWString< IsHidden, T >:
Collaboration diagram for Devel::Serializing::IWString< IsHidden, T >:

Public Member Functions

SCompareData compareData () const override
 Retrieves the compare data for the wide string value. More...
 
 CreateSerializeOperators (T, IsHidden)
 
- Public Member Functions inherited from Devel::Serializing::IData< std::wstring, false >
virtual ~IData ()=default
 Default destructor.
 
bool doSerialize (IO::CWriteStream &i_oStream) const
 Serializes the data to a write stream. More...
 
bool doDeserialize (IO::CReadStream &i_oStream)
 Deserializes the data from a read stream. More...
 
bool doDeserialize (const char *i_szString)
 Deserializes the data from a string. More...
 
bool doDeserialize (std::vector< std::string >::const_iterator &i_oIt, const std::vector< std::string >::const_iterator &i_oItEnd)
 Deserializes the data from a range of strings. More...
 
virtual size_t size () const
 Returns the size of the data. More...
 
virtual bool isHidden () const
 Returns whether the field is hidden. More...
 
auto begin () const
 Returns an iterator pointing to the beginning of the value. More...
 
auto end () const
 Returns an iterator pointing to the end of the value. More...
 
auto & operator[] (const size_t i_nIndex)
 Returns a reference to the value at the specified index. More...
 
const auto & operator[] (const size_t i_nIndex) const
 Returns a const reference to the value at the specified index. More...
 
 SerializerEnableIfNotArithmetic (IData< std::wstring > &) operator--()
 Pre-decrement operator. More...
 
 SerializerEnableIfNotArithmetic (IData< std::wstring > &) operator--(int)
 Post-decrement operator. More...
 
 SerializerEnableIfNotArithmetic (IData< std::wstring > &) operator++()
 Pre-increment operator. More...
 
 SerializerEnableIfNotArithmetic (IData< std::wstring > &) operator++(int)
 Post-increment operator. More...
 
- Public Member Functions inherited from Devel::Serializing::IValue< T >
template<typename ... TArgs, std::enable_if_t< std::is_constructible_v< T, TArgs... >> * = nullptr>
 IValue (TArgs... i_tArgs)
 Constructs an IValue object with the specified arguments. More...
 
const T & value () const
 Returns the value. More...
 
T & value ()
 Returns a reference to the value. More...
 

Additional Inherited Members

- Protected Attributes inherited from Devel::Serializing::IValue< T >
m_tValue
 The value.
 

Detailed Description

template<bool IsHidden = false, typename T = std::wstring>
class Devel::Serializing::IWString< IsHidden, T >

A class representing a wide string value for serialization.

This class specializes the IData class for wide string values.

Template Parameters
IsHiddenFlag indicating whether the field is hidden during serialization.
TThe underlying type of the wide string value.

Member Function Documentation

◆ compareData()

template<bool IsHidden = false, typename T = std::wstring>
SCompareData Devel::Serializing::IWString< IsHidden, T >::compareData ( ) const
inlineoverridevirtual

Retrieves the compare data for the wide string value.

Returns
The compare data containing the pointer to the underlying string data and its size in bytes.

Reimplemented from Devel::Serializing::IData< std::wstring, false >.


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