NXOpen::ToolDesigner::SelectDatumsBuilder Class Reference

SelectDatumsBuilder
To create a new instance of this class, use NXOpen::ToolDesigner::ToolDesignerManager::CreateSelectDatumsBuilder
Default values. More...

Inheritance diagram for NXOpen::ToolDesigner::SelectDatumsBuilder:

Public Types
enum	ConesDir { ConesDirXDir, ConesDirYDir, ConesDirZDir }
	Represents the cones direction options. More...
enum	DatumCleanAPINames { DatumCleanAPINamesAvailable, DatumCleanAPINamesAssaignedPro, DatumCleanAPINamesAssaignedStation }
	Represents the attribute to clean options. More...
enum	SearchOption {   SearchOptionStationID, SearchOptionStationName, SearchOptionOriginalProduct, SearchOptionSpecificProduct,   SearchOptionVolumeScope }
	Represents search options. More...
enum	Type { TypeId, TypeName }
	SEARCH TYPES Names. More...

Public Member Functions
void	AddDatumsButton ()
	TODO: fill in a description for this Created in NX10.0.0. More...
void	Assign (const std::vector< NXOpen::TaggedObject * > &selections)
	The update after assigned Created in NX11.0.0. More...
void	ClearProductSelection ()
	The product selection clear function Created in NX11.0.1. More...
void	ClearSearchByProductSelection ()
	The product selection clear function Created in NX11.0.1. More...
void	CreateConesForDatumByDirection (NXOpen::TaggedObject *dfDatum, NXOpen::ToolDesigner::SelectDatumsBuilder::ConesDir number)
	The create cones for datum by direction Created in NX11.0.0. More...
void	GetAvaiableDatums (std::vector< NXOpen::TaggedObject * > &datums)
	The init assaigned datums for product Created in NX11.0.0. More...
void	InitAssaignedDatumsForProductList (std::vector< NXOpen::TaggedObject * > &datums)
	The init assaigned datums for product Created in NX11.0.0. More...
void	PopulateUnselectedDatumsList ()
	The builder populate un selected datums list Created in NX11.0.0. More...
NXOpen::SelectTaggedObject *	ProductSelection ()
	Returns the product selection Created in NX11.0.2. More...
void	RemoveDatumsButton ()
	TODO: fill in a description for this Created in NX10.0.0. More...
void	RemoveDatumsFromSession (bool removeAssignDatums)
	Remove all unselected datums from their subset Created in NX10.0.0. More...
NXOpen::SelectPartList *	SearchByProductSelection ()
	Returns the search by specific product selection Created in NX10.0.0. More...
void	SearchDatumsInStationByProperty (NXOpen::ToolDesigner::SelectDatumsBuilder::Type enum0, const NXString &searchValue)
	Search for a station by property and gets its assigned datums Created in NX12.0.0. More...
void	SearchDatumsInStationByProperty (NXOpen::ToolDesigner::SelectDatumsBuilder::Type enum0, const char *searchValue)
	Search for a station by property and gets its assigned datums Created in NX12.0.0. More...
NXOpen::ToolDesigner::SelectDatumsBuilder::SearchOption	SearchTypes ()
	Returns the SearchOptions Created in NX11.0.1. More...
void	SetProductSelection (NXOpen::TaggedObject *productSelection)
	Set the product selection Created in NX11.0.2. More...
void	SetSearchByProductSelection (NXOpen::TaggedObject *productSelection)
	Set the search by product selection Created in NX11.0.1. More...
void	SetSearchTypes (NXOpen::ToolDesigner::SelectDatumsBuilder::SearchOption val)
	Sets the SearchOptions Created in NX11.0.2. More...
void	SetXSumInteger (int xSumInteger)
	Sets the x sum integer Created in NX10.0.0. More...
void	SetYSumInteger (int ySumInteger)
	Sets the y sum integer Created in NX10.0.0. More...
void	SetZSumInteger (int zSumInteger)
	Sets the z sum integer Created in NX10.0.0. More...
void	UnAssign (const std::vector< NXOpen::TaggedObject * > &selections)
	The update after un assigned Created in NX11.0.0. More...
void	VolumeSearch (const NXOpen::Point3d &bottomVertex, const NXOpen::Point3d &upperVertex, NXOpen::TaggedObject *selectedObject)
	Search for all the datums inside a certain box Created in NX11.0.1. More...
int	XSumInteger ()
	Returns the x sum integer Created in NX10.0.0. More...
int	YSumInteger ()
	Returns the y sum integer Created in NX10.0.0. More...
int	ZSumInteger ()
	Returns the z sum integer Created in NX10.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

SelectDatumsBuilder
To create a new instance of this class, use NXOpen::ToolDesigner::ToolDesignerManager::CreateSelectDatumsBuilder
Default values.

Property	Value
XSumInteger	0
YSumInteger	0
ZSumInteger	0

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::ToolDesigner::SelectDatumsBuilder::ConesDir

Represents the cones direction options.

Enumerator
ConesDirXDir	xdir
ConesDirYDir	ydir
ConesDirZDir	zdir

enum NXOpen::ToolDesigner::SelectDatumsBuilder::DatumCleanAPINames

Represents the attribute to clean options.

Enumerator
DatumCleanAPINamesAvailable	available
DatumCleanAPINamesAssaignedPro	assaigned pro
DatumCleanAPINamesAssaignedStation	assaigned station

enum NXOpen::ToolDesigner::SelectDatumsBuilder::SearchOption

Represents search options.

Enumerator
SearchOptionStationID	station id
SearchOptionStationName	station name
SearchOptionOriginalProduct	original product
SearchOptionSpecificProduct	specific product
SearchOptionVolumeScope	volume scope

enum NXOpen::ToolDesigner::SelectDatumsBuilder::Type

SEARCH TYPES Names.

Enumerator
TypeId	id
TypeName	name

Member Function Documentation

void NXOpen::ToolDesigner::SelectDatumsBuilder::AddDatumsButton

(

)

TODO: fill in a description for this
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::Assign

(

const std::vector< NXOpen::TaggedObject * > &

selections

)

The update after assigned
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

selections

selections

void NXOpen::ToolDesigner::SelectDatumsBuilder::ClearProductSelection

(

)

The product selection clear function
Created in NX11.0.1.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::ClearSearchByProductSelection

(

)

The product selection clear function
Created in NX11.0.1.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::CreateConesForDatumByDirection	(	NXOpen::TaggedObject *	dfDatum,
		NXOpen::ToolDesigner::SelectDatumsBuilder::ConesDir	number
	)

The create cones for datum by direction
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

dfDatum	dfdatum
number	number

void NXOpen::ToolDesigner::SelectDatumsBuilder::GetAvaiableDatums

(

std::vector< NXOpen::TaggedObject * > &

datums

)

The init assaigned datums for product
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

datums

datums

void NXOpen::ToolDesigner::SelectDatumsBuilder::InitAssaignedDatumsForProductList

(

std::vector< NXOpen::TaggedObject * > &

datums

)

The init assaigned datums for product
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

datums

datums

void NXOpen::ToolDesigner::SelectDatumsBuilder::PopulateUnselectedDatumsList

(

)

The builder populate un selected datums list
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

NXOpen::SelectTaggedObject* NXOpen::ToolDesigner::SelectDatumsBuilder::ProductSelection

(

)

Returns the product selection
Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::RemoveDatumsButton

(

)

TODO: fill in a description for this
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::RemoveDatumsFromSession

(

bool

removeAssignDatums

)

Remove all unselected datums from their subset
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

removeAssignDatums

removeassigndatums

NXOpen::SelectPartList* NXOpen::ToolDesigner::SelectDatumsBuilder::SearchByProductSelection

(

)

Returns the search by specific product selection
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::SearchDatumsInStationByProperty	(	NXOpen::ToolDesigner::SelectDatumsBuilder::Type	enum0,
		const NXString &	searchValue
	)

Search for a station by property and gets its assigned datums
Created in NX12.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

enum0	enum0
searchValue	searchvalue

void NXOpen::ToolDesigner::SelectDatumsBuilder::SearchDatumsInStationByProperty	(	NXOpen::ToolDesigner::SelectDatumsBuilder::Type	enum0,
		const char *	searchValue
	)

Search for a station by property and gets its assigned datums
Created in NX12.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

enum0	enum0
searchValue	searchvalue

NXOpen::ToolDesigner::SelectDatumsBuilder::SearchOption NXOpen::ToolDesigner::SelectDatumsBuilder::SearchTypes

(

)

Returns the SearchOptions
Created in NX11.0.1.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetProductSelection

(

NXOpen::TaggedObject *

productSelection

)

Set the product selection
Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

productSelection

productselection

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetSearchByProductSelection

(

NXOpen::TaggedObject *

productSelection

)

Set the search by product selection
Created in NX11.0.1.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

productSelection

productselection

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetSearchTypes

(

NXOpen::ToolDesigner::SelectDatumsBuilder::SearchOption

val

)

Sets the SearchOptions
Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

val

val

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetXSumInteger

(

int

xSumInteger

)

Sets the x sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

xSumInteger

xsuminteger

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetYSumInteger

(

int

ySumInteger

)

Sets the y sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

ySumInteger

ysuminteger

void NXOpen::ToolDesigner::SelectDatumsBuilder::SetZSumInteger

(

int

zSumInteger

)

Sets the z sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

zSumInteger

zsuminteger

void NXOpen::ToolDesigner::SelectDatumsBuilder::UnAssign

(

const std::vector< NXOpen::TaggedObject * > &

selections

)

The update after un assigned
Created in NX11.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

selections

selections

void NXOpen::ToolDesigner::SelectDatumsBuilder::VolumeSearch	(	const NXOpen::Point3d &	bottomVertex,
		const NXOpen::Point3d &	upperVertex,
		NXOpen::TaggedObject *	selectedObject
	)

Search for all the datums inside a certain box
Created in NX11.0.1.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters

bottomVertex	bottomvertex
upperVertex	uppervertex
selectedObject	selectedobject

int NXOpen::ToolDesigner::SelectDatumsBuilder::XSumInteger

(

)

Returns the x sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

int NXOpen::ToolDesigner::SelectDatumsBuilder::YSumInteger

(

)

Returns the y sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

int NXOpen::ToolDesigner::SelectDatumsBuilder::ZSumInteger

(

)

Returns the z sum integer
Created in NX10.0.0.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

---

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

• ToolDesigner_SelectDatumsBuilder.hxx