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

Represents a NXOpen::Drawings::GeneralWorkFlowBuilder. More...

Inheritance diagram for NXOpen::Drawings::GeneralWorkFlowBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GridSettingsType { GridSettingsTypeDrafting, GridSettingsTypeSketch, GridSettingsTypeSheetZone }
 Represents the grid settings type. More...
 
enum  ModelBasedAlwaysStartType { ModelBasedAlwaysStartTypeViewCreationWizard, ModelBasedAlwaysStartTypeBaseViewCommand, ModelBasedAlwaysStartTypeNoViewCommands }
 Represents the always start type. More...
 
enum  SettingsOrientationType { SettingsOrientationTypeDrawingTemplate, SettingsOrientationTypeDrawingStandard }
 Represents the settings orientation type. More...
 

Public Member Functions

bool CreateDraftingComponent ()
 Returns the flag indicating whether to creates a drafting component when creating a view of the master model part
Created in NX9.0.0. More...
 
NXOpen::Drawings::GeneralWorkFlowBuilder::GridSettingsType GridSettings ()
 Returns the option that indicates the grid settings
Created in NX9.0.0. More...
 
NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedAlwaysStartType ModelBasedAlwaysStart ()
 Returns the option that indicates action to be taken after inserting a sheet with no views
Created in NX9.0.0. More...
 
bool ModelBasedInsertSheet ()
 Returns the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist
Created in NX9.0.0. More...
 
bool ModelBasedProjectedView ()
 Returns the flag indicating whether to automatically start the projected view command after inserting a model view. More...
 
void SetCreateDraftingComponent (bool createDraftingComponent)
 Sets the flag indicating whether to creates a drafting component when creating a view of the master model part
Created in NX9.0.0. More...
 
void SetGridSettings (NXOpen::Drawings::GeneralWorkFlowBuilder::GridSettingsType gridSettings)
 Sets the option that indicates the grid settings
Created in NX9.0.0. More...
 
void SetModelBasedAlwaysStart (NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedAlwaysStartType modelBasedAlwaysStart)
 Sets the option that indicates action to be taken after inserting a sheet with no views
Created in NX9.0.0. More...
 
void SetModelBasedInsertSheet (bool modelBasedInsertSheet)
 Sets the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist
Created in NX9.0.0. More...
 
void SetModelBasedProjectedView (bool modelBasedProjectedView)
 Sets the flag indicating whether to automatically start the projected view command after inserting a model view. More...
 
void SetSettingsOrigination (NXOpen::Drawings::GeneralWorkFlowBuilder::SettingsOrientationType settingsOrigination)
 Sets the option that indicates the settings origination
Created in NX9.0.0. More...
 
void SetStandAloneInsertSheet (bool standAloneInsertSheet)
 Sets the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist. More...
 
void SetStandAloneProjectedView (bool standAloneProjectedView)
 Sets the flag indicating whether to automatically starts the projected view command after inserting a drawing view. More...
 
void SetStandAloneProjectToView (bool standAloneProjectToView)
 Sets the flag indicating whether to automatically starts the projected view command after inserting a projected drawing view. More...
 
void SetStandAloneViewCreation (bool standAloneViewCreation)
 Sets the flag indicating whether to automatically starts the drawing view command after inserting a sheet with no views. More...
 
NXOpen::Drawings::GeneralWorkFlowBuilder::SettingsOrientationType SettingsOrigination ()
 Returns the option that indicates the settings origination
Created in NX9.0.0. More...
 
bool StandAloneInsertSheet ()
 Returns the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist. More...
 
bool StandAloneProjectedView ()
 Returns the flag indicating whether to automatically starts the projected view command after inserting a drawing view. More...
 
bool StandAloneProjectToView ()
 Returns the flag indicating whether to automatically starts the projected view command after inserting a projected drawing view. More...
 
bool StandAloneViewCreation ()
 Returns the flag indicating whether to automatically starts the drawing view command after inserting a sheet with no views. 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

Represents a NXOpen::Drawings::GeneralWorkFlowBuilder.


Created in NX9.0.0.

Member Enumeration Documentation

Represents the grid settings type.

Enumerator
GridSettingsTypeDrafting 

drafting

GridSettingsTypeSketch 

sketch

GridSettingsTypeSheetZone 

sheet zone

Represents the always start type.

Enumerator
ModelBasedAlwaysStartTypeViewCreationWizard 

view creation wizard

ModelBasedAlwaysStartTypeBaseViewCommand 

base view command

ModelBasedAlwaysStartTypeNoViewCommands 

no view commands

Represents the settings orientation type.

Enumerator
SettingsOrientationTypeDrawingTemplate 

drawing template

SettingsOrientationTypeDrawingStandard 

drawing standard

Member Function Documentation

bool NXOpen::Drawings::GeneralWorkFlowBuilder::CreateDraftingComponent ( )

Returns the flag indicating whether to creates a drafting component when creating a view of the master model part
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::GeneralWorkFlowBuilder::GridSettingsType NXOpen::Drawings::GeneralWorkFlowBuilder::GridSettings ( )

Returns the option that indicates the grid settings
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedAlwaysStartType NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedAlwaysStart ( )

Returns the option that indicates action to be taken after inserting a sheet with no views
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedInsertSheet ( )

Returns the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedProjectedView ( )

Returns the flag indicating whether to automatically start the projected view command after inserting a model view.


Created in NX9.0.0.

License requirements : None

void NXOpen::Drawings::GeneralWorkFlowBuilder::SetCreateDraftingComponent ( bool  createDraftingComponent)

Sets the flag indicating whether to creates a drafting component when creating a view of the master model part
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
createDraftingComponentcreatedraftingcomponent
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetGridSettings ( NXOpen::Drawings::GeneralWorkFlowBuilder::GridSettingsType  gridSettings)

Sets the option that indicates the grid settings
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
gridSettingsgridsettings
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetModelBasedAlwaysStart ( NXOpen::Drawings::GeneralWorkFlowBuilder::ModelBasedAlwaysStartType  modelBasedAlwaysStart)

Sets the option that indicates action to be taken after inserting a sheet with no views
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
modelBasedAlwaysStartmodelbasedalwaysstart
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetModelBasedInsertSheet ( bool  modelBasedInsertSheet)

Sets the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
modelBasedInsertSheetmodelbasedinsertsheet
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetModelBasedProjectedView ( bool  modelBasedProjectedView)

Sets the flag indicating whether to automatically start the projected view command after inserting a model view.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
modelBasedProjectedViewmodelbasedprojectedview
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetSettingsOrigination ( NXOpen::Drawings::GeneralWorkFlowBuilder::SettingsOrientationType  settingsOrigination)

Sets the option that indicates the settings origination
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
settingsOriginationsettingsorigination
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetStandAloneInsertSheet ( bool  standAloneInsertSheet)

Sets the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
standAloneInsertSheetstandaloneinsertsheet
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetStandAloneProjectedView ( bool  standAloneProjectedView)

Sets the flag indicating whether to automatically starts the projected view command after inserting a drawing view.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
standAloneProjectedViewstandaloneprojectedview
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetStandAloneProjectToView ( bool  standAloneProjectToView)

Sets the flag indicating whether to automatically starts the projected view command after inserting a projected drawing view.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
standAloneProjectToViewstandaloneprojecttoview
void NXOpen::Drawings::GeneralWorkFlowBuilder::SetStandAloneViewCreation ( bool  standAloneViewCreation)

Sets the flag indicating whether to automatically starts the drawing view command after inserting a sheet with no views.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
standAloneViewCreationstandaloneviewcreation
NXOpen::Drawings::GeneralWorkFlowBuilder::SettingsOrientationType NXOpen::Drawings::GeneralWorkFlowBuilder::SettingsOrigination ( )

Returns the option that indicates the settings origination
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::StandAloneInsertSheet ( )

Returns the flag indicating whether to automatically starts the insert sheet command when entering the drafting application if no drawing sheets exist.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::StandAloneProjectedView ( )

Returns the flag indicating whether to automatically starts the projected view command after inserting a drawing view.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::StandAloneProjectToView ( )

Returns the flag indicating whether to automatically starts the projected view command after inserting a projected drawing view.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralWorkFlowBuilder::StandAloneViewCreation ( )

Returns the flag indicating whether to automatically starts the drawing view command after inserting a sheet with no views.


Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Drawings::GeneralWorkFlowBuilder::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.