HPS::Exchange::ExportJTOptionsKit Class Reference

The HPS::Exchange::ExportJTOptionsKit class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportJTOptionsKit:

Collaboration diagram for HPS::Exchange::ExportJTOptionsKit:

Public Member Functions
	ExportJTOptionsKit ()
	The default constructor creates an empty ExportJTOptionsKit object. More...
	ExportJTOptionsKit (ExportJTOptionsKit const &in_kit)
	The copy constructor creates a new ExportJTOptionsKit object that contains the same settings as the source ExportJTOptionsKit. More...
	ExportJTOptionsKit (ExportJTOptionsKit &&in_that)
	The move constructor creates an ExportJTOptionsKit by transferring the underlying object of the rvalue reference to this ExportJTOptionsKit. More...
virtual	~ExportJTOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportJTOptionsKit const &in_kit)
	Copies the source ExportJTOptionsKit into this ExportJTOptionsKit. More...
void	Show (ExportJTOptionsKit &out_kit) const
	Copies this ExportJTOptionsKit into the given ExportJTOptionsKit. More...
ExportJTOptionsKit &	operator= (ExportJTOptionsKit const &in_kit)
	Copies the source ExportJTOptionsKit into this ExportJTOptionsKit. More...
ExportJTOptionsKit &	operator= (ExportJTOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportJTOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportJTOptionsKit has any values set on it. More...
bool	Equals (ExportJTOptionsKit const &in_kit) const
	Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit. More...
bool	operator== (ExportJTOptionsKit const &in_kit) const
	Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit. More...
bool	operator!= (ExportJTOptionsKit const &in_kit) const
	Check if the source ExportJTOptionsKit is not equivalent to this ExportJTOptionsKit. More...
ExportJTOptionsKit &	SetContent (JT::Content in_content)
	Sets the type of data to export. More...
ExportJTOptionsKit &	SetHiddenObjects (bool in_state)
	Sets whether to export hidden objects. More...
ExportJTOptionsKit &	SetPMI (bool in_state)
	Sets whether to export PMI. More...
ExportJTOptionsKit &	SetVersion (JT::Version in_version)
	Sets the version of the JT format to export. More...
ExportJTOptionsKit &	UnsetContent ()
	Removes the content export setting. More...
ExportJTOptionsKit &	UnsetHiddenObjects ()
	Removes the hidden objects export setting. More...
ExportJTOptionsKit &	UnsetPMI ()
	Removes the PMI export setting. More...
ExportJTOptionsKit &	UnsetVersion ()
	Removes the version export setting. More...
ExportJTOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportJTOptionsKit. More...
bool	ShowContent (JT::Content &out_content) const
	Shows the content export setting. More...
bool	ShowHiddenObjects (bool &out_state) const
	Shows the hidden object export setting. More...
bool	ShowPMI (bool &out_state) const
	Shows the PMI export setting. More...
bool	ShowVersion (JT::Version &out_version) const
	Shows the version export setting. 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 ExportJTOptionsKit	GetDefault ()
	Creates an ExportJTOptionsKit 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::ExchangeExportJTOptionsKit

Detailed Description

The HPS::Exchange::ExportJTOptionsKit class is a user space object.

It contains settings controlling how JT data is exported via Exchange. Calling HPS::Exchange::ExportJTOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

ExportJTOptionsKit() [1/3]

HPS::Exchange::ExportJTOptionsKit::ExportJTOptionsKit

(

)

The default constructor creates an empty ExportJTOptionsKit object.

ExportJTOptionsKit() [2/3]

HPS::Exchange::ExportJTOptionsKit::ExportJTOptionsKit

(

ExportJTOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportJTOptionsKit to copy.

ExportJTOptionsKit() [3/3]

HPS::Exchange::ExportJTOptionsKit::ExportJTOptionsKit

(

ExportJTOptionsKit &&

in_that

)

The move constructor creates an ExportJTOptionsKit by transferring the underlying object of the rvalue reference to this ExportJTOptionsKit.

Parameters

in_that

An rvalue reference to an ExportJTOptionsKit to take the underlying object from.

~ExportJTOptionsKit()

virtual HPS::Exchange::ExportJTOptionsKit::~ExportJTOptionsKit ( )

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::Exchange::ExportJTOptionsKit::Empty ( ) const

virtual

Indicates whether this ExportJTOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportJTOptionsKit::Equals

(

ExportJTOptionsKit const &

in_kit

)

const

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Parameters

in_kit

The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.

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 ExportJTOptionsKit HPS::Exchange::ExportJTOptionsKit::GetDefault ( )

static

Creates an ExportJTOptionsKit 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::ExportJT.

Returns

An ExportJTOptionsKit 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::Exchange::ExportJTOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportJTOptionsKit::operator!=

(

ExportJTOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::operator=

(

ExportJTOptionsKit const &

in_kit

)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters

in_kit

The source ExportJTOptionsKit to copy.

Returns

A reference to this ExportJTOptionsKit.

operator=() [2/2]

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::operator=

(

ExportJTOptionsKit &&

in_that

)

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

Parameters

in_that

An rvalue reference to an ExportJTOptionsKit to take the underlying object from.

Returns

A reference to this ExportJTOptionsKit.

operator==()

bool HPS::Exchange::ExportJTOptionsKit::operator==

(

ExportJTOptionsKit const &

in_kit

)

const

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Parameters

in_kit

The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.

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::Exchange::ExportJTOptionsKit::Set

(

ExportJTOptionsKit const &

in_kit

)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters

in_kit

The source ExportJTOptionsKit to copy.

SetContent()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetContent

(

JT::Content

in_content

)

Sets the type of data to export.

This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.

Parameters

in_content

The type of data to export.

Returns

A reference to this ExportJTOptionsKit.

See also

Default value

SetHiddenObjects()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetHiddenObjects

(

bool

in_state

)

Sets whether to export hidden objects.

This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWriteHiddenObjects.

Parameters

in_state

Whether to export hidden objects.

Returns

A reference to this ExportJTOptionsKit.

See also

Default value

SetPMI()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetPMI

(

bool

in_state

)

Sets whether to export PMI.

This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.

Parameters

in_state

Whether to export PMI.

Returns

A reference to this ExportJTOptionsKit.

See also

Default value

SetVersion()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::SetVersion

(

JT::Version

in_version

)

Sets the version of the JT format to export.

This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eJTVersion.

Parameters

in_version

The version of the JT format to export.

Returns

A reference to this ExportJTOptionsKit.

See also

Default value

Show()

void HPS::Exchange::ExportJTOptionsKit::Show

(

ExportJTOptionsKit &

out_kit

)

const

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

Parameters

out_kit

The ExportJTOptionsKit to populate with the contents of this ExportJTOptionsKit.

ShowContent()

bool HPS::Exchange::ExportJTOptionsKit::ShowContent

(

JT::Content &

out_content

)

const

Shows the content export setting.

Parameters

out_content

The type of data to export.

Returns

true if a content export setting was specified, false otherwise.

ShowHiddenObjects()

bool HPS::Exchange::ExportJTOptionsKit::ShowHiddenObjects

(

bool &

out_state

)

const

Shows the hidden object export setting.

Parameters

out_state

Whether to export hidden objects.

Returns

true if a hidden object export setting was specified, false otherwise.

ShowPMI()

bool HPS::Exchange::ExportJTOptionsKit::ShowPMI

(

bool &

out_state

)

const

Shows the PMI export setting.

Parameters

out_state

Whether to export PMI.

Returns

true if a PMI export setting was specified, false otherwise.

ShowVersion()

bool HPS::Exchange::ExportJTOptionsKit::ShowVersion

(

JT::Version &

out_version

)

const

Shows the version export setting.

Parameters

out_version

The version of the JT format to export.

Returns

true if a version export setting was specified, 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.

UnsetContent()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetContent

(

)

Removes the content export setting.

Returns

A reference to this ExportJTOptionsKit.

UnsetEverything()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportJTOptionsKit.

Returns

A reference to this ExportJTOptionsKit.

UnsetHiddenObjects()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetHiddenObjects

(

)

Removes the hidden objects export setting.

Returns

A reference to this ExportJTOptionsKit.

UnsetPMI()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetPMI

(

)

Removes the PMI export setting.

Returns

A reference to this ExportJTOptionsKit.

UnsetVersion()

ExportJTOptionsKit& HPS::Exchange::ExportJTOptionsKit::UnsetVersion

(

)

Removes the version export setting.

Returns

A reference to this ExportJTOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportJTOptionsKit::staticType = HPS::Type::ExchangeExportJTOptionsKit

static

---

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

• sprk_exchange.h