File: OptionalValue.h

package info (click to toggle)
opensurgsim 0.7.0-11
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 23,744 kB
  • sloc: cpp: 135,363; ansic: 4,206; python: 3,934; makefile: 38
file content (173 lines) | stat: -rw-r--r-- 4,251 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// 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
//
// 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.

#ifndef SURGSIM_DATASTRUCTURES_OPTIONALVALUE_H
#define SURGSIM_DATASTRUCTURES_OPTIONALVALUE_H

#include "SurgSim/Framework/Assert.h"

namespace SurgSim
{
namespace DataStructures
{

template <class T>
/// Container class that can indicate whether the object has been assigned a value.
/// \tparam Class of the value that this object contains
class OptionalValue
{
public:

	/// Default Constructor, no value.
	OptionalValue()  : m_hasValue(false)
	{
	}

	/// Constructor that assigns a value.
	/// \param value The value that should be used.
	explicit OptionalValue(const T& value) : m_hasValue(true), m_value(value)
	{
	}

	/// Copy constructor
	/// \param other The value used for copying.
	OptionalValue(const OptionalValue& other) : m_hasValue(other.m_hasValue)
	{
		if (m_hasValue)
		{
			m_value = other.m_value;
		}
	}

	/// Query if this object has been assigned a value.
	/// \return	true if yes, false if not.
	bool hasValue() const
	{
		return m_hasValue;
	}

	/// Mark this object as invalid
	void invalidate()
	{
		m_hasValue = false;
	}

	/// Set the value of this object, and mark it as valid
	/// \param val The value  of the object
	void setValue(const T& val)
	{
		m_hasValue = true;
		m_value = val;
	}

	/// Gets the value.
	/// \throws SurgSim::Framework::AssertionFailure if the value was not set
	/// \return	The assigned value if set.
	const T& getValue() const
	{
		SURGSIM_ASSERT(m_hasValue) << "Tried to fetch a value from an invalid OptionalValue";
		return m_value;
	}

	/// Gets the value
	/// \note do not implement T& operator*(), because *optionalValue = X; would not be able to set
	///       the hasValue() property properly.
	/// \throws SurgSim::Framework::AssertionFailure if the value was not set
	/// \return the contained value.
	const T& operator*() const
	{
		SURGSIM_ASSERT(m_hasValue) << "Tried to fetch a value from an invalid OptionalValue";
		return m_value;
	}

	/// Equality operator.
	/// \param	rhs	The right hand side.
	/// \return	true if the parameters are considered equivalent.
	bool operator==(const OptionalValue<T>& rhs) const
	{
		if (m_hasValue == true && rhs.m_hasValue == true)
		{
			return m_value == rhs.m_value;
		}
		else
		{
			return m_hasValue == rhs.m_hasValue;
		}
	}


	/// Equality operator.
	/// \param	rhs	The right hand side with the specific template type.
	/// \return	true if the parameters are considered equivalent.
	bool operator==(const T& rhs) const
	{
		if (m_hasValue)
		{
			return m_value == rhs;
		}
		else
		{
			return false;
		}
	}

	/// Inequality operator
	/// \param rhs the right hand side.
	/// \return true if the parameters are not considered equivalent
	bool operator!=(const OptionalValue<T>& rhs) const
	{
		return !(*this == rhs);
	}

	/// Inequality operator
	/// \param rhs the right hand side.
	/// \return true if the parameters are not considered equivalent
	bool operator!=(const T& rhs) const
	{
		return !(*this == rhs);
	}

	/// Assignment operator.
	/// \param rhs The right hand side of the operator.
	/// \return reference to this.
	OptionalValue& operator=(const OptionalValue& rhs)
	{
		m_hasValue = rhs.m_hasValue;
		if (m_hasValue)
		{
			m_value = rhs.m_value;
		}
		return *this;
	}

	/// Assignment operator from template type, after this hasValue() is true even if the
	/// right hand side was not initialized
	/// \param rhs the value to be assigned to this optional value
	/// \return reference to this.
	OptionalValue& operator=(const T& rhs)
	{
		setValue(rhs);
		return *this;
	}

private:
	bool m_hasValue;
	T m_value;
};

}; // Datastructures
}; // SurgSim

#endif