Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

datahandle.h 4.12 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Software Framework.
4
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
schultezub's avatar
schultezub committed
6
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
7
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
10
// 
schultezub's avatar
schultezub committed
11
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
12
// 
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
// 
// ================================================================================================

schultezub's avatar
schultezub committed
25
26
27
#ifndef datahandle_h__
#define datahandle_h__

28
29
#include <ctime>

30
31
#include "core/coreapi.h"

schultezub's avatar
schultezub committed
32
namespace campvis {
33
    class AbstractData;
schultezub's avatar
schultezub committed
34
35
36

    /**
     * A DataHandle is responsible to manage the lifetime of an AbstractData instance.
37
     * Therefore, it implements a reference counting technique in cooperation with AbstractData.
38
39
40
41
42
     * 
     * This class can be considered as thread safe under the following conditions:
     *  * A single DataHandle instance must not be accessed from different threads.
     *  * Concurrent access to the same AbstractData instance via different DataHandles is safe.
     * 
43
     * \note    For clarity: An AbstractData instance can be referenced by multiple DataHandles. As soon 
44
     *          as it is afterwards reference by 0 DataHandles, the AbstractData instance will be destroyed.
45
46
47
48
     *          Also remember that a DataHandle takes ownership of the given AbstractData instance. So do
     *          not delete it once it has been assigned to a DataHandle (respectively DataContainer) or mess
     *          with its reference counting!
     * \note    Reference counting implementation inspired from Scott Meyers: More Effective C++, Item 29
schultezub's avatar
schultezub committed
49
     */
50
    class CAMPVIS_CORE_API DataHandle {
schultezub's avatar
schultezub committed
51
52
    public:
        /**
53
54
55
56
         * Creates a new DataHandle for the given data.
         * \note    By passing the data to DataHandle you will transfer its ownership to the reference
         *          counting mechanism. Make sure not to interfere with it or delete \a data yourself!
         * \param   data    Data for the DataHandle
schultezub's avatar
schultezub committed
57
         */
58
        explicit DataHandle(AbstractData* data = 0);
schultezub's avatar
schultezub committed
59
60

        /**
61
62
63
         * Copy-constructor
         * \note    If \a rhs is not shareable, this implies a copy of the data!
         * \param   rhs     Source DataHandle
schultezub's avatar
schultezub committed
64
         */
65
        DataHandle(const DataHandle& rhs);
schultezub's avatar
schultezub committed
66
67

        /**
68
69
70
71
         * Assignment operator
         * \note    If \a rhs is not shareable, this implies a copy of the data!
         * \param   rhs     source DataHandle
         * \return  *this
schultezub's avatar
schultezub committed
72
         */
73
        DataHandle& operator=(const DataHandle& rhs);
74

schultezub's avatar
schultezub committed
75
        /**
schultezub's avatar
schultezub committed
76
         * Destructor, decrease the reference count of the managed AbstractData.
schultezub's avatar
schultezub committed
77
         */
78
        virtual ~DataHandle();
schultezub's avatar
schultezub committed
79
80

        /**
81
82
         * Grants const access to the managed AbstractData instance.
         * \return  _data;
schultezub's avatar
schultezub committed
83
         */
84
        const AbstractData* getData() const;
schultezub's avatar
schultezub committed
85

86
87
88
89
90
91
        /**
         * Gets the timestamp when this data has been created.
         * \return _timestamp
         */
        clock_t getTimestamp() const;

schultezub's avatar
schultezub committed
92

93
    private:
schultezub's avatar
schultezub committed
94
        /**
95
         * Initializes the reference counting for the data.
schultezub's avatar
schultezub committed
96
         */
97
        void init();
schultezub's avatar
schultezub committed
98

99
100
        AbstractData* _data;                    ///< managed data
        clock_t _timestamp;                     ///< Timestamp when this data has been created
schultezub's avatar
schultezub committed
101
102
103
104
105
    };

}

#endif // datahandle_h__