Teuchos::SerializationTraits< Ordinal, unsigned char > Class Template Reference

#include <Teuchos_SerializationTraits.hpp>

Inheritance diagram for Teuchos::SerializationTraits< Ordinal, unsigned char >:

Serialization type selection
static const bool	supportsDirectSerialization
	Whether the type T supports direct serialization.

Direct serialization functions (not defined if supportsDirectSerialization==false)
static Ordinal	fromCountToDirectBytes (const Ordinal count)
	Return the number of bytes for count objects.
static char *	convertToCharPtr (unsigned char *ptr)
	Convert the pointer type to char*.
static const char *	convertToCharPtr (const unsigned char *ptr)
	Convert the pointer type to const char*.
static Ordinal	fromDirectBytesToCount (const Ordinal bytes)
	Return the number of objects for bytes of storage.
static unsigned char *	convertFromCharPtr (char *ptr)
	Convert the pointer type from char*.
static const unsigned char *	convertFromCharPtr (const char *ptr)
	Convert the pointer type from char*.

Indirect serialization functions (always defined and supported)
static Ordinal	fromCountToIndirectBytes (const Ordinal count, const unsigned char buffer[])
	Return the number of bytes for count objects.
static void	serialize (const Ordinal count, const unsigned char buffer[], const Ordinal bytes, char charBuffer[])
	Serialize to an indirect char[] buffer.
static Ordinal	fromIndirectBytesToCount (const Ordinal bytes, const char charBuffer[])
	Return the number of objects for bytes of storage.
static void	deserialize (const Ordinal bytes, const char charBuffer[], const Ordinal count, unsigned char buffer[])
	Deserialize from an indirect char[] buffer.

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::DirectSerializationTraits< Ordinal, unsigned char >
static Ordinal	fromCountToDirectBytes (const Ordinal count)
static char *	convertToCharPtr (unsigned char *ptr)
static const char *	convertToCharPtr (const unsigned char *ptr)
static Ordinal	fromDirectBytesToCount (const Ordinal count)
static unsigned char *	convertFromCharPtr (char *ptr)
static const unsigned char *	convertFromCharPtr (const char *ptr)
static Ordinal	fromCountToIndirectBytes (const Ordinal count, const unsigned char buffer[])
static void	serialize (const Ordinal count, const unsigned char buffer[], const Ordinal bytes, char charBuffer[])
static Ordinal	fromIndirectBytesToCount (const Ordinal bytes, const char charBuffer[])
static void	deserialize (const Ordinal bytes, const char charBuffer[], const Ordinal count, unsigned char buffer[])
Static Public Attributes inherited from Teuchos::DirectSerializationTraits< Ordinal, unsigned char >
static const bool	supportsDirectSerialization

Detailed Description

template<typename Ordinal>
class Teuchos::SerializationTraits< Ordinal, unsigned char >

Definition at line 373 of file Teuchos_SerializationTraits.hpp.

Member Function Documentation

fromCountToDirectBytes()

static Ordinal Teuchos::SerializationTraits< Ordinal, unsigned char >::fromCountToDirectBytes ( const Ordinal count )

inlinestatic

Return the number of bytes for count objects.

Definition at line 148 of file Teuchos_SerializationTraits.hpp.

convertToCharPtr() [1/2]

static char * Teuchos::SerializationTraits< Ordinal, unsigned char >::convertToCharPtr ( unsigned char * ptr )

inlinestatic

Convert the pointer type to char*.

Definition at line 155 of file Teuchos_SerializationTraits.hpp.

convertToCharPtr() [2/2]

static const char * Teuchos::SerializationTraits< Ordinal, unsigned char >::convertToCharPtr ( const unsigned char * ptr )

inlinestatic

Convert the pointer type to const char*.

Definition at line 162 of file Teuchos_SerializationTraits.hpp.

fromDirectBytesToCount()

static Ordinal Teuchos::SerializationTraits< Ordinal, unsigned char >::fromDirectBytesToCount ( const Ordinal bytes )

inlinestatic

Return the number of objects for bytes of storage.

Definition at line 169 of file Teuchos_SerializationTraits.hpp.

convertFromCharPtr() [1/2]

static unsigned char * Teuchos::SerializationTraits< Ordinal, unsigned char >::convertFromCharPtr ( char * ptr )

inlinestatic

Convert the pointer type from char*.

Definition at line 176 of file Teuchos_SerializationTraits.hpp.

convertFromCharPtr() [2/2]

static const unsigned char * Teuchos::SerializationTraits< Ordinal, unsigned char >::convertFromCharPtr ( const char * ptr )

inlinestatic

Convert the pointer type from char*.

Definition at line 183 of file Teuchos_SerializationTraits.hpp.

fromCountToIndirectBytes()

static Ordinal Teuchos::SerializationTraits< Ordinal, unsigned char >::fromCountToIndirectBytes ( const Ordinal count, const unsigned char buffer[] )

inlinestatic

Return the number of bytes for count objects.

Definition at line 195 of file Teuchos_SerializationTraits.hpp.

serialize()

static void Teuchos::SerializationTraits< Ordinal, unsigned char >::serialize ( const Ordinal count, const unsigned char buffer[], const Ordinal bytes, char charBuffer[] )

inlinestatic

Serialize to an indirect char[] buffer.

Parameters

count	[in] The number of objects to serialize.
buffer	[in] The objects to serialize.
bytes	[in] Number of bytes in charBuffer[]
charBuffer	[out] Array (length bytes) containing the serialized objects.

Preconditions:

• bytes==fromCountToIndirectBytes(count)

Definition at line 217 of file Teuchos_SerializationTraits.hpp.

fromIndirectBytesToCount()

static Ordinal Teuchos::SerializationTraits< Ordinal, unsigned char >::fromIndirectBytesToCount ( const Ordinal bytes, const char charBuffer[] )

inlinestatic

Return the number of objects for bytes of storage.

Definition at line 227 of file Teuchos_SerializationTraits.hpp.

deserialize()

static void Teuchos::SerializationTraits< Ordinal, unsigned char >::deserialize ( const Ordinal bytes, const char charBuffer[], const Ordinal count, unsigned char buffer[] )

inlinestatic

Deserialize from an indirect char[] buffer.

Parameters

bytes	[in] Number of bytes in charBuffer[]
charBuffer	[in] Array (length bytes) containing the serialized objects.
count	[in] The number of objects to deserialize.
buffer	[out] The deserialized objects.

Preconditions:

• count==fromIndirectBytesToCount(bytes)

Definition at line 249 of file Teuchos_SerializationTraits.hpp.

Member Data Documentation

supportsDirectSerialization

const bool Teuchos::SerializationTraits< Ordinal, unsigned char >::supportsDirectSerialization

static

Whether the type T supports direct serialization.

See the class documentation for definitions of "direct" and "indirect" serialization.

Definition at line 140 of file Teuchos_SerializationTraits.hpp.

---

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

• Teuchos_SerializationTraits.hpp