The LinePatternKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::LinePatternKit:

Collaboration diagram for HPS::LinePatternKit:

Public Member Functions
	LinePatternKit ()
	The default constructor creates an empty LinePatternKit object. More...

	LinePatternKit (LinePatternKit const &in_kit)
	The copy constructor creates a new LinePatternKit object that contains the same settings as the source LinePatternKit. More...

	LinePatternKit (LinePatternKit &&in_that)
	The move constructor creates a LinePatternKit by transferring the underlying impl of the rvalue reference to this LinePatternKit thereby avoiding a copy and allocation. More...

LinePatternKit &	operator= (LinePatternKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternKit thereby avoiding a copy. More...

virtual	~LinePatternKit ()

HPS::Type	ObjectType () const

void	Set (LinePatternKit const &in_kit)
	Copies the source LinePatternKit into this LinePatternKit. More...

void	Show (LinePatternKit &out_kit) const
	Copies this LinePatternKit into the given LinePatternKit. More...

LinePatternKit &	operator= (LinePatternKit const &in_kit)
	Copies the source LinePatternKit into this LinePatternKit. More...

bool	Empty () const
	Indicates whether this LinePatternKit has any values set on it. More...

bool	Equals (LinePatternKit const &in_kit) const
	Check if the source LinePatternKit is equivalent to this LinePatternKit. More...

bool	operator== (LinePatternKit const &in_kit) const
	Check if the source LinePatternKit is equivalent to this LinePatternKit. More...

bool	operator!= (LinePatternKit const &in_kit) const
	Check if the source LinePatternKit is not equivalent to this LinePatternKit. More...

LinePatternKit &	SetParallels (LinePatternParallelKitArray const &in_parallels)
	Sets the line pattern parallel array for this LinePatternKit. More...

LinePatternKit &	SetParallels (size_t in_count, LinePatternParallelKit const in_parallels [])
	Sets the line pattern parallel array for this LinePatternKit. More...

LinePatternKit &	SetParallel (LinePatternParallelKit const &in_parallel)
	Sets the line pattern parallel for this LinePatternKit. More...

LinePatternKit &	SetJoin (LinePattern::Join in_type)
	Sets the type of join to use for this LinePatternKit. More...

LinePatternKit &	UnsetParallels ()
	Removes the line pattern parallel array for this LinePatternKit. More...

LinePatternKit &	UnsetJoin ()
	Removes the type of join to use for this LinePatternKit. More...

LinePatternKit &	UnsetEverything ()
	Removes all settings from this LinePatternKit. More...

bool	ShowParallels (LinePatternParallelKitArray &out_parallels) const
	Shows the line pattern parallel array for this LinePatternKit. More...

bool	ShowJoin (LinePattern::Join &out_type) const
	Shows the type of join to use for this LinePatternKit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static HPS::LinePatternKit	GetDefault (LinePattern::Default in_default_line_pattern)
	Creates a LinePatternKit which contains the definition of the specified default line pattern. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::LinePatternKit

Detailed Description

The LinePatternKit class is a user space object.

It is used when defining a line pattern.

Constructor & Destructor Documentation

◆ LinePatternKit() [1/3]

HPS::LinePatternKit::LinePatternKit ( )

The default constructor creates an empty LinePatternKit object.

◆ LinePatternKit() [2/3]

HPS::LinePatternKit::LinePatternKit ( LinePatternKit const & in_kit )

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

Parameters

in_kit The source LinePatternKit to copy.

◆ LinePatternKit() [3/3]

HPS::LinePatternKit::LinePatternKit ( LinePatternKit && in_that )

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

Parameters

in_that An rvalue reference to a LinePatternKit to take the impl from.

◆ ~LinePatternKit()

virtual HPS::LinePatternKit::~LinePatternKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::LinePatternKit::Empty ( ) const

virtual

Indicates whether this LinePatternKit has any values set on it.

Returns: true if no values are set on this LinePatternKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::LinePatternKit::Equals ( LinePatternKit const & in_kit ) const

Check if the source LinePatternKit is equivalent to this LinePatternKit.

Parameters

in_kit The source LinePatternKit to compare to this LinePatternKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static HPS::LinePatternKit HPS::LinePatternKit::GetDefault ( LinePattern::Default in_default_line_pattern )

static

Creates a LinePatternKit which contains the definition of the specified default line pattern.

Parameters

in_default_line_pattern The default line pattern for which to get the corresponding LinePatternKit.

Returns: A LinePatternKit which contains the definition of the specified default line pattern.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::LinePatternKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::LinePatternKit::operator!= ( LinePatternKit const & in_kit ) const

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

Parameters

in_kit The source LinePatternKit to compare to this LinePatternKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a LinePatternKit to take the impl from.

Returns: A reference to this LinePatternKit.

◆ operator=() [2/2]

LinePatternKit& HPS::LinePatternKit::operator= ( LinePatternKit const & in_kit )

Copies the source LinePatternKit into this LinePatternKit.

Parameters

in_kit The source LinePatternKit to copy.

Returns: A reference to this LinePatternKit.

◆ operator==()

bool HPS::LinePatternKit::operator== ( LinePatternKit const & in_kit ) const

Check if the source LinePatternKit is equivalent to this LinePatternKit.

Parameters

in_kit The source LinePatternKit to compare to this LinePatternKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source LinePatternKit into this LinePatternKit.

Parameters

in_kit The source LinePatternKit to copy.

◆ SetJoin()

LinePatternKit& HPS::LinePatternKit::SetJoin ( LinePattern::Join in_type )

Sets the type of join to use for this LinePatternKit.

Parameters

in_type The type of join to use for this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ SetParallel()

LinePatternKit& HPS::LinePatternKit::SetParallel ( LinePatternParallelKit const & in_parallel )

Sets the line pattern parallel for this LinePatternKit.

Parameters

in_parallel The line pattern parallel for this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ SetParallels() [1/2]

LinePatternKit& HPS::LinePatternKit::SetParallels ( LinePatternParallelKitArray const & in_parallels )

Sets the line pattern parallel array for this LinePatternKit.

Parameters

in_parallels The line pattern parallel array for this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ SetParallels() [2/2]

LinePatternKit& HPS::LinePatternKit::SetParallels	(	size_t	in_count,
		LinePatternParallelKit const	in_parallels[]
	)

Sets the line pattern parallel array for this LinePatternKit.

Parameters

in_count	Size of the following array.
in_parallels	The line pattern parallel array for this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ Show()

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

Copies this LinePatternKit into the given LinePatternKit.

Parameters

out_kit The LinePatternKit to populate with the contents of this LinePatternKit.

◆ ShowJoin()

bool HPS::LinePatternKit::ShowJoin ( LinePattern::Join & out_type ) const

Shows the type of join to use for this LinePatternKit.

Parameters

out_type The type of join to use for this LinePatternKit.

Returns: true if a join was set, false otherwise.

◆ ShowParallels()

bool HPS::LinePatternKit::ShowParallels ( LinePatternParallelKitArray & out_parallels ) const

Shows the line pattern parallel array for this LinePatternKit.

Parameters

out_parallels The line pattern parallel array for this LinePatternKit.

Returns: true if a line pattern parallel array was set, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetEverything()

LinePatternKit& HPS::LinePatternKit::UnsetEverything ( )

Removes all settings from this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ UnsetJoin()

LinePatternKit& HPS::LinePatternKit::UnsetJoin ( )

Removes the type of join to use for this LinePatternKit.

Returns: A reference to this LinePatternKit.

◆ UnsetParallels()

LinePatternKit& HPS::LinePatternKit::UnsetParallels ( )

Removes the line pattern parallel array for this LinePatternKit.

Returns: A reference to this LinePatternKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::LinePatternKit::staticType = HPS::Type::LinePatternKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LinePatternKit() [1/3]

◆ LinePatternKit() [2/3]

◆ LinePatternKit() [3/3]

◆ ~LinePatternKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetJoin()

◆ SetParallel()

◆ SetParallels() [1/2]

◆ SetParallels() [2/2]

◆ Show()

◆ ShowJoin()

◆ ShowParallels()

◆ Type()

◆ UnsetEverything()

◆ UnsetJoin()

◆ UnsetParallels()

Member Data Documentation

◆ staticType