HPS::SelectionResultsIterator Class Reference

The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it. More...

#include <hps.h>

Inheritance diagram for HPS::SelectionResultsIterator:

Collaboration diagram for HPS::SelectionResultsIterator:

Public Member Functions
	SelectionResultsIterator ()
	The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object. More...
	SelectionResultsIterator (SelectionResultsIterator const &in_that)
	The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results. More...
	SelectionResultsIterator (SelectionResultsIterator &&in_that)
	The move constructor creates a SelectionResultsIterator by transferring the underlying impl of the rvalue reference to this SelectionResultsIterator thereby avoiding a copy and allocation. More...
SelectionResultsIterator &	operator= (SelectionResultsIterator &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionResultsIterator thereby avoiding a copy. More...
	~SelectionResultsIterator ()
HPS::Type	ObjectType () const
SelectionResultsIterator &	operator= (SelectionResultsIterator const &in_that)
	Copies the source SelectionResultsIterator into this SelectionResultsIterator. More...
void	Set (SelectionResultsIterator const &in_that)
	Copies the source SelectionResultsIterator into this SelectionResultsIterator. More...
void	Next ()
	Advances the iterator to the next selection item. More...
SelectionResultsIterator &	operator++ ()
	The prefix increment operator advances this iterator and returns it. More...
SelectionResultsIterator	operator++ (int in_val)
	The postfix increment operator advances this iterator and returns a copy of the it prior to advancement. More...
bool	operator== (SelectionResultsIterator const &in_search_results_iterator)
	Comparison operator between iterators to compare equality. More...
bool	operator!= (SelectionResultsIterator const &in_search_results_iterator)
	Comparison operator between iterators to compare inequality. More...
bool	IsValid () const
	Indicates whether this SearchResultsIterator is pointing to a valid selection item. More...
void	Reset ()
	Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object. More...
SelectionItem	GetItem () const
	Get the selection item this SelectionResultsIterator is currently pointing at. More...
SelectionItem	operator* () const
	Get the selection item this SelectionResultsIterator is currently pointing at. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it.

Constructor & Destructor Documentation

SelectionResultsIterator() [1/3]

HPS::SelectionResultsIterator::SelectionResultsIterator

(

)

The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.

SelectionResultsIterator() [2/3]

HPS::SelectionResultsIterator::SelectionResultsIterator

(

SelectionResultsIterator const &

in_that

)

The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results.

Subsequent changes to either iterator will not affect the other.

Parameters

in_that

The source SelectionResultsIterator object to copy.

SelectionResultsIterator() [3/3]

HPS::SelectionResultsIterator::SelectionResultsIterator

(

SelectionResultsIterator &&

in_that

)

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

Parameters

in_that

An rvalue reference to a SelectionResultsIterator to take the impl from.

~SelectionResultsIterator()

HPS::SelectionResultsIterator::~SelectionResultsIterator

(

)

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()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

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.

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.

GetItem()

SelectionItem HPS::SelectionResultsIterator::GetItem

(

)

const

Get the selection item this SelectionResultsIterator is currently pointing at.

This will throw an exception if this iterator is not valid.

Returns

The selection item this SelectionResultsIterator is currently pointing at.

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.

IsValid()

bool HPS::SelectionResultsIterator::IsValid

(

)

const

Indicates whether this SearchResultsIterator is pointing to a valid selection item.

Returns

true if this SearchResultsIterator is pointing to a valid item, false otherwise.

Next()

void HPS::SelectionResultsIterator::Next

(

)

Advances the iterator to the next selection item.

ObjectType()

HPS::Type HPS::SelectionResultsIterator::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::SelectionResultsIterator::operator!=

(

SelectionResultsIterator const &

in_search_results_iterator

)

Comparison operator between iterators to compare inequality.

Parameters

in_search_results_iterator

The iterator to compare to

operator*()

SelectionItem HPS::SelectionResultsIterator::operator*

(

)

const

Get the selection item this SelectionResultsIterator is currently pointing at.

This will throw an exception if this iterator is not valid.

Returns

The selection item this SelectionResultsIterator is currently pointing at.

operator++() [1/2]

SelectionResultsIterator& HPS::SelectionResultsIterator::operator++

(

)

The prefix increment operator advances this iterator and returns it.

Returns

A reference to this SelectionResultsIterator.

operator++() [2/2]

SelectionResultsIterator HPS::SelectionResultsIterator::operator++

(

int

in_val

)

The postfix increment operator advances this iterator and returns a copy of the it prior to advancement.

Returns

A copy of this SelectionResultsIterator prior to having advanced it.

operator=() [1/2]

SelectionResultsIterator& HPS::SelectionResultsIterator::operator=

(

SelectionResultsIterator &&

in_that

)

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

Parameters

in_that

An rvalue reference to a SelectionResultsIterator to take the impl from.

Returns

A reference to this SelectionResultsIterator.

operator=() [2/2]

SelectionResultsIterator& HPS::SelectionResultsIterator::operator=

(

SelectionResultsIterator const &

in_that

)

Copies the source SelectionResultsIterator into this SelectionResultsIterator.

Parameters

in_that

The source SelectionResultsIterator to copy.

Returns

A reference to this SelectionResultsIterator.

operator==()

bool HPS::SelectionResultsIterator::operator==

(

SelectionResultsIterator const &

in_search_results_iterator

)

Comparison operator between iterators to compare equality.

Parameters

in_search_results_iterator

The iterator to compare to

Reset()

void HPS::SelectionResultsIterator::Reset ( )

virtual

Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.

Reimplemented from HPS::Object.

Set()

void HPS::SelectionResultsIterator::Set

(

SelectionResultsIterator const &

in_that

)

Copies the source SelectionResultsIterator into this SelectionResultsIterator.

Parameters

in_that

The source SelectionResultsIterator to copy.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::SelectionResultsIterator::staticType = HPS::Type::SelectionResultsIterator

static

---

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

• hps.h