#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::MarkerKey |
|
static const HPS::Type | staticType = HPS::Type::GeometryKey |
|
static const HPS::Type | staticType = HPS::Type::Key |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey::InsertMarker.
◆ MarkerKey() [1/4]
HPS::MarkerKey::MarkerKey |
( |
| ) |
|
The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type::None.
◆ MarkerKey() [2/4]
HPS::MarkerKey::MarkerKey |
( |
Key const & |
in_that | ) |
|
|
explicit |
This constructor creates a MarkerKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Marker key. Otherwise the copy will fail and the resulting MarkerKey will be invalid.
- Parameters
-
in_that | The source Key to copy. |
◆ MarkerKey() [3/4]
HPS::MarkerKey::MarkerKey |
( |
MarkerKey const & |
in_that | ) |
|
The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.
- Parameters
-
◆ MarkerKey() [4/4]
HPS::MarkerKey::MarkerKey |
( |
MarkerKey && |
in_that | ) |
|
The move constructor creates a MarkerKey by transferring the underlying impl of the rvalue reference to this MarkerKey thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a MarkerKey to take the impl from. |
◆ Consume()
void HPS::MarkerKey::Consume |
( |
MarkerKit & |
in_kit | ) |
|
Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this MarkerKey. |
◆ ObjectType()
HPS::Type HPS::MarkerKey::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::GeometryKey.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerKey thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a MarkerKey to take the impl from. |
- Returns
- A reference to this MarkerKey.
◆ Set()
void HPS::MarkerKey::Set |
( |
MarkerKit const & |
in_kit | ) |
|
Replace those settings on this MarkerKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this MarkerKey. |
◆ SetPoint()
◆ Show()
void HPS::MarkerKey::Show |
( |
MarkerKit & |
out_kit | ) |
const |
Copy the contents of this MarkerKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this MarkerKey. |
◆ ShowPoint()
bool HPS::MarkerKey::ShowPoint |
( |
Point & |
out_point | ) |
const |
Shows the point for this MarkerKey.
- Parameters
-
- Returns
- true if a point was set, false otherwise.
The documentation for this class was generated from the following file: