Sleeping Wombat GUI  0.100
swGUI
Public Member Functions | Private Attributes | List of all members
ISerializer Class Reference

Serializers interface. More...

#include <Serializer.h>

Public Member Functions

 ISerializer (std::unique_ptr< SerializationContext > serContext)
 Konstruktor. More...
 
virtual ~ISerializer ()
 Destruktor. More...
 
void EnterObject (const std::string &name)
 Tworzy obiekt o podanej nazwie. More...
 
void EnterArray (const std::string &name)
 Tworzy tablicę o podanej nazwie. More...
 
void Exit ()
 Koniec tworzenia obiektu. EnterObject i ExitObject powinny być stosowane parami. More...
 
void SetAttribute (const std::string &name, const std::string &value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, const char *value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, uint32 value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, uint64 value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, int32 value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, int64 value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, bool value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
void SetAttribute (const std::string &name, double value)
 Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie. More...
 
bool SaveFile (const std::string &fileName, WritingMode mode=WritingMode::Sparing)
 Zapisuje zserializowane dane do pliku. More...
 
std::string SaveString (WritingMode mode=WritingMode::Sparing)
 Zwraca stringa zawierającego zserializowanego Jsona. More...
 
template<typename ContextType >
ContextType * GetContext ()
 Returns serialization context. More...
 

Private Attributes

SerializerImplimpl
 
std::unique_ptr< SerializationContextcontext
 

Detailed Description

Serializers interface.

Constructor & Destructor Documentation

ISerializer::ISerializer ( std::unique_ptr< SerializationContext serContext)
explicit

Konstruktor.

ISerializer::~ISerializer ( )
virtual

Destruktor.

Member Function Documentation

void ISerializer::EnterArray ( const std::string &  name)

Tworzy tablicę o podanej nazwie.

Parameters
[in]nameNazwa tablicy.
void ISerializer::EnterObject ( const std::string &  name)

Tworzy obiekt o podanej nazwie.

Parameters
[in]nameNazwa obiektu.
void ISerializer::Exit ( )

Koniec tworzenia obiektu. EnterObject i ExitObject powinny być stosowane parami.

template<typename ContextType >
ContextType* ISerializer::GetContext ( )
inline

Returns serialization context.

Check documentation for SerializationContext for more information.

Context type is checked only in debug mode (asserts).

bool ISerializer::SaveFile ( const std::string &  fileName,
WritingMode  mode = WritingMode::Sparing 
)

Zapisuje zserializowane dane do pliku.

Attention
Po wykonaniu funkcji serializator wraca na zerowy poziom zagnieżdżenia node'ów, jeżeli zapis do pliku został wykonany poprawnie. Jeżeli funkcja zwróciła false, to serializator nadal jest na tym samym poziomie.
Parameters
[in]fileNameNazwa pliku docelowego.
Returns
Zwraca true, jeżeli zapisywanie powiedzie się.
Attention
Po wykonaniu funkcji serializator wraca na zerowy poziom zagnieżdżenia node'ów.
Parameters
[in]fileNameNazwa pliku docelowego.
Returns
Zwraca true, jeżeli zapisywanie powiedzie się.
std::string ISerializer::SaveString ( WritingMode  mode = WritingMode::Sparing)

Zwraca stringa zawierającego zserializowanego Jsona.

Attention
Po wykonaniu funkcji serializator wraca na zerowy poziom zagnieżdżenia node'ów.
Parameters
[in]modeFormatowanie stringa.
void ISerializer::SetAttribute ( const std::string &  name,
const std::string &  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
const char *  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
uint32  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
uint64  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
int32  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
int64  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
bool  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.
void ISerializer::SetAttribute ( const std::string &  name,
double  value 
)

Ustawia parę ( nazwa, wartość ) w aktualnym obiekcie.

Parameters
[in]nameNazwa ustawianej zmiennej.
[in]valueWartość, jaka zostanie wpisana do podanej zmiennej.

Member Data Documentation

std::unique_ptr< SerializationContext > ISerializer::context
private
SerializerImpl* ISerializer::impl
private

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