Geogram  Version 1.9.1-rc
A programming library of geometric algorithms
image_serializer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2022 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of the ALICE Project-Team nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Contact: Bruno Levy
30  *
31  * https://www.inria.fr/fr/bruno-levy
32  *
33  * Inria,
34  * Domaine de Voluceau,
35  * 78150 Le Chesnay - Rocquencourt
36  * FRANCE
37  *
38  */
39 
40 #ifndef H_OGF_IMAGE_IO_IMAGE_SERIALIZER_H
41 #define H_OGF_IMAGE_IO_IMAGE_SERIALIZER_H
42 
43 #include <geogram/basic/common.h>
44 #include <geogram/image/image.h>
45 #include <geogram/basic/counted.h>
47 
48 #include <iostream>
49 
55 namespace GEO {
56 
57 //_________________________________________________________
58 
59 
60  class Image ;
61 
65  class GEOGRAM_API ImageSerializer : public Counted {
66  public:
67 
75  virtual Image* serialize_read(const std::string& file_name) ;
76 
84  virtual bool serialize_write(
85  const std::string& file_name, const Image* image
86  ) ;
87 
96  virtual Image* serialize_read(std::istream& stream) ;
97 
105  virtual bool serialize_write(
106  std::ostream& stream, const Image* image
107  ) ;
108 
117  virtual bool binary() const ;
118 
127  virtual bool streams_supported() const ;
128 
136  virtual bool read_supported() const ;
137 
145  virtual bool write_supported() const ;
146  } ;
147 
152 
153 //_________________________________________________________
154 
155 }
156 #endif
Base class for reference-counted objects.
Definition: counted.h:71
Loads and saves images.
virtual bool read_supported() const
Tests whether reading is implemented.
virtual Image * serialize_read(std::istream &stream)
reads an image from a stream.
virtual Image * serialize_read(const std::string &file_name)
reads an image from a file.
virtual bool serialize_write(const std::string &file_name, const Image *image)
writes an image into a file.
virtual bool write_supported() const
Tests whether writing is implemented.
virtual bool streams_supported() const
Tests whether the functions that use streams are supported.
virtual bool serialize_write(std::ostream &stream, const Image *image)
writes an image into a stream.
virtual bool binary() const
Tests whether the file format is binary or ASCII.
An image.
Definition: image.h:59
A smart pointer with reference-counted copy semantics.
Definition: smart_pointer.h:76
Base class of reference-counted objects, to be used with smart pointers.
Common include file, providing basic definitions. Should be included before anything else by all head...
Global Vorpaline namespace.
Definition: basic.h:55
SmartPointer< ImageSerializer > ImageSerializer_var
An automatic reference-counted pointer to an ImageSerializer.
Pointers with automatic reference counting.