Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos::SerializationTraits< Ordinal, long int > Class Template Reference

#include <Teuchos_SerializationTraits.hpp>

Inheritance diagram for Teuchos::SerializationTraits< Ordinal, long int >:

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 (long int *ptr)
 Convert the pointer type to char*.
static Ordinal fromDirectBytesToCount (const Ordinal bytes)
 Return the number of objects for bytes of storage.
static long int * convertFromCharPtr (char *ptr)
 Convert the pointer type from char*.

Indirect serialization functions (always defined and supported)

static Ordinal fromCountToIndirectBytes (const Ordinal count, const long int buffer[])
 Return the number of bytes for count objects.
static void serialize (const Ordinal count, const long int 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, long int buffer[])
 Deserialize from an indirect char[] buffer.

Additional Inherited Members

Static Public Member Functions inherited from Teuchos::DirectSerializationTraits< Ordinal, long int >
static Ordinal fromCountToDirectBytes (const Ordinal count)
static char * convertToCharPtr (long int *ptr)
static Ordinal fromDirectBytesToCount (const Ordinal count)
static long int * convertFromCharPtr (char *ptr)
static Ordinal fromCountToIndirectBytes (const Ordinal count, const long int buffer[])
static void serialize (const Ordinal count, const long int 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, long int buffer[])
Static Public Attributes inherited from Teuchos::DirectSerializationTraits< Ordinal, long int >
static const bool supportsDirectSerialization

Detailed Description

template<typename Ordinal>
class Teuchos::SerializationTraits< Ordinal, long int >

Definition at line 398 of file Teuchos_SerializationTraits.hpp.

Member Function Documentation

◆ fromCountToDirectBytes()

Ordinal Teuchos::SerializationTraits< Ordinal, long int >::fromCountToDirectBytes ( const Ordinal count)
inlinestatic

Return the number of bytes for count objects.

Definition at line 148 of file Teuchos_SerializationTraits.hpp.

◆ convertToCharPtr()

char * Teuchos::SerializationTraits< Ordinal, long int >::convertToCharPtr ( long int * ptr)
inlinestatic

Convert the pointer type to char*.

Definition at line 155 of file Teuchos_SerializationTraits.hpp.

◆ fromDirectBytesToCount()

Ordinal Teuchos::SerializationTraits< Ordinal, long int >::fromDirectBytesToCount ( const Ordinal bytes)
inlinestatic

Return the number of objects for bytes of storage.

Definition at line 169 of file Teuchos_SerializationTraits.hpp.

◆ convertFromCharPtr()

long int * Teuchos::SerializationTraits< Ordinal, long int >::convertFromCharPtr ( char * ptr)
inlinestatic

Convert the pointer type from char*.

Definition at line 176 of file Teuchos_SerializationTraits.hpp.

◆ fromCountToIndirectBytes()

Ordinal Teuchos::SerializationTraits< Ordinal, long int >::fromCountToIndirectBytes ( const Ordinal count,
const long int buffer[] )
inlinestatic

Return the number of bytes for count objects.

Definition at line 195 of file Teuchos_SerializationTraits.hpp.

◆ serialize()

void Teuchos::SerializationTraits< Ordinal, long int >::serialize ( const Ordinal count,
const long int 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()

Ordinal Teuchos::SerializationTraits< Ordinal, long int >::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()

void Teuchos::SerializationTraits< Ordinal, long int >::deserialize ( const Ordinal bytes,
const char charBuffer[],
const Ordinal count,
long int 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, long int >::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: