HPS::ConditionControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::ConditionControl:

Collaboration diagram for HPS::ConditionControl:

Public Member Functions
	ConditionControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	ConditionControl (ConditionControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	ConditionControl (ConditionControl &&in_that)
	The move constructor creates a ConditionControl by transferring the underlying impl of the rvalue reference to this ConditionControl thereby avoiding a copy and allocation. More...
ConditionControl &	operator= (ConditionControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ConditionControl thereby avoiding a copy. More...
	~ConditionControl ()
	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
ConditionControl &	operator= (ConditionControl const &in_that)
	Share the underlying smart-pointer of the ConditionControl source. More...
size_t	GetCount () const
	Retrieves the number of conditions set on this segment. More...
ConditionControl &	AddCondition (char const *in_condition)
	Adds a condition to the collection of active conditions on this segment. More...
ConditionControl &	SetCondition (char const *in_condition)
	Sets a condition as the only active condition on this segment, replacing any existing conditions. More...
ConditionControl &	SetConditions (UTF8Array const &in_conditions)
	Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions. More...
ConditionControl &	SetConditions (size_t in_count, UTF8 const in_conditions [])
	Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions. More...
ConditionControl &	UnsetCondition (char const *in_condition)
	Removes a specified condition from the active conditions on this segment. More...
ConditionControl &	UnsetEverything ()
	Unsets all conditions on this segment. More...
bool	ShowCondition (char const *in_condition) const
	Queries the existence of one condition on this segment. More...
bool	ShowConditions (UTF8Array &out_conditions) const
	Shows all conditions 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::ConditionControl

Private Member Functions
	ConditionControl ()
	Private default constructor to prevent instantiation without a segment. More...

Detailed Description

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

This class is used to set and unset conditions on a segment. A condition can be used to control when a style is applied, or to control when an included segment is included.

Constructor & Destructor Documentation

ConditionControl() [1/4]

HPS::ConditionControl::ConditionControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

ConditionControl() [2/4]

HPS::ConditionControl::ConditionControl

(

ConditionControl const &

in_that

)

Initializes a control tied to the same object as in_that.

ConditionControl() [3/4]

HPS::ConditionControl::ConditionControl

(

ConditionControl &&

in_that

)

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

Parameters

in_that

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

~ConditionControl()

HPS::ConditionControl::~ConditionControl

(

)

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

ConditionControl() [4/4]

HPS::ConditionControl::ConditionControl ( )

private

Private default constructor to prevent instantiation without a segment.

Member Function Documentation

AddCondition()

ConditionControl& HPS::ConditionControl::AddCondition

(

char const *

in_condition

)

Adds a condition to the collection of active conditions on this segment.

Parameters

in_condition

the condition to enable.

Returns

a reference to this object.

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::ConditionControl::GetCount

(

)

const

Retrieves the number of conditions set on this segment.

Returns

The number of conditions set on this segment.

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

ConditionControl& HPS::ConditionControl::operator=

(

ConditionControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ConditionControl.

operator=() [2/2]

ConditionControl& HPS::ConditionControl::operator=

(

ConditionControl const &

in_that

)

Share the underlying smart-pointer of the ConditionControl source.

Parameters

in_that

The ConditionControl source of the assignment.

Returns

A reference to this ConditionControl.

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.

SetCondition()

ConditionControl& HPS::ConditionControl::SetCondition

(

char const *

in_condition

)

Sets a condition as the only active condition on this segment, replacing any existing conditions.

Parameters

in_condition

the condition to enable.

Returns

a reference to this object.

SetConditions() [1/2]

ConditionControl& HPS::ConditionControl::SetConditions

(

UTF8Array const &

in_conditions

)

Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.

Parameters

in_conditions

An array of conditions to enable.

Returns

a reference to this object.

SetConditions() [2/2]

ConditionControl& HPS::ConditionControl::SetConditions	(	size_t	in_count,
		UTF8 const	in_conditions[]
	)

Sets a collection of conditions as the only active conditions on this segment, replacing any existing conditions.

Parameters

in_count	the number of conditions in the array.
in_conditions	An array of conditions to enable.

Returns

a reference to this object.

ShowCondition()

bool HPS::ConditionControl::ShowCondition

(

char const *

in_condition

)

const

Queries the existence of one condition on this segment.

Parameters

in_condition

The condition in question.

Returns

true if the setting is valid, false otherwise.

ShowConditions()

bool HPS::ConditionControl::ShowConditions

(

UTF8Array &

out_conditions

)

const

Shows all conditions on this segment.

Parameters

out_conditions

An array of conditions that are active on the segment.

Returns

true if any conditions are set, false otherwise.

Type()

virtual HPS::Type HPS::ConditionControl::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.

UnsetCondition()

ConditionControl& HPS::ConditionControl::UnsetCondition

(

char const *

in_condition

)

Removes a specified condition from the active conditions on this segment.

Parameters

in_condition

The condition to remove.

Returns

a reference to this object.

UnsetEverything()

ConditionControl& HPS::ConditionControl::UnsetEverything

(

)

Unsets all conditions on this segment.

Returns

a reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::ConditionControl::staticType = HPS::Type::ConditionControl

static

---

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

• hps.h