#include <iaSerializable.h>

Static Public Member Functions
static bool	writeUInt8 (std::ofstream &stream, uint8 value)

static bool	readUInt8 (std::ifstream &stream, uint8 &value)

static bool	writeInt8 (std::ofstream &stream, int8 value)

static bool	readInt8 (std::ifstream &stream, int8 &value)

static bool	writeUInt16 (std::ofstream &stream, uint16 value)

static bool	readUInt16 (std::ifstream &stream, uint16 &value)

static bool	writeInt16 (std::ofstream &stream, int16 value)

static bool	readInt16 (std::ifstream &stream, int16 &value)

static bool	writeUInt32 (std::ofstream &stream, uint32 value)

static bool	readUInt32 (std::ifstream &stream, uint32 &value)

static bool	writeInt32 (std::ofstream &stream, int32 value)

static bool	readInt32 (std::ifstream &stream, int32 &value)

static bool	writeUInt64 (std::ofstream &stream, uint64 value)

static bool	readUInt64 (std::ifstream &stream, uint64 &value)

static bool	writeInt64 (std::ofstream &stream, int64 value)

static bool	readInt64 (std::ifstream &stream, int64 &value)

static bool	writeFloat32 (std::ofstream &stream, float32 value)

static bool	readFloat32 (std::ifstream &stream, float32 &value)

static bool	writeFloat64 (std::ofstream &stream, float64 value)

static bool	readFloat64 (std::ifstream &stream, float64 &value)

static bool	writeUInt (std::ofstream &stream, uint64 value, uint8 bytes)

static bool	readUInt (std::ifstream &stream, uint64 &value, uint8 bytes)

static bool	writeInt (std::ofstream &stream, int64 value, uint8 bytes)

static bool	readInt (std::ifstream &stream, int64 &value, uint8 bytes)

static bool	write (std::ofstream &stream, const char *buffer, uint32 bytes)

static bool	read (std::ifstream &stream, char *buffer, uint32 bytes)

static bool	writeUTF8 (std::ofstream &stream, const iaString &value)

static bool	readUTF8 (std::ifstream &stream, iaString &value)

static bool	write (std::ofstream &stream, const iaColor3f &value)

static bool	read (std::ifstream &stream, iaColor3f &value)

static bool	write (std::ofstream &stream, const iaColor3c &value)

static bool	read (std::ifstream &stream, iaColor3c &value)

static bool	write (std::ofstream &stream, const iaColor4f &value)

static bool	read (std::ifstream &stream, iaColor4f &value)

static bool	write (std::ofstream &stream, const iaVector2f &value)

static bool	read (std::ifstream &stream, iaVector2f &value)

static bool	write (std::ofstream &stream, const iaVector3f &value)

static bool	read (std::ifstream &stream, iaVector3f &value)

static bool	write (std::ofstream &stream, const iaVector4f &value)

static bool	read (std::ifstream &stream, iaVector4f &value)

static bool	write (std::ofstream &stream, const iaKeyFrameGraphf &value)

static bool	read (std::ifstream &stream, iaKeyFrameGraphf &value)

static bool	write (std::ofstream &stream, const iaKeyFrameGraphui &value)

static bool	read (std::ifstream &stream, iaKeyFrameGraphui &value)

static bool	write (std::ofstream &stream, const iaKeyFrameGraphVector3f &value)

static bool	read (std::ifstream &stream, iaKeyFrameGraphVector3f &value)

static bool	write (std::ofstream &stream, const iaKeyFrameGraphVector2f &value)

static bool	read (std::ifstream &stream, iaKeyFrameGraphVector2f &value)

static bool	write (std::ofstream &stream, const iaKeyFrameGraphColor4f &value)

static bool	read (std::ifstream &stream, iaKeyFrameGraphColor4f &value)

Detailed Description

helper class for serializing / deserializing any data from and to a stream

Member Function Documentation

◆ read() [1/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		char *	buffer,
		uint32	bytes
	)

static

reads buffer with specified length from stream

Parameters

stream	input stream
buffer	buffer to read
bytes	bytes to read count

Returns: true if successfull

◆ read() [2/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaColor3c &	value
	)

static

reads a color3c from stream

Parameters

stream	input stream
value	destination color

Returns: true if successfull

◆ read() [3/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaColor3f &	value
	)

static

reads a color3f from stream

Parameters

stream	input stream
value	destination color

Returns: true if successfull

◆ read() [4/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaColor4f &	value
	)

static

reads a color4f from stream

Parameters

stream	input stream
value	destination color

Returns: true if successfull

◆ read() [5/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaKeyFrameGraphColor4f &	value
	)

static

reads a float32 color gradient from stream

Parameters

stream	input stream
value	destination gradient

Returns: true if successfull

◆ read() [6/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaKeyFrameGraphf &	value
	)

static

reads a float32 gradient from stream

Parameters

stream	input stream
value	destination gradient

Returns: true if successfull

◆ read() [7/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaKeyFrameGraphui &	value
	)

static

reads a uint32 gradient from stream

Parameters

stream	input stream
value	destination gradient

Returns: true if successfull

◆ read() [8/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaKeyFrameGraphVector2f &	value
	)

static

reads a float32 2d vector gradient from stream

Parameters

stream	input stream
value	destination gradient

Returns: true if successfull

◆ read() [9/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaKeyFrameGraphVector3f &	value
	)

static

reads a float32 3d vector gradient from stream

Parameters

stream	input stream
value	destination gradient

Returns: true if successfull

◆ read() [10/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaVector2f &	value
	)

static

reads a vector2f from stream

Parameters

stream	input stream
value	destination vector

Returns: true if successfull

◆ read() [11/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaVector3f &	value
	)

static

reads a vector3f from stream

Parameters

stream	input stream
value	destination vector

Returns: true if successfull

◆ read() [12/12]

bool iaux::iaSerializable::read	(	std::ifstream &	stream,
		iaVector4f &	value
	)

static

reads a vector4f from stream

Parameters

stream	input stream
value	destination vector

Returns: true if successfull

◆ readFloat32()

bool iaux::iaSerializable::readFloat32	(	std::ifstream &	stream,
		float32 &	value
	)

static

reads float32 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readFloat64()

bool iaux::iaSerializable::readFloat64	(	std::ifstream &	stream,
		float64 &	value
	)

static

reads float64 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readInt()

bool iaux::iaSerializable::readInt	(	std::ifstream &	stream,
		int64 &	value,
		uint8	bytes
	)

static

reads integer value with specified length from stream

Parameters

stream	input stream
value	value to read
bytes	bytes to read count

Returns: true if successfull

◆ readInt16()

bool iaux::iaSerializable::readInt16	(	std::ifstream &	stream,
		int16 &	value
	)

static

reads int16 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readInt32()

bool iaux::iaSerializable::readInt32	(	std::ifstream &	stream,
		int32 &	value
	)

static

reads int32 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readInt64()

bool iaux::iaSerializable::readInt64	(	std::ifstream &	stream,
		int64 &	value
	)

static

reads int64 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readInt8()

bool iaux::iaSerializable::readInt8	(	std::ifstream &	stream,
		int8 &	value
	)

static

reads int8 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readUInt()

bool iaux::iaSerializable::readUInt	(	std::ifstream &	stream,
		uint64 &	value,
		uint8	bytes
	)

static

reads unsigned integer value with specified length from stream

Parameters

stream	input stream
value	value to read
bytes	bytes to read count

Returns: true if successfull

◆ readUInt16()

bool iaux::iaSerializable::readUInt16	(	std::ifstream &	stream,
		uint16 &	value
	)

static

reads uint16 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readUInt32()

bool iaux::iaSerializable::readUInt32	(	std::ifstream &	stream,
		uint32 &	value
	)

static

reads uint32 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readUInt64()

bool iaux::iaSerializable::readUInt64	(	std::ifstream &	stream,
		uint64 &	value
	)

static

reads uint64 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readUInt8()

bool iaux::iaSerializable::readUInt8	(	std::ifstream &	stream,
		uint8 &	value
	)

static

reads uint8 value from stream

Parameters

stream	input stream
value	value to write

Returns: true if successfull

◆ readUTF8()

bool iaux::iaSerializable::readUTF8	(	std::ifstream &	stream,
		iaString &	value
	)

static

reads UTF8 encoded string from stream

Parameters

stream	input stream
value	the string to read

Returns: true if successfull

◆ write() [1/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const char *	buffer,
		uint32	bytes
	)

static

writes buffer with specified length to stream

Parameters

stream	output stream
buffer	buffer to write
bytes	bytes to write count

Returns: true if successfull

◆ write() [2/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaColor3c &	value
	)

static

writes a color3c to stream

Parameters

stream	output stream
value	output color

Returns: true if successfull

◆ write() [3/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaColor3f &	value
	)

static

writes a color3f to stream

Parameters

stream	output stream
value	output color

Returns: true if successfull

◆ write() [4/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaColor4f &	value
	)

static

writes a color4f to stream

Parameters

stream	output stream
value	output color

Returns: true if successfull

◆ write() [5/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaKeyFrameGraphColor4f &	value
	)

static

write float32 color gradient to stream

Parameters

stream	output stream
value	gradient to write

◆ write() [6/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaKeyFrameGraphf &	value
	)

static

write float32 gradient to stream

Parameters

stream	output stream
value	gradient to write

◆ write() [7/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaKeyFrameGraphui &	value
	)

static

write uint32 gradient to stream

Parameters

stream	output stream
value	gradient to write

◆ write() [8/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaKeyFrameGraphVector2f &	value
	)

static

write float32 2d vector gradient to stream

Parameters

stream	output stream
value	gradient to write

◆ write() [9/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaKeyFrameGraphVector3f &	value
	)

static

write float32 3d vector gradient to stream

Parameters

stream	output stream
value	gradient to write

◆ write() [10/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaVector2f &	value
	)

static

writes a vector2f to stream

Parameters

stream	output stream
value	output vector

Returns: true if successfull

◆ write() [11/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaVector3f &	value
	)

static

writes a vector3f to stream

Parameters

stream	output stream
value	output vector

Returns: true if successfull

◆ write() [12/12]

bool iaux::iaSerializable::write	(	std::ofstream &	stream,
		const iaVector4f &	value
	)

static

writes a vector4f to stream

Parameters

stream	output stream
value	output vector

Returns: true if successfull

◆ writeFloat32()

bool iaux::iaSerializable::writeFloat32	(	std::ofstream &	stream,
		float32	value
	)

static

writes float32 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeFloat64()

bool iaux::iaSerializable::writeFloat64	(	std::ofstream &	stream,
		float64	value
	)

static

writes float64 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeInt()

bool iaux::iaSerializable::writeInt	(	std::ofstream &	stream,
		int64	value,
		uint8	bytes
	)

static

writes integer value with specified length to stream

Parameters

stream	output stream
value	value to write
bytes	bytes to write count

Returns: true if successfull

◆ writeInt16()

bool iaux::iaSerializable::writeInt16	(	std::ofstream &	stream,
		int16	value
	)

static

writes int16 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeInt32()

bool iaux::iaSerializable::writeInt32	(	std::ofstream &	stream,
		int32	value
	)

static

writes int32 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeInt64()

bool iaux::iaSerializable::writeInt64	(	std::ofstream &	stream,
		int64	value
	)

static

writes int64 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeInt8()

bool iaux::iaSerializable::writeInt8	(	std::ofstream &	stream,
		int8	value
	)

static

writes int8 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeUInt()

bool iaux::iaSerializable::writeUInt	(	std::ofstream &	stream,
		uint64	value,
		uint8	bytes
	)

static

writes unsigned integer value with specified length to stream

Parameters

stream	output stream
value	value to write
bytes	bytes to write count

Returns: true if successfull

◆ writeUInt16()

bool iaux::iaSerializable::writeUInt16	(	std::ofstream &	stream,
		uint16	value
	)

static

writes uint16 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeUInt32()

bool iaux::iaSerializable::writeUInt32	(	std::ofstream &	stream,
		uint32	value
	)

static

writes uint32 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeUInt64()

bool iaux::iaSerializable::writeUInt64	(	std::ofstream &	stream,
		uint64	value
	)

static

writes uint64 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeUInt8()

bool iaux::iaSerializable::writeUInt8	(	std::ofstream &	stream,
		uint8	value
	)

static

writes uint8 value to stream

Parameters

stream	output stream
value	value to write

Returns: true if successfull

◆ writeUTF8()

bool iaux::iaSerializable::writeUTF8	(	std::ofstream &	stream,
		const iaString &	value
	)

static

writes UTF8 encoded string in to stream

Parameters

stream	output stream
value	the string to write

Returns: true if successfull

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

/home/maddin/dev/Igor/src/iaux/iaux/data/iaSerializable.h
/home/maddin/dev/Igor/src/iaux/iaux/data/iaSerializable.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ read() [1/12]

◆ read() [2/12]

◆ read() [3/12]

◆ read() [4/12]

◆ read() [5/12]

◆ read() [6/12]

◆ read() [7/12]

◆ read() [8/12]

◆ read() [9/12]

◆ read() [10/12]

◆ read() [11/12]

◆ read() [12/12]

◆ readFloat32()

◆ readFloat64()

◆ readInt()

◆ readInt16()

◆ readInt32()

◆ readInt64()

◆ readInt8()

◆ readUInt()

◆ readUInt16()

◆ readUInt32()

◆ readUInt64()

◆ readUInt8()

◆ readUTF8()

◆ write() [1/12]

◆ write() [2/12]

◆ write() [3/12]

◆ write() [4/12]

◆ write() [5/12]

◆ write() [6/12]

◆ write() [7/12]

◆ write() [8/12]

◆ write() [9/12]

◆ write() [10/12]

◆ write() [11/12]

◆ write() [12/12]

◆ writeFloat32()

◆ writeFloat64()

◆ writeInt()

◆ writeInt16()

◆ writeInt32()

◆ writeInt64()

◆ writeInt8()

◆ writeUInt()

◆ writeUInt16()

◆ writeUInt32()

◆ writeUInt64()

◆ writeUInt8()

◆ writeUTF8()