ioda::detail::Object_Accessor_Regular< DataType, value_type > Struct Template Reference

#include <Marshalling.h>

Public Types
typedef std::remove_const< DataType >::type	mutable_DataType
typedef std::remove_const< value_type >::type	mutable_value_type
typedef std::shared_ptr< Marshalled_Data< DataType, mutable_DataType > >	serialized_type
typedef std::shared_ptr< const Marshalled_Data< DataType, mutable_DataType > >	const_serialized_type

Public Member Functions
	Object_Accessor_Regular (detail::PointerOwner pointerOwner=detail::PointerOwner::Caller)
const_serialized_type	serialize (::gsl::span< const DataType > d)
	Converts an object into a void* byte stream. More...
serialized_type	prep_deserialize (size_t numObjects)
	Construct an object from a byte stream, and deallocate any temporary buffer. More...
void	deserialize (serialized_type p, gsl::span< DataType > data)
	Unpack the data. For POD, nothing special here. More...

Public Attributes
detail::PointerOwner	pointerOwner_

Detailed Description

template<class DataType, class value_type = DataType>
struct ioda::detail::Object_Accessor_Regular< DataType, value_type >

Note

We want character streams, and these void* types are horribly hacked :-( Using void* because we want to preserve a semantic difference between serialized / deserialized data.

By default, we are using the POD accessor. Valid for simple data types, where multiple objects are in the same dataspace, and each object is a singular instance of the base data type.

Definition at line 66 of file Marshalling.h.

Member Typedef Documentation

const_serialized_type

template<class DataType , class value_type = DataType>

typedef std::shared_ptr<const Marshalled_Data<DataType, mutable_DataType> > ioda::detail::Object_Accessor_Regular< DataType, value_type >::const_serialized_type

Definition at line 71 of file Marshalling.h.

mutable_DataType

template<class DataType , class value_type = DataType>

typedef std::remove_const<DataType>::type ioda::detail::Object_Accessor_Regular< DataType, value_type >::mutable_DataType

Definition at line 67 of file Marshalling.h.

mutable_value_type

template<class DataType , class value_type = DataType>

typedef std::remove_const<value_type>::type ioda::detail::Object_Accessor_Regular< DataType, value_type >::mutable_value_type

Definition at line 68 of file Marshalling.h.

serialized_type

template<class DataType , class value_type = DataType>

typedef std::shared_ptr<Marshalled_Data<DataType, mutable_DataType> > ioda::detail::Object_Accessor_Regular< DataType, value_type >::serialized_type

Definition at line 70 of file Marshalling.h.

Constructor & Destructor Documentation

Object_Accessor_Regular()

template<class DataType , class value_type = DataType>

ioda::detail::Object_Accessor_Regular< DataType, value_type >::Object_Accessor_Regular ( detail::PointerOwner  pointerOwner = detail::PointerOwner::Caller )

inline

Definition at line 76 of file Marshalling.h.

Member Function Documentation

deserialize()

template<class DataType , class value_type = DataType>

void ioda::detail::Object_Accessor_Regular< DataType, value_type >::deserialize ( serialized_type  p, gsl::span< DataType >  data  )

inline

Unpack the data. For POD, nothing special here.

Definition at line 102 of file Marshalling.h.

prep_deserialize()

template<class DataType , class value_type = DataType>

serialized_type ioda::detail::Object_Accessor_Regular< DataType, value_type >::prep_deserialize ( size_t  numObjects )

inline

Construct an object from a byte stream, and deallocate any temporary buffer.

Note

For trivial (POD) objects, there is no need to do anything.

Definition at line 96 of file Marshalling.h.

serialize()

template<class DataType , class value_type = DataType>

const_serialized_type ioda::detail::Object_Accessor_Regular< DataType, value_type >::serialize ( ::gsl::span< const DataType >  d )

inline

Converts an object into a void* byte stream.

Note

The shared_ptr takes care of "deallocation" when we no longer need the "buffer".

Definition at line 80 of file Marshalling.h.

Member Data Documentation

pointerOwner_

template<class DataType , class value_type = DataType>

detail::PointerOwner ioda::detail::Object_Accessor_Regular< DataType, value_type >::pointerOwner_

Definition at line 73 of file Marshalling.h.

---

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

• Marshalling.h