DCMTree_Serialization Namespace Reference

Classes
class	Sink
	Interface of a data sink for the serialization of objects. More...
class	Source
	Interface of a data source for the deserialization of objects. More...
class	Serializable
	Interface which provides a method to serialize an object. More...
class	Deserializable
	Interface which provides a method to deserialize an object. More...
class	SerializerIntf
	Interface of a class, which can be used to serialize objects. More...
class	DeserializerIntf
	Interface of a class, which can be used to deserialize objects without a default constructor. More...
class	FileSink
	Class to write DCMtree as file stream. More...
class	FileSource
	Class to read DCMtree file stream. More...
Enumerations
enum	TypeCode {   TC_BOOL, TC_SIGNED_INT, TC_UNSIGNED_INT, TC_SIGNED_SHORT,   TC_UNSIGNED_SHORT, TC_SIGNED_LONG, TC_UNSIGNED_LONG, TC_FLOAT,   TC_DOUBLE, TC_STRING, TC_PAIR, TC_VECTOR,   TC_MAP, TC_SET, TC_MULTIMAP, TC_ENUM,   TC_OTHER, TC_SIGNED_LONG_LONG, TC_UNSIGNED_LONG_LONG }
	Used to encode type of next serialized value into the stream. More...
Functions
void	serializeX (Sink &sink, const DCMTree::TransferSyntax &syntax)
void	deserializeX (Source &source, DCMTree::TransferSyntax &syntax)
void	serializeX (Sink &sink, const DCMTree::Vr &vr)
void	deserializeX (Source &source, DCMTree::Vr &vr)
template<typename T >
void	serializePrimitiveX (Sink &sink, T value)
	Serializes a primitive type like int, long.
template<typename T >
void	deserializePrimitiveX (Source &source, T &value)
	Deserializes a primitive type like int, long.
void	serializeX (Sink &sink, int value)
	Serializes an int.
void	deserializeX (Source &source, int &value)
	Deserializes an int.
void	serializeX (Sink &sink, unsigned int value)
	Serializes an unsigned int.
void	deserializeX (Source &source, unsigned int &value)
	Deserializes an unsigned int.
void	serializeX (Sink &sink, short value)
	Serializes an short.
void	deserializeX (Source &source, short &value)
	Deserializes an short.
void	serializeX (Sink &sink, unsigned short value)
	Serializes an unsigned short.
void	deserializeX (Source &source, unsigned short &value)
	Deserializes an unsigned short.
void	serializeX (Sink &sink, long value)
	Serializes an long.
void	deserializeX (Source &source, long &value)
	Deserializes an long.
void	serializeX (Sink &sink, unsigned long value)
	Serializes an unsigned long.
void	deserializeX (Source &source, unsigned long &value)
	Deserializes an unsigned long.
void	serializeX (Sink &sink, long long value)
	Serializes an long.
void	deserializeX (Source &source, long long &value)
	Deserializes an long.
void	serializeX (Sink &sink, unsigned long long value)
	Serializes an unsigned long.
void	deserializeX (Source &source, unsigned long long &value)
	Deserializes an unsigned long.
void	serializeX (Sink &sink, float value)
	Serializes an float.
void	deserializeX (Source &source, float &value)
	Deserializes an float.
void	serializeX (Sink &sink, const double &value)
	Serializes an double.
void	deserializeX (Source &source, double &value)
	Deserializes an double.
void	serializeX (Sink &sink, bool value)
	Serializes an bool .
void	deserializeX (Source &source, bool &value)
	Deserializes an bool .
void	serializeX (Sink &sink, const std::string &value)
	Serializes a QString.
void	deserializeX (Source &source, std::string &value)
	Deserializes a QString.
template<typename T >
void	serializeEnumX (Sink &sink, T value)
	Serializes an enum.
template<typename T >
void	deserializeEnumX (Source &source, T &value)
	Deserializes an enum.
void	serializeX (Sink &sink, const Serializable &value)
	Serializes a Serializable.
void	deserializeX (Source &source, Deserializable &value)
	Deserializes a Deserializable.
template<typename T >
void	serializeX (Sink &sink, boost::shared_ptr< T > value)
	Serializes boost::shared_ptr<T>.
template<typename T >
void	deserializeIntoNewX (Source &source, boost::shared_ptr< T > &value)
	Deserializes boost::shared_ptr<T>.
template<typename T >
void	deserializeIntoExistingX (Source &source, boost::shared_ptr< T > value)
	Deserializes boost::shared_ptr<T>.
template<typename T , typename U >
void	serializeX (Sink &sink, const std::pair< T, U > &value)
	Serializes std::pair<T,U>.
template<typename T , typename U >
void	deserializeX (Source &source, std::pair< T, U > &value)
	Deserializes std::pair<T,U>.
template<typename T , typename U >
void	serializeX (Sink &sink, const std::map< T, U > &value)
	Serializes std::map<T,U>.
template<typename T , typename U >
void	deserializeX (Source &source, std::map< T, U > &value)
	Deserializes std::map<T,U>.
template<typename T , typename U >
void	serializeX (Sink &sink, const std::multimap< T, U > &value)
	Serializes std::multimap<T,U>.
template<typename T , typename U >
void	deserializeX (Source &source, std::multimap< T, U > &value)
	Deserializes std::multimap<T,U>.
template<typename T >
void	serializeX (Sink &sink, const std::set< T > &value)
	Serializes std::set<T>.
template<typename T >
void	deserializeX (Source &source, std::set< T > &value)
	Deserializes std::set<T>.
template<typename T >
void	serializeX (Sink &sink, const std::vector< T > &vl)
	Serializes a std::vector of serializable objects.
template<typename T >
void	deserializeX (Source &source, std::vector< T > &vl)
	Deserializes a std::vector of deserializable objects.
template<typename T >
void	serializeX (SerializerIntf< T > &serializer, Sink &sink, const T &value)
	Serializes an object with the help of a SerializerIntf.
template<typename T >
void	deserializeX (DeserializerIntf< T > &deserializer, Source &source, T &value)
	Deserializes an object with the help of a DeserializerIntf.
template<typename T >
bool	serialize (Sink &sink, const T &value)
	Adapts serializeX to return an error code instead of throwing an exception.
template<typename T >
bool	deserialize (Source &source, T &value)
	Adapts deserializeX to return an error code instead of throwing an exception.

---

Enumeration Type Documentation

enum DCMTree_Serialization::TypeCode

Used to encode type of next serialized value into the stream.

This is not a very cross-compiler friendly way of doing this. It should use size specific declarations like boost uint32_t

Enumerator:

TC_BOOL	bool
TC_SIGNED_INT	signed int
TC_UNSIGNED_INT	unsigned int
TC_SIGNED_SHORT	signed short
TC_UNSIGNED_SHORT	unsigned short
TC_SIGNED_LONG	signed long
TC_UNSIGNED_LONG	unsigned long
TC_FLOAT	float
TC_DOUBLE	double
TC_STRING	QString.
TC_PAIR	std::pair
TC_VECTOR	std::vector
TC_MAP	CondVar.
TC_SET	std::set
TC_MULTIMAP	std::multimap
TC_ENUM	Enum type.
TC_OTHER	Other type.
TC_SIGNED_LONG_LONG	signed long
TC_UNSIGNED_LONG_LONG	unsigned long

Definition at line 26 of file DCMTree_Serialization.h.

---

Function Documentation

template<typename T >

bool DCMTree_Serialization::deserialize	(	Source &	source,
		T &	value
	)		[inline]

Adapts deserializeX to return an error code instead of throwing an exception.

Definition at line 376 of file DCMTree_SerializationHelper.h.

References deserializeX().

template<typename T >

void DCMTree_Serialization::deserializeEnumX	(	Source &	source,
		T &	value
	)		[inline]

Deserializes an enum.

Definition at line 129 of file DCMTree_SerializationHelper.h.

References deserializePrimitiveX(), DCMTree_Serialization::Source::readTypeX(), T, and TC_ENUM.

template<typename T >

void DCMTree_Serialization::deserializeIntoExistingX	(	Source &	source,
		boost::shared_ptr< T >	value
	)		[inline]

Deserializes boost::shared_ptr<T>.

T has to be deserializable type.

Parameters:

value

Must not be null.

Definition at line 171 of file DCMTree_SerializationHelper.h.

References deserializeX().

template<typename T >

void DCMTree_Serialization::deserializeIntoNewX	(	Source &	source,
		boost::shared_ptr< T > &	value
	)		[inline]

Deserializes boost::shared_ptr<T>.

T has to be deserializable type with a default constructor.

Parameters:

value

May be null. Is initialized with a new, default constructed object before deserialization.

Definition at line 161 of file DCMTree_SerializationHelper.h.

References deserializeX(), and T.

template<typename T >

void DCMTree_Serialization::deserializePrimitiveX	(	Source &	source,
		T &	value
	)		[inline]

Deserializes a primitive type like int, long.

Definition at line 42 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::Source::readX().

Referenced by deserializeEnumX(), and deserializeX().

void DCMTree_Serialization::deserializeX	(	Source &	source,
		int &	value
	)

Deserializes an int.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		long &	value
	)

Deserializes an long.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		Deserializable &	value
	)		[inline]

Deserializes a Deserializable.

Definition at line 144 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::Deserializable::deserializeX().

void DCMTree_Serialization::deserializeX	(	Source &	source,
		DCMTree::Vr &	vr
	)

void DCMTree_Serialization::deserializeX	(	Source &	source,
		unsigned long &	value
	)

Deserializes an unsigned long.

template<typename T , typename U >

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::pair< T, U > &	value
	)		[inline]

Deserializes std::pair<T,U>.

T and U have to be deserializable types.

Definition at line 187 of file DCMTree_SerializationHelper.h.

References deserializeX(), DCMTree_Serialization::Source::readTypeX(), and TC_PAIR.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		unsigned int &	value
	)

Deserializes an unsigned int.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		long long &	value
	)

Deserializes an long.

template<typename T , typename U >

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::map< T, U > &	value
	)		[inline]

Deserializes std::map<T,U>.

T and U have to be deserializable types.

Definition at line 215 of file DCMTree_SerializationHelper.h.

References deserializeX(), DCMTree_Serialization::Source::readTypeX(), T, and TC_MAP.

template<typename T , typename U >

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::multimap< T, U > &	value
	)		[inline]

Deserializes std::multimap<T,U>.

T and U have to be deserializable types.

Definition at line 251 of file DCMTree_SerializationHelper.h.

References deserializeX(), DCMTree_Serialization::Source::readTypeX(), T, TC_MULTIMAP, and U.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		unsigned long long &	value
	)

Deserializes an unsigned long.

template<typename T >

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::set< T > &	value
	)		[inline]

Deserializes std::set<T>.

T has to be deserializable type.

Definition at line 288 of file DCMTree_SerializationHelper.h.

References deserializeX(), DCMTree_Serialization::Source::readTypeX(), T, and TC_SET.

template<typename T >

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::vector< T > &	vl
	)		[inline]

Deserializes a std::vector of deserializable objects.

Definition at line 327 of file DCMTree_SerializationHelper.h.

References deserializePrimitiveX(), deserializeX(), DCMTree_Serialization::Source::readTypeX(), and TC_VECTOR.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		DCMTree::TransferSyntax &	syntax
	)

Referenced by deserialize(), deserializeIntoExistingX(), deserializeIntoNewX(), and deserializeX().

void DCMTree_Serialization::deserializeX	(	Source &	source,
		short &	value
	)

Deserializes an short.

template<typename T >

void DCMTree_Serialization::deserializeX	(	DeserializerIntf< T > &	deserializer,
		Source &	source,
		T &	value
	)		[inline]

Deserializes an object with the help of a DeserializerIntf.

Definition at line 355 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::DeserializerIntf< T >::deserializeX().

void DCMTree_Serialization::deserializeX	(	Source &	source,
		float &	value
	)

Deserializes an float.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		double &	value
	)

Deserializes an double.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		unsigned short &	value
	)

Deserializes an unsigned short.

void DCMTree_Serialization::deserializeX	(	Source &	source,
		bool &	value
	)

Deserializes an bool .

void DCMTree_Serialization::deserializeX	(	Source &	source,
		std::string &	value
	)

Deserializes a QString.

template<typename T >

bool DCMTree_Serialization::serialize	(	Sink &	sink,
		const T &	value
	)		[inline]

Adapts serializeX to return an error code instead of throwing an exception.

Definition at line 362 of file DCMTree_SerializationHelper.h.

References serializeX().

template<typename T >

void DCMTree_Serialization::serializeEnumX	(	Sink &	sink,
		T	value
	)		[inline]

Serializes an enum.

Definition at line 121 of file DCMTree_SerializationHelper.h.

References serializePrimitiveX(), TC_ENUM, and DCMTree_Serialization::Sink::writeTypeX().

template<typename T >

void DCMTree_Serialization::serializePrimitiveX	(	Sink &	sink,
		T	value
	)		[inline]

Serializes a primitive type like int, long.

Definition at line 35 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::Sink::writeX().

Referenced by serializeEnumX(), and serializeX().

template<typename T , typename U >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::pair< T, U > &	value
	)		[inline]

Serializes std::pair<T,U>.

T and U have to be serializable types.

Definition at line 178 of file DCMTree_SerializationHelper.h.

References serializeX(), TC_PAIR, and DCMTree_Serialization::Sink::writeTypeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		long long	value
	)

Serializes an long.

template<typename T , typename U >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::multimap< T, U > &	value
	)		[inline]

Serializes std::multimap<T,U>.

T and U have to be serializable types.

Definition at line 232 of file DCMTree_SerializationHelper.h.

References serializeX(), TC_MULTIMAP, and DCMTree_Serialization::Sink::writeTypeX().

template<typename T , typename U >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::map< T, U > &	value
	)		[inline]

Serializes std::map<T,U>.

T and U have to be serializable types.

Definition at line 196 of file DCMTree_SerializationHelper.h.

References serializeX(), TC_MAP, and DCMTree_Serialization::Sink::writeTypeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		short	value
	)

Serializes an short.

template<typename T >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::vector< T > &	vl
	)		[inline]

Serializes a std::vector of serializable objects.

Definition at line 305 of file DCMTree_SerializationHelper.h.

References serializePrimitiveX(), serializeX(), TC_VECTOR, and DCMTree_Serialization::Sink::writeTypeX().

template<typename T >

void DCMTree_Serialization::serializeX	(	SerializerIntf< T > &	serializer,
		Sink &	sink,
		const T &	value
	)		[inline]

Serializes an object with the help of a SerializerIntf.

Definition at line 348 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::SerializerIntf< T >::serializeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const DCMTree::Vr &	vr
	)

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::string &	value
	)

Serializes a QString.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		long	value
	)

Serializes an long.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const DCMTree::TransferSyntax &	syntax
	)

Referenced by serialize(), and serializeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		bool	value
	)

Serializes an bool .

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const double &	value
	)

Serializes an double.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		unsigned int	value
	)

Serializes an unsigned int.

template<typename T >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const std::set< T > &	value
	)		[inline]

Serializes std::set<T>.

T has to be serializable type.

Definition at line 270 of file DCMTree_SerializationHelper.h.

References serializeX(), TC_SET, and DCMTree_Serialization::Sink::writeTypeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		float	value
	)

Serializes an float.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		int	value
	)

Serializes an int.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		unsigned short	value
	)

Serializes an unsigned short.

template<typename T >

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		boost::shared_ptr< T >	value
	)		[inline]

Serializes boost::shared_ptr<T>.

T has to be a serializable type.

Definition at line 151 of file DCMTree_SerializationHelper.h.

References serializeX().

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		unsigned long long	value
	)

Serializes an unsigned long.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		unsigned long	value
	)

Serializes an unsigned long.

void DCMTree_Serialization::serializeX	(	Sink &	sink,
		const Serializable &	value
	)		[inline]

Serializes a Serializable.

Definition at line 138 of file DCMTree_SerializationHelper.h.

References DCMTree_Serialization::Serializable::serializeX().