An iterator used for traversing results from a search on an associated FontSearchResults object. More...
#include <hps.h>
Public Member Functions | |
FontSearchResultsIterator () | |
The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object. More... | |
FontSearchResultsIterator (FontSearchResultsIterator const &in_search_results_iterator) | |
The copy constructor initializes a new FontSearchResultsIterator object that is associated with the same FontSearchResults object as the source and at the same location in the results. More... | |
FontSearchResultsIterator (FontSearchResultsIterator &&in_that) | |
The move constructor creates FontSearchResultsIterator by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation. More... | |
FontSearchResultsIterator & | operator= (FontSearchResultsIterator const &in_search_results_iterator) |
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults object as the source and at the same location in the results. More... | |
FontSearchResultsIterator & | operator= (FontSearchResultsIterator &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this FontSearchResultsIterator thereby avoiding a copy. More... | |
~FontSearchResultsIterator () | |
HPS::Type | ObjectType () const |
void | Set (FontSearchResultsIterator const &in_search_results_iterator) |
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults object as the source and at the same location in the results. More... | |
void | Next () |
Advances the iterator to the next search result item. More... | |
FontSearchResultsIterator & | operator++ () |
Advances the iterator to the next search result item. More... | |
FontSearchResultsIterator | operator++ (int in_val) |
Advances the iterator to the next search result item. More... | |
bool | operator== (FontSearchResultsIterator const &in_search_results_iterator) |
Comparison operator between iterators to compare equality. More... | |
bool | operator!= (FontSearchResultsIterator const &in_search_results_iterator) |
Comparison operator between iterators to compare inequality. More... | |
bool | IsValid () const |
Queries the validity of this iterator location. More... | |
void | Reset () |
Resets iterator to the beginning of the associated search results. More... | |
FontInfoState | GetItem () const |
Returns the FontInfoState that this iterator is currently pointing at. More... | |
FontInfoState | operator* () const |
Returns the FontInfoState that this iterator 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::FontSearchResultsIterator |
An iterator used for traversing results from a search on an associated FontSearchResults object.
HPS::FontSearchResultsIterator::FontSearchResultsIterator | ( | ) |
The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object.
HPS::FontSearchResultsIterator::FontSearchResultsIterator | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
The copy constructor initializes a new FontSearchResultsIterator object that is associated with the same FontSearchResults object as the source and at the same location in the results.
Subsequent changes to either iterator will not affect the other.
in_search_results_iterator | The source of the copy. |
HPS::FontSearchResultsIterator::FontSearchResultsIterator | ( | FontSearchResultsIterator && | in_that | ) |
The move constructor creates FontSearchResultsIterator by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation.
in_that | An rvalue reference to FontSearchResultsIterator to take the impl from. |
HPS::FontSearchResultsIterator::~FontSearchResultsIterator | ( | ) |
|
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.
|
inlinevirtualinherited |
Indicates whether this object has any values set on it.
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.
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
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.
FontInfoState HPS::FontSearchResultsIterator::GetItem | ( | ) | const |
Returns the FontInfoState that this iterator is currently pointing at.
Throws exception if iterator is not valid. This method is functionally equivalent to the overloaded operator*.
|
inherited |
bool HPS::FontSearchResultsIterator::IsValid | ( | ) | const |
Queries the validity of this iterator location.
Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
void HPS::FontSearchResultsIterator::Next | ( | ) |
Advances the iterator to the next search result item.
|
inlinevirtual |
bool HPS::FontSearchResultsIterator::operator!= | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare inequality.
in_search_results_iterator | The iterator to compare to |
FontInfoState HPS::FontSearchResultsIterator::operator* | ( | ) | const |
Returns the FontInfoState that this iterator is currently pointing at.
Throws exception if iterator is not valid.
FontSearchResultsIterator& HPS::FontSearchResultsIterator::operator++ | ( | ) |
Advances the iterator to the next search result item.
FontSearchResultsIterator HPS::FontSearchResultsIterator::operator++ | ( | int | in_val | ) |
Advances the iterator to the next search result item.
FontSearchResultsIterator& HPS::FontSearchResultsIterator::operator= | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults object as the source and at the same location in the results.
Subsequent changes to either iterator will not affect the other.
in_search_results_iterator | The source of the copy. |
FontSearchResultsIterator& HPS::FontSearchResultsIterator::operator= | ( | FontSearchResultsIterator && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this FontSearchResultsIterator thereby avoiding a copy.
in_that | An rvalue reference to an FontSearchResultsIterator to take the impl from. |
bool HPS::FontSearchResultsIterator::operator== | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare equality.
in_search_results_iterator | The iterator to compare to |
|
virtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS::Object.
void HPS::FontSearchResultsIterator::Set | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults object as the source and at the same location in the results.
Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value.
in_search_results_iterator | The source of the copy. |
|
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.
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.
|
static |