NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Tooling::CompDrawingBuilder Class Reference

Represents a Tooling::CompDrawingBuilder which is used to create or edit the Component Drawing. More...

Inheritance diagram for NXOpen::Tooling::CompDrawingBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ComponentTypeSelection { ComponentTypeSelectionAll }
 Specifies the type of components. More...
enum  DrawingType { DrawingTypeNone, DrawingTypeNonMaster, DrawingTypeSelfContained }
 Specifies the drawing type. More...
enum  FilterSelection { FilterSelectionType, FilterSelectionDrawing, FilterSelectionAll }
 Specifies the filter of components. More...
enum  ProjectionType { ProjectionTypeFirstAngleProjection, ProjectionTypeThirdAngleProjection }
 Specifies the project type. More...

Public Member Functions

NXOpen::Assemblies::SelectComponentComponent ()
 Returns the component to create drawing.
NXOpen::Tooling::CompDrawingBuilder::ComponentTypeSelection ComponentType ()
 Returns the component type in mold or die project assembly.
void CreateAll ()
 Creates all drawings.
void CreateDrawing (const NXString &pName, const NXString &dFile, const NXString &dName, const NXString &templateName)
 Creates a drawing.
void DeleteDrawing (const NXString &pName, const NXString &dFile, const NXString &dName, const NXString &templateName)
 Deletes a drawing.
NXString DrawingFileNamingRule ()
 Returns the naming rule of drawing files.
NXOpen::Tooling::CompDrawingBuilder::DrawingType DrawingFilter ()
 Returns the drawing component drawing filter.
NXString DrawingSheetNamingRule ()
 Returns the naming rule of drawing sheets.
void EditDrawing (const NXString &pName, const NXString &dFile, const NXString &dName, const NXString &templateName)
 Edits a drawing.
NXOpen::Tooling::CompDrawingBuilder::FilterSelection Filter ()
 Returns the filter to select component for drawing.
void InitConstructor ()
 Initializes the component drawing value.
bool IsKeepDrawingOpen ()
 Returns the option whether to keep drawing open.
int Margin ()
 Returns the margin for user defined drawing template.
void OpenDrawing (const NXString &pName, const NXString &dFile, const NXString &dName, const NXString &templateName)
 Opens a drawing.
NXOpen::Tooling::CompDrawingBuilder::ProjectionType Projection ()
 Returns the drawing projection angle.
void SetComponentType (NXOpen::Tooling::CompDrawingBuilder::ComponentTypeSelection componentType)
 Sets the component type in mold or die project assembly.
void SetDrawingFileNamingRule (const NXString &drawingFileNamingRule)
 Sets the naming rule of drawing files.
void SetDrawingFilter (NXOpen::Tooling::CompDrawingBuilder::DrawingType drawingType)
 Sets the drawing component drawing filter.
void SetDrawingSheetNamingRule (const NXString &drawingSheetNamingRule)
 Sets the naming rule of drawing sheets.
void SetFilter (NXOpen::Tooling::CompDrawingBuilder::FilterSelection filter)
 Sets the filter to select component for drawing.
void SetKeepDrawingOpen (bool isKeepDrawingOpen)
 Sets the option whether to keep drawing open.
void SetMargin (int margin)
 Sets the margin for user defined drawing template.
void SetProjection (NXOpen::Tooling::CompDrawingBuilder::ProjectionType projection)
 Sets the drawing projection angle.

Detailed Description

Represents a Tooling::CompDrawingBuilder which is used to create or edit the Component Drawing.


To create a new instance of this class, use Tooling::ToolingDrawingCollection::CreateComponentDrawingBuilder
Default values.

Property Value

ComponentType

All

DrawingFilter

None

Filter

Type

IsKeepDrawingOpen

0

Margin

15

Projection

FirstAngleProjection


Created in NX8.0.0.


Member Enumeration Documentation

Specifies the type of components.

Enumerator:
ComponentTypeSelectionAll 

the type of components, read from configuration file

Specifies the drawing type.

Enumerator:
DrawingTypeNone 

without drawing

DrawingTypeNonMaster 

with non-master drawing

DrawingTypeSelfContained 

with self-contained drawing

Specifies the filter of components.

Enumerator:
FilterSelectionType 

filter components by type

FilterSelectionDrawing 

filter componnets by drawing

FilterSelectionAll 

list all components

Specifies the project type.

Enumerator:
ProjectionTypeFirstAngleProjection 

first angle projection

ProjectionTypeThirdAngleProjection 

third angle projection


Member Function Documentation

Returns the component to create drawing.


Created in NX8.0.0.

License requirements : None

Returns the component type in mold or die project assembly.


Created in NX8.0.0.

License requirements : None

Creates all drawings.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::CompDrawingBuilder::CreateDrawing ( const NXString pName,
const NXString dFile,
const NXString dName,
const NXString templateName 
)

Creates a drawing.


Created in NX8.0.0.

License requirements : None

Parameters:
pName
NOTE: The full Unicode character set is not supported for this parameter.
dFile
NOTE: The full Unicode character set is not supported for this parameter.
dName
NOTE: The full Unicode character set is not supported for this parameter.
templateName
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Tooling::CompDrawingBuilder::DeleteDrawing ( const NXString pName,
const NXString dFile,
const NXString dName,
const NXString templateName 
)

Deletes a drawing.


Created in NX8.0.0.

License requirements : None

Parameters:
pName
NOTE: The full Unicode character set is not supported for this parameter.
dFile
NOTE: The full Unicode character set is not supported for this parameter.
dName
NOTE: The full Unicode character set is not supported for this parameter.
templateName
NOTE: The full Unicode character set is not supported for this parameter.

Returns the naming rule of drawing files.


Created in NX8.0.0.

License requirements : None

Returns the drawing component drawing filter.


Created in NX8.0.0.

License requirements : None

Returns the naming rule of drawing sheets.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::CompDrawingBuilder::EditDrawing ( const NXString pName,
const NXString dFile,
const NXString dName,
const NXString templateName 
)

Edits a drawing.


Created in NX8.0.0.

License requirements : None

Parameters:
pName
NOTE: The full Unicode character set is not supported for this parameter.
dFile
NOTE: The full Unicode character set is not supported for this parameter.
dName
NOTE: The full Unicode character set is not supported for this parameter.
templateName
NOTE: The full Unicode character set is not supported for this parameter.

Returns the filter to select component for drawing.


Created in NX8.0.0.

License requirements : None

Initializes the component drawing value.


Created in NX8.0.0.

License requirements : None

Returns the option whether to keep drawing open.


Created in NX8.0.0.

License requirements : None

Returns the margin for user defined drawing template.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::CompDrawingBuilder::OpenDrawing ( const NXString pName,
const NXString dFile,
const NXString dName,
const NXString templateName 
)

Opens a drawing.


Created in NX8.0.0.

License requirements : None

Parameters:
pName
NOTE: The full Unicode character set is not supported for this parameter.
dFile
NOTE: The full Unicode character set is not supported for this parameter.
dName
NOTE: The full Unicode character set is not supported for this parameter.
templateName
NOTE: The full Unicode character set is not supported for this parameter.

Returns the drawing projection angle.


Created in NX8.0.0.

License requirements : None

Sets the component type in mold or die project assembly.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
componentTypecomponenttype

Sets the naming rule of drawing files.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
drawingFileNamingRuledrawingfilenamingrule

Sets the drawing component drawing filter.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
drawingTypedrawingtype

Sets the naming rule of drawing sheets.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
drawingSheetNamingRuledrawingsheetnamingrule

Sets the filter to select component for drawing.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
filterfilter

Sets the option whether to keep drawing open.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
isKeepDrawingOpeniskeepdrawingopen

Sets the margin for user defined drawing template.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
marginmargin

Sets the drawing projection angle.


Created in NX8.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters:
projectionprojection

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