HPS::OOC::ImportOptionsKit Class Reference

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

#include <sprk_ooc.h>

Inheritance diagram for HPS::OOC::ImportOptionsKit:

Collaboration diagram for HPS::OOC::ImportOptionsKit:

Public Member Functions
	ImportOptionsKit ()
	The default constructor creates an empty ImportOptionsKit object. More...
	ImportOptionsKit (ImportOptionsKit const &in_kit)
	The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
	ImportOptionsKit (ImportOptionsKit &&in_that)
	The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation. More...
ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy. More...
virtual	~ImportOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...
void	Show (ImportOptionsKit &out_kit) const
	Copies this ImportOptionsKit into the given ImportOptionsKit. More...
ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...
bool	Empty () const
	Indicates whether this ImportOptionsKit has any values set on it. More...
bool	Equals (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
bool	operator== (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
bool	operator!= (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit. More...
ImportOptionsKit &	SetTarget (HPS::Model const &in_target)
	Uses the Model to set the root segment, library segment, and portfolio where the data will be imported. More...
bool	ShowTarget (HPS::Model &out_model) const
	Shows the root and library segments and portfolio where the data will be imported. More...
ImportOptionsKit &	UnsetTarget ()
	Removes the target and library segments, and Model import state. More...
ImportOptionsKit &	SetManualUpdates (bool in_manual_updates)
	Configures the model to only load based on manual updates. More...
bool	ShowManualUpdates (bool &out_manual_updates) const
	Shows if the model is configured to only load based on manual updates. More...
ImportOptionsKit &	UnsetManualUpdates ()
	Removes the manual update setting. More...
ImportOptionsKit &	SetAreaHighlightTracker (HPS::OOC::AreaHighlightTracker &in_area_highlight_tracker)
	Sets the AreaHighlightTracker. More...
ImportOptionsKit &	UnsetAreaHighlightTracker ()
	Removes the AreaHighlightTracker. More...
ImportOptionsKit &	UnsetEverything ()
	Removes all settings from this ImportOptionsKit. 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 ImportOptionsKit	GetDefault ()
	Creates an ImportOptionsKit which contains the default settings. More...
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The ImportOptionsKit class is a user space object.

It contains settings controlling what and how data is imported via OOC.

Constructor & Destructor Documentation

ImportOptionsKit() [1/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit

(

)

The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit() [2/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit

(

ImportOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ImportOptionsKit to copy.

ImportOptionsKit() [3/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit

(

ImportOptionsKit &&

in_that

)

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

Parameters

in_that

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

~ImportOptionsKit()

virtual HPS::OOC::ImportOptionsKit::~ImportOptionsKit ( )

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::OOC::ImportOptionsKit::Empty ( ) const

virtual

Indicates whether this ImportOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::OOC::ImportOptionsKit::Equals

(

ImportOptionsKit const &

in_kit

)

const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

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 ImportOptionsKit HPS::OOC::ImportOptionsKit::GetDefault ( )

static

Creates an ImportOptionsKit which contains the default settings.

The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::Import.

Returns

An ImportOptionsKit with the default settings.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::OOC::ImportOptionsKit::operator!=

(

ImportOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ImportOptionsKit& HPS::OOC::ImportOptionsKit::operator=

(

ImportOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ImportOptionsKit.

operator=() [2/2]

ImportOptionsKit& HPS::OOC::ImportOptionsKit::operator=

(

ImportOptionsKit const &

in_kit

)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to copy.

Returns

A reference to this ImportOptionsKit.

operator==()

bool HPS::OOC::ImportOptionsKit::operator==

(

ImportOptionsKit const &

in_kit

)

const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

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::OOC::ImportOptionsKit::Set

(

ImportOptionsKit const &

in_kit

)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to copy.

SetAreaHighlightTracker()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetAreaHighlightTracker

(

HPS::OOC::AreaHighlightTracker &

in_area_highlight_tracker

)

Sets the AreaHighlightTracker.

Parameters

in_area_highlight_tracker

The AreaHighlightTracker to use for this

Returns

A reference to this ImportOptionsKit.

Note

You should pass in an instance of a class that derives from AreaHighlightTracker that implements your desired behavior.

SetManualUpdates()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetManualUpdates

(

bool

in_manual_updates

)

Configures the model to only load based on manual updates.

Parameters

in_manual_updates

The new manual update setting

Returns

A reference to this ImportOptionsKit.

SetTarget()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetTarget

(

HPS::Model const &

in_target

)

Uses the Model to set the root segment, library segment, and portfolio where the data will be imported.

Parameters

in_model

Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.

Returns

A reference to this ImportOptionsKit.

Show()

void HPS::OOC::ImportOptionsKit::Show

(

ImportOptionsKit &

out_kit

)

const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters

out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

ShowManualUpdates()

bool HPS::OOC::ImportOptionsKit::ShowManualUpdates

(

bool &

out_manual_updates

)

const

Shows if the model is configured to only load based on manual updates.

Parameters

out_manual_updates

The current manual update setting

Returns

Returns false if there is no manual update setting.

ShowTarget()

bool HPS::OOC::ImportOptionsKit::ShowTarget

(

HPS::Model &

out_model

)

const

Shows the root and library segments and portfolio where the data will be imported.

If no segments are specified, root segments will be created for this purpose during import.

Parameters

out_model

Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.

Returns

Returns false if there is no target, false otherwise.

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.

UnsetAreaHighlightTracker()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetAreaHighlightTracker

(

)

Removes the AreaHighlightTracker.

Returns

A reference to this ImportOptionsKit.

UnsetEverything()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetEverything

(

)

Removes all settings from this ImportOptionsKit.

Returns

A reference to this ImportOptionsKit.

UnsetManualUpdates()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetManualUpdates

(

)

Removes the manual update setting.

Returns

A reference to this ImportOptionsKit.

UnsetTarget()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetTarget

(

)

Removes the target and library segments, and Model import state.

Returns

A reference to this ImportOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::OOC::ImportOptionsKit::staticType = HPS::Type::OOCImportOptionsKit

static

---

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

• sprk_ooc.h