ReferenceKey

class ReferenceKey : public HPS::GeometryKey 

The ReferenceKey class is a smart pointer to a database object. It is a handle to a geometry reference returned by SegmentKey::ReferenceGeometry.

Public Functions

ModellingMatrixControl GetModellingMatrixControl()

Gets a control that allows querying and modifying modelling matrices set on this reference.

Returns:: A control that allows querying and modifying modelling matrices set on this reference.

ModellingMatrixControl const GetModellingMatrixControl() const

Gets a control that allows querying modelling matrices set on this reference.

Returns:: A control that allows querying modelling matrices set on this reference.

Key GetTarget() const

Gets the geometry or segment key that was used to create this ReferenceKey. If multiple geometry are referenced only the first is returned.

Returns:: The geometry or segment key that was used to create this ReferenceKey.

inline virtual HPS::Type ObjectType() const

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.

ReferenceKey &operator=(ReferenceKey &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ReferenceKey thereby avoiding a copy.

Parameters:: in_that – An rvalue reference to a ReferenceKey to take the impl from.
Returns:: A reference to this ReferenceKey.

ReferenceKey &operator=(ReferenceKey const &in_that)

Associate this ReferenceKey with the same underlying impl as the source ReferenceKey.

Parameters:: in_that – The source ReferenceKey for the assignment.
Returns:: A reference to this ReferenceKey.

ReferenceKey(): The default constructor creates an uninitialized ReferenceKey object. The Type() function will return Type::None.

explicit ReferenceKey(Key const &in_that)

This constructor creates an ReferenceKey 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 reference key. Otherwise the copy will fail and the resulting ReferenceKey will be invalid.

Parameters:: in_key – The source Key to copy.

ReferenceKey(ReferenceKey &&in_that)

The move constructor creates a ReferenceKey by transferring the underlying impl of the rvalue reference to this ReferenceKey thereby avoiding a copy and allocation.

Parameters:: in_that – An rvalue reference to a ReferenceKey to take the impl from.

ReferenceKey(ReferenceKey const &in_that)

The copy constructor creates a ReferenceKey object that shares the underlying smart-pointer of the source ReferenceKey.

Parameters:: in_that – The source ReferenceKey to copy.

ReferenceKey &SetConditionalExpression(ConditionalExpression const &in_conditional)

Sets a conditional expression on this ReferenceKey. This will either make an unconditional reference into a conditional reference, or modify the condition for an existing conditional reference. The target geometry or segment referenced by this reference will only be drawn in the owning segment if a condition satisfying the given conditional expression is set above this reference in the tree.