NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::ToolDesigner::SelectFixtureUnitsBuilder Class Reference

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

Inheritance diagram for NXOpen::ToolDesigner::SelectFixtureUnitsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SearchTypeEnum { SearchTypeEnumId, SearchTypeEnumName }
 SearchTypes. More...
 

Public Member Functions

void ClearCurrentSearchResultsPageResults ()
 ClearCurrentSearchResultsPageResults
Created in NX11.0.2. More...
 
void ClearLoadedUnits ()
 ClearLoadedUnits
Created in NX11.0.2. More...
 
void ClearSelectedUnits ()
 ClearSelectedUnits
Created in NX11.0.2. More...
 
void ClearUnitsToUnassociate ()
 ClearUnitsToUnassociate
Created in NX11.0.2. More...
 
void ClearUnselectedUnits ()
 ClearUnselectedUnits
Created in NX11.0.2. More...
 
bool CloneUnitToggle ()
 Returns the flip gun direction
Created in NX11.0.2. More...
 
void CollectSelectedUnits (std::vector< NXOpen::TaggedObject * > &units)
 CollectSelectedUnits
Created in NX11.0.2. More...
 
NXOpen::SelectTaggedObjectDatumSelection ()
 Returns the datum selection
Created in NX10.0.0. More...
 
void DeleteSelectedSearchResults ()
 DeleteSelectedSearchResults
Created in NX11.0.2. More...
 
int GetConnectedDatumsNumber (NXOpen::TaggedObject *unit)
 GetConnectedDatumsNumber. More...
 
void GetConnectedUnitsAndLoadToSessions (NXOpen::TaggedObject *datum, std::vector< NXOpen::TaggedObject * > &units)
 ClearLoadedUnits
Created in NX11.0.2. More...
 
int GetCurrentSearchResultsPageNumber ()
 GetCurrentSearchResultsPageNumber. More...
 
void GetCurrentSearchResultsPageResults (std::vector< NXOpen::TaggedObject * > &resultUnits)
 GetCurrentSearchResultsPageResults
Created in NX11.0.2. More...
 
bool HasNextSearchReultsPage ()
 HasNextSearchReultsPage. More...
 
bool HasPreviousSearchResultsPage ()
 HasPreviousSearchResultsPage. More...
 
NXOpen::SelectTaggedObjectListInvisibleSelection ()
 Returns the selectable tableEditors selected items (for all tables)
Created in NX11.0.1. More...
 
bool IsAddedFromSearchResults (NXOpen::TaggedObject *unit)
 IsAddedFromSearchResults. More...
 
bool IsAssigned (NXOpen::TaggedObject *unit)
 IsAssigned. More...
 
void LoadSearchedUnitToFixture (NXOpen::TaggedObject *unit)
 LoadSearchedUnitToFixture
Created in NX11.0.2. More...
 
void LoadUnitToFixture (NXOpen::TaggedObject *unit)
 LoadUnitToFixture
Created in NX11.0.2. More...
 
void NextSearchResultsButton ()
 Next Search Button
Created in NX11.0.2. More...
 
void PerformSearchButton ()
 Perform Search Button
Created in NX11.0.2. More...
 
void PrevSearchResultsButton ()
 Prev Search Button
Created in NX11.0.2. More...
 
void RemoveAndUnassociateUnit (NXOpen::TaggedObject *unit)
 RemoveAndUnassociateUnit
Created in NX11.0.2. More...
 
void RemoveSearchedUnitAssociation (NXOpen::TaggedObject *unit)
 RemoveSearchedUnitAssociation
Created in NX11.0.2. More...
 
NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchTypeEnum SearchTypes ()
 Returns the SearchTypes
Created in NX11.0.2. More...
 
NXString SearchValue ()
 Returns the SearchValue
Created in NX11.0.2. More...
 
void SetCloneUnitToggle (bool cloneUnitToggle)
 Sets the flip gun direction
Created in NX11.0.2. More...
 
void SetSearchTypes (NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchTypeEnum val)
 Sets the SearchTypes
Created in NX11.0.2. More...
 
void SetSearchValue (const NXString &searchValue)
 Sets the SearchValue
Created in NX11.0.2. More...
 
void SetSearchValue (const char *searchValue)
 Sets the SearchValue
Created in NX11.0.2. More...
 
void UnassociateUnit (NXOpen::TaggedObject *unit)
 UnassociateUnit
Created in NX11.0.2. More...
 
void UnloadUnitFromFixture (NXOpen::TaggedObject *unit)
 UnloadUnitFromFixture
Created in NX11.0.2. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

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

Property Value

CloneUnitToggle

0

SearchTypes

Name


Created in NX10.0.0.

Member Enumeration Documentation

SearchTypes.

Enumerator
SearchTypeEnumId 

ID.

SearchTypeEnumName 

Name.

Member Function Documentation

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::ClearCurrentSearchResultsPageResults ( )

ClearCurrentSearchResultsPageResults
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::ClearLoadedUnits ( )

ClearLoadedUnits
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::ClearSelectedUnits ( )

ClearSelectedUnits
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::ClearUnitsToUnassociate ( )

ClearUnitsToUnassociate
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::ClearUnselectedUnits ( )

ClearUnselectedUnits
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

bool NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::CloneUnitToggle ( )

Returns the flip gun direction
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::CollectSelectedUnits ( std::vector< NXOpen::TaggedObject * > &  units)

CollectSelectedUnits
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitsunits
NXOpen::SelectTaggedObject* NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::DatumSelection ( )

Returns the datum selection
Created in NX10.0.0.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::DeleteSelectedSearchResults ( )

DeleteSelectedSearchResults
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

int NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::GetConnectedDatumsNumber ( NXOpen::TaggedObject unit)

GetConnectedDatumsNumber.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::GetConnectedUnitsAndLoadToSessions ( NXOpen::TaggedObject datum,
std::vector< NXOpen::TaggedObject * > &  units 
)

ClearLoadedUnits
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
datumdatum
unitsunits
int NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::GetCurrentSearchResultsPageNumber ( )

GetCurrentSearchResultsPageNumber.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::GetCurrentSearchResultsPageResults ( std::vector< NXOpen::TaggedObject * > &  resultUnits)

GetCurrentSearchResultsPageResults
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
resultUnitsresultunits
bool NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::HasNextSearchReultsPage ( )

HasNextSearchReultsPage.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
bool NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::HasPreviousSearchResultsPage ( )

HasPreviousSearchResultsPage.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
NXOpen::SelectTaggedObjectList* NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::InvisibleSelection ( )

Returns the selectable tableEditors selected items (for all tables)
Created in NX11.0.1.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

bool NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::IsAddedFromSearchResults ( NXOpen::TaggedObject unit)

IsAddedFromSearchResults.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
Parameters
unitunit
bool NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::IsAssigned ( NXOpen::TaggedObject unit)

IsAssigned.

Returns

Created in NX11.0.2.

License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")
Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::LoadSearchedUnitToFixture ( NXOpen::TaggedObject unit)

LoadSearchedUnitToFixture
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::LoadUnitToFixture ( NXOpen::TaggedObject unit)

LoadUnitToFixture
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::NextSearchResultsButton ( )

Next Search Button
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::PerformSearchButton ( )

Perform Search Button
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::PrevSearchResultsButton ( )

Prev Search Button
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::RemoveAndUnassociateUnit ( NXOpen::TaggedObject unit)

RemoveAndUnassociateUnit
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::RemoveSearchedUnitAssociation ( NXOpen::TaggedObject unit)

RemoveSearchedUnitAssociation
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit
NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchTypeEnum NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchTypes ( )

Returns the SearchTypes
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

NXString NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchValue ( )

Returns the SearchValue
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SetCloneUnitToggle ( bool  cloneUnitToggle)

Sets the flip gun direction
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
cloneUnitTogglecloneunittoggle
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SetSearchTypes ( NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SearchTypeEnum  val)

Sets the SearchTypes
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
valval
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SetSearchValue ( const NXString searchValue)

Sets the SearchValue
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
searchValuesearchvalue
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::SetSearchValue ( const char *  searchValue)

Sets the SearchValue
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
searchValuesearchvalue
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::UnassociateUnit ( NXOpen::TaggedObject unit)

UnassociateUnit
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit
void NXOpen::ToolDesigner::SelectFixtureUnitsBuilder::UnloadUnitFromFixture ( NXOpen::TaggedObject unit)

UnloadUnitFromFixture
Created in NX11.0.2.



License requirements : fp_fixture_planner ("FULL FIXTURE PLANNER")

Parameters
unitunit

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.