HPS::StringMetadata Class Reference

The StringMetadata class is a smart pointer. More...

#include <sprk.h>

Inheritance diagram for HPS::StringMetadata:

Collaboration diagram for HPS::StringMetadata:

Public Member Functions
	StringMetadata ()
	The default constructor creates an uninitialized StringMetadata object. More...
	StringMetadata (Metadata const &in_that)
	This constructor creates a StringMetadata object that shares the underlying smart-pointer of the source Metadata. More...
	StringMetadata (StringMetadata const &in_that)
	The copy constructor creates a StringMetadata object that shares the underlying smart-pointer of the source StringMetadata. More...
	StringMetadata (StringMetadata &&in_that)
	The move constructor creates a StringMetadata by transferring the underlying object of the rvalue reference to this StringMetadata. More...
	StringMetadata (char const *in_name, char const *in_value)
	This constructor creates a StringMetadata with a given name and value. More...
virtual	~StringMetadata ()
HPS::Type	ObjectType () const
StringMetadata &	operator= (StringMetadata const &in_that)=default
StringMetadata &	operator= (StringMetadata &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this StringMetadata. More...
UTF8	GetValue () const
	Gets the string value for this StringMetadata. More...
void	SetValue (char const *in_value)
	Sets the string value for this StringMetadata. More...
virtual void	Assign (Metadata const &in_that)
	Share the underlying smart-pointer of the Metadata source. More...
bool	Equals (Metadata const &in_that) const
	Check if the source Metadata points to the same underlying impl as this Metadata. More...
bool	operator!= (Metadata const &in_that) const
	Check if the source Metadata points to a different impl than this Metadata. More...
bool	operator== (Metadata const &in_that) const
	Check if the source Metadata points to the same underlying impl as this Metadata. More...
HPS::UTF8	GetName () const
	Gets the name for this Metadata. More...
void	SetName (char const *in_name)
	Sets the name for this Metadata. 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...
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::StringMetadata

Detailed Description

The StringMetadata class is a smart pointer.

It represents a piece of string Metadata.

Constructor & Destructor Documentation

StringMetadata() [1/5]

HPS::StringMetadata::StringMetadata

(

)

The default constructor creates an uninitialized StringMetadata object.

The Type() function will return Type::None.

StringMetadata() [2/5]

HPS::StringMetadata::StringMetadata

(

Metadata const &

in_that

)

This constructor creates a StringMetadata object that shares the underlying smart-pointer of the source Metadata.

The copy will only be successful if the source component is really an upcast of a StringMetadata object. Otherwise the copy will fail and the resulting StringMetadata will be invalid.

Parameters

in_that

The source Metadata to copy.

StringMetadata() [3/5]

HPS::StringMetadata::StringMetadata

(

StringMetadata const &

in_that

)

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

Parameters

in_that

The source StringMetadata to copy.

StringMetadata() [4/5]

HPS::StringMetadata::StringMetadata

(

StringMetadata &&

in_that

)

The move constructor creates a StringMetadata by transferring the underlying object of the rvalue reference to this StringMetadata.

Parameters

in_that

An rvalue reference to a StringMetadata to take the underlying object from.

StringMetadata() [5/5]

HPS::StringMetadata::StringMetadata	(	char const *	in_name,
		char const *	in_value
	)

This constructor creates a StringMetadata with a given name and value.

Parameters

in_name	The UTF8-encoded name for this StringMetadata.
in_value	The UTF8-encoded string value for this StringMetadata.

~StringMetadata()

virtual HPS::StringMetadata::~StringMetadata ( )

virtual

Member Function Documentation

Assign()

virtual void HPS::Metadata::Assign ( Metadata const &  in_that )

virtualinherited

Share the underlying smart-pointer of the Metadata source.

Parameters

in_that

The Metadata source of the assignment.

Returns

A reference to this Metadata.

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.

Equals()

bool HPS::Metadata::Equals ( Metadata const &  in_that ) const

inherited

Check if the source Metadata points to the same underlying impl as this Metadata.

Parameters

in_that

The source Metadata to compare to this Metadata.

Returns

true if the objects reference the same impl, 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.

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.

GetName()

HPS::UTF8 HPS::Metadata::GetName ( ) const

inherited

Gets the name for this Metadata.

Returns

The name for this Metadata.

GetValue()

UTF8 HPS::StringMetadata::GetValue

(

)

const

Gets the string value for this StringMetadata.

Returns

The string value for this StringMetadata.

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

inlinevirtual

Reimplemented from HPS::Metadata.

operator!=()

bool HPS::Metadata::operator!= ( Metadata const &  in_that ) const

inherited

Check if the source Metadata points to a different impl than this Metadata.

Parameters

in_that

The source Metadata to compare to this Metadata.

Returns

true if the objects reference different impls, false otherwise.

operator=() [1/2]

StringMetadata& HPS::StringMetadata::operator= ( StringMetadata const &  in_that )

default

operator=() [2/2]

StringMetadata& HPS::StringMetadata::operator=

(

StringMetadata &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this StringMetadata.

Parameters

in_that

An rvalue reference to a StringMetadata to take the underlying object from.

Returns

A reference to this StringMetadata.

operator==()

bool HPS::Metadata::operator== ( Metadata const &  in_that ) const

inherited

Check if the source Metadata points to the same underlying impl as this Metadata.

Parameters

in_that

The source Metadata to compare to this Metadata.

Returns

true if the objects reference the same impl, 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.

SetName()

void HPS::Metadata::SetName ( char const *  in_name )

inherited

Sets the name for this Metadata.

Parameters

in_name

A UTF8-encoded name for this Metadata.

SetValue()

void HPS::StringMetadata::SetValue

(

char const *

in_value

)

Sets the string value for this StringMetadata.

Parameters

in_value

The UTF8-encoded string value for this StringMetadata.

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

static

---

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

• sprk.h