Starting from 2021-07-01, all LRZ GitLab users will be required to explicitly accept the GitLab Terms of Service. Please see the detailed information at https://doku.lrz.de/display/PUBLIC/GitLab and make sure that your projects conform to the requirements.

genericabstractimagerepresentation.h 6.85 KB
Newer Older
1 2 3 4
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
6 7
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
8 9
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
10
// 
11 12
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
13 14 15 16
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
17
// 
18 19 20 21
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
22 23 24 25 26 27
// 
// ================================================================================================

#ifndef GENERICABSTRACTIMAGEREPRESENTATION_H__
#define GENERICABSTRACTIMAGEREPRESENTATION_H__

28 29
#include "cgt/logmanager.h"

30 31 32 33
#include "core/datastructures/abstractimagerepresentation.h"
#include "core/datastructures/datacontainer.h"
#include "core/datastructures/imagedata.h"

34 35
#include <typeinfo>

36 37 38 39 40 41 42 43 44 45 46 47
namespace campvis {
    /**
     * Generic wrapper around an AbstractImageRepresentation that provides a ScopedRepresentation proxy.
     * The concept is very similar to the DataContainer::ScopedData proxy.
     * From the outside ScopedRepresentation behaves exactly like a const T*, but internally it preserves the
     * reference counting of a DataHandle. Use this class when you want temporary access to a specific
     * representation of an ImageData item in a DataContainer but don't want to do the dynamic_cast and 
     * the getRepresentation<T> yourself.
     *
     * \tparam  T   Base class of the ImageRepresentation to get.
     */
    template<typename T>
48
    class  GenericAbstractImageRepresentation : public AbstractImageRepresentation {
49 50 51 52 53 54
    public:
        struct ScopedRepresentation {
            /**
             * Creates a new DataHandle to the data item with the key \a name in \a dc, that behaves like a T*.
             * \param   dc      DataContainer to grab data from
             * \param   name    Key of the DataHandle to search for
55
             * \param   silent  Flag whether debug messages when no matching data is found should be silenced (defaults to false).
56
             */
57
            ScopedRepresentation(const DataContainer& dc, const std::string& name, bool silent = false)
58 59 60 61 62 63 64 65 66
                : dh(dc.getData(name))
                , data(0)
                , representation(0) 
            {
                if (dh.getData() != 0) {
                    data = dynamic_cast<const ImageData*>(dh.getData());
                    if (data != 0) {
                        representation = data->getRepresentation<T>();
                    }
67 68 69 70 71
                    else {
                        if (!silent)
                            LDEBUGC("CAMPVis.core.ScopedTypedData", "Found DataHandle with id '" << name << "', but it is of wrong type (" << typeid(*dh.getData()).name() << " instead of " << typeid(T).name() << ").");
                    }

72 73 74
                    if (data == 0 || representation == 0) {
                        dh = DataHandle(0);
                    }
75
                }
76 77 78 79
                else {
                    if (!silent)
                        LDEBUGC("CAMPVis.core.ScopedRepresentation", "Could not find a DataHandle with id '" << name << "' in DataContainer '" << dc.getName() << "'.");
                }
80 81
            };

82 83 84 85 86 87 88 89 90 91 92 93 94 95
            /**
             * Creates a new ScopedRepresentation for the given DataHandle, that behaves like a T*.
             * \param   dh  Source DataHandle
             */
            ScopedRepresentation(DataHandle dataHandle)
                : dh(dataHandle)
                , data(0)
                , representation(0) 
            {
                if (dh.getData() != 0) {
                    data = dynamic_cast<const ImageData*>(dh.getData());
                    if (data != 0) {
                        representation = data->getRepresentation<T>();
                    }
96 97 98
                    if (data == 0 || representation == 0) {
                        dh = DataHandle(0);
                    }
99 100 101
                }
            };

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
            /**
             * Implicit conversion operator to const T*.
             * \return  The image representation of the image in the DataHandle, may be 0 when no DataHandle was found,
             *           the data is of the wrong type, or no suitable representation was found.
             */
            operator const T*() {
                return representation;
            }

            /**
             * Implicit arrow operator to const T*.
             * \return  The image representation of the image in the DataHandle, may be 0 when no DataHandle was found,
             *           the data is of the wrong type, or no suitable representation was found.
             */
            const T* operator->() const {
                return representation;
            }

            /**
             * Gets the DataHandle.
             * \return dh
             */
            DataHandle getDataHandle() const {
                return dh;
            }

            /**
             * Returns the parent ImageData of this image representation.
             * \return data
             */
            const ImageData* getImageData() const {
                return data;
            }

        private:
            /// Not copy-constructable
            ScopedRepresentation(const ScopedRepresentation& rhs);
            /// Not assignable
            ScopedRepresentation& operator=(const ScopedRepresentation& rhs);

            DataHandle dh;                  ///< DataHandle
            const ImageData* data;          ///< strongly-typed pointer to data, may be 0
            const T* representation;        ///< strongly-typed pointer to the image representation, may be 0
        };

        /**
         * Creates a new abstract representation for the image \a parent.
         * \param   parent  Image this representation represents, must not be 0.
         */
151
        GenericAbstractImageRepresentation(ImageData* parent)
152 153 154 155 156 157 158 159 160 161 162 163 164 165
            : AbstractImageRepresentation(parent)
        {
        }

        /**
         * Virtual Destructor.
         */
        virtual ~GenericAbstractImageRepresentation() {};

    };

}

#endif // GENERICABSTRACTIMAGEREPRESENTATION_H__