NDEVR
API Documentation
DesignLock.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Design
28File: DesignLock
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/UUID.h>
34#include <NDEVR/RWLock.h>
35namespace NDEVR
36{
38
47 {
48 public:
54 RDesignLock(DesignObjectLookup* lookup, const UUID& model);
55 protected:
58 };
59
68 {
69 public:
75 WDesignLock(DesignObjectLookup* lookup, const UUID& model);
76 protected:
79 };
80
81}
82
83
84
A core class where all Design Objects including models, materials, and geometries are stored.
RDesignLock(DesignObjectLookup *lookup, const UUID &model)
Constructs an RDesignLock, acquiring the necessary locks for reading a design model.
WLock m_design_read_lock
Write lock held on the specific design model for read access.
Definition DesignLock.h:57
RLock m_lookup_read_lock
Read lock held on the DesignObjectLookup.
Definition DesignLock.h:56
Used to lock a particular variable for reading.
Definition RWLock.h:157
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer s...
Definition UUID.h:61
WLock m_design_write_lock
Write lock held on the specific design model for write access.
Definition DesignLock.h:78
WDesignLock(DesignObjectLookup *lookup, const UUID &model)
Constructs a WDesignLock, acquiring the necessary locks for writing to a design model.
RLock m_lookup_read_lock
Read lock held on the DesignObjectLookup.
Definition DesignLock.h:77
Used to lock a particular variable for writing.
Definition RWLock.h:272
The primary namespace for the NDEVR SDK.