NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::SelectStructuresBuilder Class Reference

This builder allows you to select structures in NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder . More...

Inheritance diagram for NXOpen::Features::ShipDesign::SelectStructuresBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::SelectNXObjectListAdditionalStructures ()
 Returns the additional structures selected by the user
Created in NX12.0.0. More...
 
void AddStructuresByRule (const std::vector< NXOpen::Assemblies::Component * > &structures)
 Adds ship structures to the view
Created in NX12.0.0. More...
 
std::vector
< NXOpen::Assemblies::Component * > 
GetFinalStructuresByRule ()
 Searches ship structures added to the view by the rule. More...
 
void RemoveStructuresByRule (const std::vector< NXOpen::Assemblies::Component * > &structures)
 Removes ship structures from the view
Created in NX12.0.0. More...
 
void ResetStructuresByRule ()
 Resets the structures to be added to the view by rule
Created in NX12.0.0. 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

This builder allows you to select structures in NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder .

It represents NXOpen::Features::ShipDesign::SelectStructuresBuilder .


Created in NX12.0.0.

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SelectStructuresBuilder::AdditionalStructures ( )

Returns the additional structures selected by the user
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

void NXOpen::Features::ShipDesign::SelectStructuresBuilder::AddStructuresByRule ( const std::vector< NXOpen::Assemblies::Component * > &  structures)

Adds ship structures to the view
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
structuresstructures
std::vector<NXOpen::Assemblies::Component *> NXOpen::Features::ShipDesign::SelectStructuresBuilder::GetFinalStructuresByRule ( )

Searches ship structures added to the view by the rule.

Returns

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
void NXOpen::Features::ShipDesign::SelectStructuresBuilder::RemoveStructuresByRule ( const std::vector< NXOpen::Assemblies::Component * > &  structures)

Removes ship structures from the view
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
structuresstructures
void NXOpen::Features::ShipDesign::SelectStructuresBuilder::ResetStructuresByRule ( )

Resets the structures to be added to the view by rule
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

virtual bool NXOpen::Features::ShipDesign::SelectStructuresBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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