HPS::SearchResults Class Reference

The SearchResults class is a smart-pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::SearchResults:

Collaboration diagram for HPS::SearchResults:

Public Member Functions
	SearchResults ()
	The default constructor creates an empty SearchResults object, not associated with any search. More...
	SearchResults (SearchResults const &in_search_results)
	The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source. More...
	SearchResults (SearchResults &&in_that)
	The move constructor creates SearchResults by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation. More...
SearchResults &	operator= (SearchResults &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SearchResults thereby avoiding a copy. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
	~SearchResults ()
	The destructor decrements the number of users of the search results. If there are no remaining users, the results are released. More...
HPS::Type	ObjectType () const
void	Assign (SearchResults const &in_search_results)
	Share the underlying smart-pointer if the assignment source. More...
SearchResults &	operator= (SearchResults const &in_search_results)
	Share the underlying smart-pointer of the SearchResults source. More...
size_t	GetCount () const
	Gets the number of items that were found in the associated search. More...
SearchResultsIterator	GetIterator () const
	Returns a SearchResultsIterator used to iterate through the found search results. 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::SearchResults

Detailed Description

The SearchResults class is a smart-pointer to a database object.

It contains the results of a Find operation.

Constructor & Destructor Documentation

SearchResults() [1/3]

HPS::SearchResults::SearchResults

(

)

The default constructor creates an empty SearchResults object, not associated with any search.

SearchResults() [2/3]

HPS::SearchResults::SearchResults

(

SearchResults const &

in_search_results

)

The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source.

Parameters

in_search_results

The source of the copy.

SearchResults() [3/3]

HPS::SearchResults::SearchResults

(

SearchResults &&

in_that

)

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

Parameters

in_that

An rvalue reference to SearchResults to take the impl from.

~SearchResults()

HPS::SearchResults::~SearchResults

(

)

The destructor decrements the number of users of the search results. If there are no remaining users, the results are released.

Member Function Documentation

Assign()

void HPS::SearchResults::Assign

(

SearchResults const &

in_search_results

)

Share the underlying smart-pointer if the assignment source.

This method is functionally equivalent to the overloaded assignment operator except for the return value.

Parameters

in_search_results

The source of the assignment.

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.

GetCount()

size_t HPS::SearchResults::GetCount

(

)

const

Gets the number of items that were found in the associated search.

Returns

The number of unique items found.

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.

GetIterator()

SearchResultsIterator HPS::SearchResults::GetIterator

(

)

const

Returns a SearchResultsIterator used to iterate through the found search results.

Returns

An iterator pointing to the beginning of the search results list.

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::SearchResults::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Object.

operator=() [1/2]

SearchResults& HPS::SearchResults::operator=

(

SearchResults &&

in_that

)

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

Parameters

in_that

An rvalue reference to an SearchResults to take the impl from.

Returns

A reference to this SearchResults.

operator=() [2/2]

SearchResults& HPS::SearchResults::operator=

(

SearchResults const &

in_search_results

)

Share the underlying smart-pointer of the SearchResults source.

Parameters

in_that

The SearchResults source of the assignment.

Returns

A reference to this SearchResults.

Reset()

virtual void HPS::SearchResults::Reset ( )

virtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS::Object.

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::SearchResults::staticType = HPS::Type::SearchResults

static

---

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

• hps.h