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

Builder for creating platform. More...

Inheritance diagram for NXOpen::Routing::PlatformCreatorBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ReferenceType { ReferenceTypeHorizontal, ReferenceTypeVertical }
 The grate orientation symbol reference. More...
 

Public Member Functions

NXString ExternalFrameAnchorName ()
 Returns the external frame stock anchor
Created in NX8.5.0. More...
 
NXOpen::Routing::PathStockBuilderExternalStockSettings ()
 Returns the external frame stock settings for stock assignment. More...
 
NXOpen::Routing::CharacteristicListGetPlateAppliedCharx ()
 Gets the plate charx which is used for platform plate. More...
 
NXOpen::Routing::CharacteristicListGetPlatePart ()
 Gets the plate part which data is used for platform plate. More...
 
NXOpen::Routing::PlatformCreatorBuilder::ReferenceType GrateOrientationReference ()
 Returns the grate orientation reference
Created in NX8.5.0. More...
 
bool GrateOrientationSymbolDisplay ()
 Returns the grate orientation symbol display
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectGrateOrientationSymbolRefSelection ()
 Returns the grate orientation symbol ref selection
Created in NX8.5.0. More...
 
NXString InternalFrameAnchorName ()
 Returns the internal frame stock anchor
Created in NX8.5.0. More...
 
NXOpen::Routing::PathStockBuilderInternalStockSettings ()
 Returns the internal stock settings for stock assignment. More...
 
NXOpen::SectionPlateBoundariesSelection ()
 Returns the platform part boundaries section
Created in NX8.5.0. More...
 
NXOpen::SectionSelectOuterBoundary ()
 Returns the platform outer boundary section
Created in NX8.5.0. More...
 
void SetExternalFrameAnchorName (const NXString &anchorName)
 Sets the external frame stock anchor
Created in NX8.5.0. More...
 
void SetExternalFrameAnchorName (const char *anchorName)
 Sets the external frame stock anchor
Created in NX8.5.0. More...
 
void SetGrateOrientationReference (NXOpen::Routing::PlatformCreatorBuilder::ReferenceType grateOrientationReference)
 Sets the grate orientation reference
Created in NX8.5.0. More...
 
void SetGrateOrientationSymbolDisplay (bool grateOrientationSymbolDisplay)
 Sets the grate orientation symbol display
Created in NX8.5.0. More...
 
void SetInternalFrameAnchorName (const NXString &anchorName)
 Sets the internal frame stock anchor
Created in NX8.5.0. More...
 
void SetInternalFrameAnchorName (const char *anchorName)
 Sets the internal frame stock anchor
Created in NX8.5.0. More...
 
void SetPlateAppliedCharx (NXOpen::Routing::CharacteristicList *appliedCharx)
 Sets the plate charx which is used for platform plate
Created in NX8.5.0. More...
 
void SetPlatePart (NXOpen::Routing::CharacteristicList *platePart)
 Sets the plate part which data is used for plaform plate
Created in NX8.5.0. More...
 
void SetThickenDirection (bool thickenDirection)
 Sets the thicken direction
Created in NX8.5.0. More...
 
void SetUseSameStock (bool internalFrameFlipStock)
 Sets the internal frame use same stock option
Created in NX8.5.0. More...
 
void SpecifyPlate ()
 The specify plate button callback
Created in NX8.5.0. More...
 
bool ThickenDirection ()
 Returns the thicken direction
Created in NX8.5.0. More...
 
bool UseSameStock ()
 Returns the internal frame use same stock option
Created in NX8.5.0. 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

Builder for creating platform.

Create platform: Takes platform outer boundaries sketch, platform plate boundaries sketch, platform plates, stocks for external and internal frames. Grate orientation symbol display is optional.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreatePlatformCreatorBuilder

Created in NX8.5.0.

Member Enumeration Documentation

The grate orientation symbol reference.

Enumerator
ReferenceTypeHorizontal 

horizontal

ReferenceTypeVertical 

vertical

Member Function Documentation

NXString NXOpen::Routing::PlatformCreatorBuilder::ExternalFrameAnchorName ( )

Returns the external frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

NXOpen::Routing::PathStockBuilder* NXOpen::Routing::PlatformCreatorBuilder::ExternalStockSettings ( )

Returns the external frame stock settings for stock assignment.


Created in NX8.5.0.

License requirements : routing_platform ("Routing Platform")

NXOpen::Routing::CharacteristicList* NXOpen::Routing::PlatformCreatorBuilder::GetPlateAppliedCharx ( )

Gets the plate charx which is used for platform plate.

Returns

Created in NX8.5.0.

License requirements : routing_platform ("Routing Platform")
NXOpen::Routing::CharacteristicList* NXOpen::Routing::PlatformCreatorBuilder::GetPlatePart ( )

Gets the plate part which data is used for platform plate.

Returns

Created in NX8.5.0.

License requirements : routing_platform ("Routing Platform")
NXOpen::Routing::PlatformCreatorBuilder::ReferenceType NXOpen::Routing::PlatformCreatorBuilder::GrateOrientationReference ( )

Returns the grate orientation reference
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

bool NXOpen::Routing::PlatformCreatorBuilder::GrateOrientationSymbolDisplay ( )

Returns the grate orientation symbol display
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

NXOpen::SelectNXObject* NXOpen::Routing::PlatformCreatorBuilder::GrateOrientationSymbolRefSelection ( )

Returns the grate orientation symbol ref selection
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

NXString NXOpen::Routing::PlatformCreatorBuilder::InternalFrameAnchorName ( )

Returns the internal frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

NXOpen::Routing::PathStockBuilder* NXOpen::Routing::PlatformCreatorBuilder::InternalStockSettings ( )

Returns the internal stock settings for stock assignment.


Created in NX8.5.0.

License requirements : routing_platform ("Routing Platform")

NXOpen::Section* NXOpen::Routing::PlatformCreatorBuilder::PlateBoundariesSelection ( )

Returns the platform part boundaries section
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

NXOpen::Section* NXOpen::Routing::PlatformCreatorBuilder::SelectOuterBoundary ( )

Returns the platform outer boundary section
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

void NXOpen::Routing::PlatformCreatorBuilder::SetExternalFrameAnchorName ( const NXString anchorName)

Sets the external frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
anchorNameanchorname
void NXOpen::Routing::PlatformCreatorBuilder::SetExternalFrameAnchorName ( const char *  anchorName)

Sets the external frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
anchorNameanchorname
void NXOpen::Routing::PlatformCreatorBuilder::SetGrateOrientationReference ( NXOpen::Routing::PlatformCreatorBuilder::ReferenceType  grateOrientationReference)

Sets the grate orientation reference
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
grateOrientationReferencegrateorientationreference
void NXOpen::Routing::PlatformCreatorBuilder::SetGrateOrientationSymbolDisplay ( bool  grateOrientationSymbolDisplay)

Sets the grate orientation symbol display
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
grateOrientationSymbolDisplaygrateorientationsymboldisplay
void NXOpen::Routing::PlatformCreatorBuilder::SetInternalFrameAnchorName ( const NXString anchorName)

Sets the internal frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
anchorNameanchorname
void NXOpen::Routing::PlatformCreatorBuilder::SetInternalFrameAnchorName ( const char *  anchorName)

Sets the internal frame stock anchor
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
anchorNameanchorname
void NXOpen::Routing::PlatformCreatorBuilder::SetPlateAppliedCharx ( NXOpen::Routing::CharacteristicList appliedCharx)

Sets the plate charx which is used for platform plate
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
appliedCharxappliedcharx
void NXOpen::Routing::PlatformCreatorBuilder::SetPlatePart ( NXOpen::Routing::CharacteristicList platePart)

Sets the plate part which data is used for plaform plate
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
platePartplatepart
void NXOpen::Routing::PlatformCreatorBuilder::SetThickenDirection ( bool  thickenDirection)

Sets the thicken direction
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
thickenDirectionthickendirection
void NXOpen::Routing::PlatformCreatorBuilder::SetUseSameStock ( bool  internalFrameFlipStock)

Sets the internal frame use same stock option
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

Parameters
internalFrameFlipStockinternalframeflipstock
void NXOpen::Routing::PlatformCreatorBuilder::SpecifyPlate ( )

The specify plate button callback
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

bool NXOpen::Routing::PlatformCreatorBuilder::ThickenDirection ( )

Returns the thicken direction
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")

bool NXOpen::Routing::PlatformCreatorBuilder::UseSameStock ( )

Returns the internal frame use same stock option
Created in NX8.5.0.



License requirements : routing_platform ("Routing Platform")


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