HPS::Exchange::Sheet

class HPS::Exchange::Sheet : public HPS::Exchange::Component

The Sheet class is a user space object. It allows users to activate drawing sheets imported via Exchange.

Public Functions

HPS::View Activate()

Activates this sheet.

Returns

the View.

bool Equals(Sheet const &in_kit) const

Check if the source Sheet is equivalent to this Sheet.

Parameters

in_kit – The source Sheet to compare to this Sheet.

Returns

true if the objects are equivalent, false otherwise.

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.

bool operator!=(Sheet const &in_kit) const

Check if the source Sheet is not equivalent to this Sheet.

Parameters

in_kit – The source Sheet to compare to this Sheet.

Returns

true if the objects are not equivalent, false otherwise.

Sheet &operator=(Sheet &&in_that)

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

Parameters

in_that – An rvalue reference to a Sheet to take the impl from.

Returns

A reference to this Sheet.

bool operator==(Sheet const &in_kit) const

Check if the source Sheet is equivalent to this Sheet.

Parameters

in_kit – The source Sheet to compare to this Sheet.

Returns

true if the objects are equivalent, false otherwise.

Sheet()

The default constructor creates an empty Sheet object.

Sheet(Component const &in_that)

This constructor creates a Sheet object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange::Sheet object. Otherwise the copy will fail and the resulting Exchange::Sheet will be invalid.

Parameters

in_that – The source Component to copy.

Sheet(HPS::Component const &in_that)

This constructor creates a Sheet object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange::Sheet object. Otherwise the copy will fail and the resulting Exchange::Sheet will be invalid.

Parameters

in_that – The source Component to copy.

Sheet(Sheet &&in_that)

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

Parameters

in_that – An rvalue reference to a Sheet to take the impl from.

Sheet(Sheet const &in_sheet)

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

Parameters

in_sheet – The source Sheet to copy.

virtual ~Sheet()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeSheet