LinePatternDefinition
-
class HPS::LinePatternDefinition : public HPS::Definition
The LinePatternDefinition class is a smart pointer to a database object. It is a handle to a line pattern defined within a portfolio.
Public Functions
-
LinePatternDefinition()
The default constructor creates an uninitialized LinePatternDefinition object. The Type() function will return Type::None.
-
LinePatternDefinition(Definition const &in_that)
This constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a line pattern definition. Otherwise the copy will fail and the resulting LinePatternDefinition will be invalid.
- Parameters
in_that – The source Definition to copy.
-
LinePatternDefinition(LinePatternDefinition &&in_that)
The move constructor creates a LinePatternDefinition by transferring the underlying impl of the rvalue reference to this LinePatternDefinition thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to a LinePatternDefinition to take the impl from.
-
LinePatternDefinition(LinePatternDefinition const &in_that)
The copy constructor creates a LinePatternDefinition object that shares the underlying smart-pointer of the source LinePatternDefinition.
- Parameters
in_that – The source LinePatternDefinition to copy.
-
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.
-
LinePatternDefinition &operator=(LinePatternDefinition &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternDefinition thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to a LinePatternDefinition to take the impl from.
- Returns
A reference to this LinePatternDefinition.
-
LinePatternDefinition &operator=(LinePatternDefinition const &in_that)
Associate this LinePatternDefinition with the same underlying impl as the source LinePatternDefinition.
- Parameters
in_that – The source LinePatternDefinition for the assignment.
- Returns
A reference to this LinePatternDefinition.
-
void Set(LinePatternKit const &in_kit)
Redefine the line pattern for this LinePatternDefinition.
- Parameters
in_kit – The new line pattern for this LinePatternDefinition.
-
void Show(LinePatternKit &out_kit) const
Shows the line pattern for this LinePatternDefinition.
- Parameters
out_kit – The line pattern for this LinePatternDefinition.
-
~LinePatternDefinition()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::LinePatternDefinition
-
LinePatternDefinition()
