HPS::LinePatternDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::LinePatternDefinition:
HPS::Definition HPS::Object

Public Member Functions

 LinePatternDefinition ()
 
 LinePatternDefinition (Definition const &in_that)
 
 LinePatternDefinition (LinePatternDefinition const &in_that)
 
 LinePatternDefinition (LinePatternDefinition &&in_that)
 
HPS::Type ObjectType () const
 
LinePatternDefinitionoperator= (LinePatternDefinition const &in_that)
 
LinePatternDefinitionoperator= (LinePatternDefinition &&in_that)
 
void Set (LinePatternKit const &in_kit)
 
void Show (LinePatternKit &out_kit) const
 
- Public Member Functions inherited from HPS::Definition
virtual void Assign (Definition const &in_that)
 
 Definition ()
 
 Definition (Definition const &in_that)
 
 Definition (Definition &&in_that)
 
bool Equals (Definition const &in_that) const
 
UTF8 Name () const
 
bool operator!= (Definition const &in_that) const
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LinePatternDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The LinePatternDefinition class is a smart pointer to a database object. It is a handle to a line pattern defined within a portfolio.

Constructor & Destructor Documentation

◆ LinePatternDefinition() [1/4]

HPS::LinePatternDefinition::LinePatternDefinition ( )

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

◆ LinePatternDefinition() [2/4]

HPS::LinePatternDefinition::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_thatThe source Definition to copy.

◆ LinePatternDefinition() [3/4]

HPS::LinePatternDefinition::LinePatternDefinition ( LinePatternDefinition const &  in_that)

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

Parameters
in_thatThe source LinePatternDefinition to copy.

◆ LinePatternDefinition() [4/4]

HPS::LinePatternDefinition::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_thatAn rvalue reference to a LinePatternDefinition to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::LinePatternDefinition::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::Definition.

◆ operator=() [1/2]

LinePatternDefinition& HPS::LinePatternDefinition::operator= ( LinePatternDefinition const &  in_that)

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

Parameters
in_thatThe source LinePatternDefinition for the assignment.
Returns
A reference to this LinePatternDefinition.

◆ operator=() [2/2]

LinePatternDefinition& HPS::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_thatAn rvalue reference to a LinePatternDefinition to take the impl from.
Returns
A reference to this LinePatternDefinition.

◆ Set()

void HPS::LinePatternDefinition::Set ( LinePatternKit const &  in_kit)

Redefine the line pattern for this LinePatternDefinition.

Parameters
in_kitThe new line pattern for this LinePatternDefinition.

◆ Show()

void HPS::LinePatternDefinition::Show ( LinePatternKit out_kit) const

Shows the line pattern for this LinePatternDefinition.

Parameters
out_kitThe line pattern for this LinePatternDefinition.

The documentation for this class was generated from the following file: