API Search || Global Search
HPS::BlankLinePatternElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::BlankLinePatternElement:
HPS::LinePatternElement HPS::Object

Public Member Functions

 BlankLinePatternElement ()
 
 BlankLinePatternElement (LinePatternElement const &in_that)
 
 BlankLinePatternElement (BlankLinePatternElement const &in_that)
 
 BlankLinePatternElement (float in_size, LinePattern::SizeUnits in_units)
 
 BlankLinePatternElement (BlankLinePatternElement &&in_that)
 
HPS::Type ObjectType () const
 
BlankLinePatternElementoperator= (BlankLinePatternElement &&in_that)
 
- Public Member Functions inherited from HPS::LinePatternElement
bool Equals (LinePatternElement const &in_that) const
 
 LinePatternElement ()
 
 LinePatternElement (LinePatternElement const &in_that)
 
 LinePatternElement (LinePatternElement &&in_that)
 
bool operator!= (LinePatternElement const &in_that) const
 
LinePatternElementoperator= (LinePatternElement &&in_that)
 
LinePatternElementoperator= (LinePatternElement const &in_that)
 
bool operator== (LinePatternElement const &in_that) const
 
void Set (LinePatternElement const &in_that)
 
void SetSize (float in_size, LinePattern::SizeUnits in_units)
 
bool ShowSize (float &out_size, LinePattern::SizeUnits &out_units) const
 
- 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::BlankLinePatternElement
 
- Static Public Attributes inherited from HPS::LinePatternElement
static const HPS::Type staticType = HPS::Type::LinePatternElement
 
- 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 BlankLinePatternElement class is a user space object. It is used for specifying blank elements within a line pattern.

Constructor & Destructor Documentation

HPS::BlankLinePatternElement::BlankLinePatternElement ( )

The default constructor creates an empty BlankLinePatternElement object.

HPS::BlankLinePatternElement::BlankLinePatternElement ( LinePatternElement const &  in_that)

This constructor creates a BlankLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a blank line pattern element. Otherwise the copy will fail and the resulting BlankLinePatternElement will be invalid.

Parameters
in_thatThe source LinePatternElement to copy.
HPS::BlankLinePatternElement::BlankLinePatternElement ( BlankLinePatternElement const &  in_that)

The copy constructor creates a new BlankLinePatternElement object that contains the same settings as the source BlankLinePatternElement.

Parameters
in_thatThe source BlankLinePatternElement to copy.
HPS::BlankLinePatternElement::BlankLinePatternElement ( float  in_size,
LinePattern::SizeUnits  in_units 
)

This constructor creates a BlankLinePatternElement with a given size.

Parameters
in_sizeThe length of the BlankLinePatternElement.
in_unitsThe units for the length of the BlankLinePatternElement.
HPS::BlankLinePatternElement::BlankLinePatternElement ( BlankLinePatternElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to a BlankLinePatternElement to take the impl from.

Member Function Documentation

BlankLinePatternElement& HPS::BlankLinePatternElement::operator= ( BlankLinePatternElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to an BlankLinePatternElement to take the impl from.
Returns
A reference to this BlankLinePatternElement.

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