Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_Serializer.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_SERIALIZER_HPP
43#define TEUCHOS_SERIALIZER_HPP
44
45#include "Teuchos_RCP.hpp"
46
47namespace Teuchos {
48
56template<typename Ordinal, typename T>
58public:
59
61 virtual ~Serializer() {}
62
66 virtual Ordinal getBufferSize(const Ordinal count) const = 0;
67
86 virtual void serialize(
87 const Ordinal count
88 ,const T * const objs[]
89 ,const Ordinal bytes
90 ,char charBuffer[]
91 ) const = 0;
92
93 // const ArrayView<const Ptr<const T> >& objs
94 // std::ostream& oStream
95
98 virtual RCP<T> createObj() const = 0;
99
118 virtual void deserialize(
119 const Ordinal bytes
120 ,const char charBuffer[]
121 ,const Ordinal count
122 ,T * const objs[]
123 ) const = 0;
124
125 // const ArrayView<const Ptr<T> >& objs
126 // std::istream& iStream
127
128};
129
130} // namespace Teuchos
131
132#endif // TEUCHOS_SERIALIZER_HPP
Reference-counted pointer class and non-member templated function implementations.
Smart reference counting pointer class for automatic garbage collection.
Strategy interface for the indirect serializing and deserializing objects of a given type handled usi...
virtual void serialize(const Ordinal count, const T *const objs[], const Ordinal bytes, char charBuffer[]) const =0
Serialize an object to a char[] buffer.
virtual Ordinal getBufferSize(const Ordinal count) const =0
Return an estimate for the maximum storage for count objects to be serialized.
virtual void deserialize(const Ordinal bytes, const char charBuffer[], const Ordinal count, T *const objs[]) const =0
Deserialize an object from a char[] buffer.
virtual RCP< T > createObj() const =0
Create an object of type T to be serialized into.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...