HPS::PortfolioControl Class Reference

The PortfolioControl class is a smart pointer that is tied to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::PortfolioControl:

Collaboration diagram for HPS::PortfolioControl:

Public Member Functions
	PortfolioControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	PortfolioControl (PortfolioControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	PortfolioControl (PortfolioControl &&in_that)
	The move constructor creates a PortfolioControl by transferring the underlying impl of the rvalue reference to this StyleControl thereby avoiding a copy and allocation. More...
PortfolioControl &	operator= (PortfolioControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this PortfolioControl thereby avoiding a copy. More...
	~PortfolioControl ()
	Releases a reference to the database object this control is tied to. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
PortfolioControl &	operator= (PortfolioControl const &in_that)
	Share the underlying smart-pointer of the PortfolioControl source. More...
size_t	GetCount () const
	Returns the number of portfolios in use here. More...
PortfolioControl &	Push (PortfolioKey const &in_portfolio)
	Adds a portfolio to the top of the portfolio use stack. More...
bool	Pop ()
	Removes the top portfolio from the portfolio use stack. More...
bool	Pop (PortfolioKey &out_portfolio)
	Removes the top portfolio from the portfolio use stack and gives information about it to the user. More...
PortfolioControl &	Set (PortfolioKey const &in_portfolio)
	Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use. More...
PortfolioControl &	Set (PortfolioKeyArray const &in_portfolios)
	Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use. More...
PortfolioControl &	Set (size_t in_count, PortfolioKey const in_portfolios[])
	Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use. More...
PortfolioControl &	UnsetTop ()
	Removes the top portfolio from the portfolio use stack. More...
PortfolioControl &	UnsetEverything ()
	Removes all portfolios from the portfolio use stack. More...
bool	ShowTop (PortfolioKey &out_portfolio) const
	Shows the top portfolio on the portfolio use stack. More...
bool	Show (PortfolioKeyArray &out_portfolios) const
	Shows all portfolios in use on this segment. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Private Member Functions
	PortfolioControl ()

Detailed Description

The PortfolioControl class is a smart pointer that is tied to a database object.

Controls are used for manipulating settings within the database.

Constructor & Destructor Documentation

PortfolioControl() [1/4]

HPS::PortfolioControl::PortfolioControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

PortfolioControl() [2/4]

HPS::PortfolioControl::PortfolioControl

(

PortfolioControl const &

in_that

)

Initializes a control tied to the same object as in_that.

PortfolioControl() [3/4]

HPS::PortfolioControl::PortfolioControl

(

PortfolioControl &&

in_that

)

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

Parameters

in_that

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

~PortfolioControl()

HPS::PortfolioControl::~PortfolioControl

(

)

Releases a reference to the database object this control is tied to.

PortfolioControl() [4/4]

HPS::PortfolioControl::PortfolioControl ( )

private

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.

GetCount()

size_t HPS::PortfolioControl::GetCount

(

)

const

Returns the number of portfolios in use here.

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

PortfolioControl& HPS::PortfolioControl::operator=

(

PortfolioControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this PortfolioControl.

operator=() [2/2]

PortfolioControl& HPS::PortfolioControl::operator=

(

PortfolioControl const &

in_that

)

Share the underlying smart-pointer of the PortfolioControl source.

Parameters

in_that

The PortfolioControl source of the assignment.

Returns

A reference to this PortfolioControl.

Pop() [1/2]

bool HPS::PortfolioControl::Pop

(

)

Removes the top portfolio from the portfolio use stack.

Returns

true if a portfolio was present, false otherwise.

Pop() [2/2]

bool HPS::PortfolioControl::Pop

(

PortfolioKey &

out_portfolio

)

Removes the top portfolio from the portfolio use stack and gives information about it to the user.

Parameters

out_portfolio

The source portfolio.

Returns

true if a portfolio was present, false otherwise.

Push()

PortfolioControl& HPS::PortfolioControl::Push

(

PortfolioKey const &

in_portfolio

)

Adds a portfolio to the top of the portfolio use stack.

Existing portfolios in use are unmodified but portfolios on top take precedence if there are conflicting definitions.

Parameters

in_portfolio

The portfolio to push to the top of the portfolio use stack.

Returns

A reference to this object.

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() [1/3]

PortfolioControl& HPS::PortfolioControl::Set

(

PortfolioKey const &

in_portfolio

)

Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use.

Parameters

in_portfolio

A portfolio containing definitions that should be imported.

Returns

A reference to this object.

Set() [2/3]

PortfolioControl& HPS::PortfolioControl::Set

(

PortfolioKeyArray const &

in_portfolios

)

Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.

Parameters

in_portfolios

An array of source portfolios to be used.

Returns

A reference to this object.

Set() [3/3]

PortfolioControl& HPS::PortfolioControl::Set	(	size_t	in_count,
		PortfolioKey const	in_portfolios[]
	)

Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.

Parameters

in_count	The length of the source array.
in_portfolios	An array of source portfolios to be used.

Returns

A reference to this object.

Show()

bool HPS::PortfolioControl::Show

(

PortfolioKeyArray &

out_portfolios

)

const

Shows all portfolios in use on this segment.

Parameters

out_portfolios

Keys to all portfolios in use on this segment.

Returns

true if any portfolio was present, false otherwise.

ShowTop()

bool HPS::PortfolioControl::ShowTop

(

PortfolioKey &

out_portfolio

)

const

Shows the top portfolio on the portfolio use stack.

Parameters

out_portfolio

The portfolio on top of the stack.

Returns

true if a portfolio was present, false otherwise.

Type()

virtual HPS::Type HPS::PortfolioControl::Type ( ) const

inlinevirtual

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::Control.

UnsetEverything()

PortfolioControl& HPS::PortfolioControl::UnsetEverything

(

)

Removes all portfolios from the portfolio use stack.

Returns

A reference to this object.

UnsetTop()

PortfolioControl& HPS::PortfolioControl::UnsetTop

(

)

Removes the top portfolio from the portfolio use stack.

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::PortfolioControl::staticType = HPS::Type::PortfolioControl

static

---

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

• hps.h