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

Represents a NXOpen::Drawings::TrackDrawingChangesGeneralBuilder. More...

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

Public Types

enum  BaselineOfComparisonType { BaselineOfComparisonTypeSnapshot, BaselineOfComparisonTypeTrackedChanges }
 Represents baseline Of comparison type. More...
 
enum  CompareMethodType { CompareMethodTypeAgainstAnotherDrawing, CompareMethodTypeAgainstSnapshotDataInActiveDrawing, CompareMethodTypeOpenSavedComparisonReport }
 Represents compare method type. More...
 
enum  SnapshotDataToUseType { SnapshotDataToUseTypeAskAtRunTime, SnapshotDataToUseTypeAlwaysUseExistingData, SnapshotDataToUseTypeAlwaysCreateNewData, SnapshotDataToUseTypeCreateNewDataifNoneExists }
 Represents snapshot data to use type. More...
 
enum  SymbolType {
  SymbolTypeCircle, SymbolTypeTriangleUp, SymbolTypeTriangleDown, SymbolTypeSquare,
  SymbolTypeHexagon
}
 Represents symbol type. More...
 

Public Member Functions

NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::BaselineOfComparisonType BaselineOfComparison ()
 Returns the baseline of comparison
Created in NX11.0.0. More...
 
NXOpen::LineColorFontWidthBuilderChangeSymbolLineColorFontWidth ()
 Returns the change symbol line color font width
Created in NX11.0.0. More...
 
double ChangeSymbolSize ()
 Returns the change symbol size
Created in NX11.0.0. More...
 
NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SymbolType ChangeSymbolType ()
 Returns the change symbol type
Created in NX11.0.0. More...
 
NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareMethodType CompareMethod ()
 Returns the compare method
Created in NX11.0.0. More...
 
double CompareTolerance ()
 Returns the compare tolerance
Created in NX11.0.0. More...
 
bool CreateOverlayDataWithSnapshotData ()
 Returns the create overlay data with snapshot data
Created in NX11.0.0. More...
 
bool DisplayChangeSymbol ()
 Returns the display change symbol
Created in NX11.0.0. More...
 
bool IncrementIDNumberPerReport ()
 Returns the increment id number per report
Created in NX11.0.0. More...
 
bool PreserveChangeSymbolDisplay ()
 Returns the preserve Change Symbol Display
Created in NX11.0.0. More...
 
bool RestartIDNumbersWithNewReport ()
 Returns the restart id numbers with new report
Created in NX11.0.0. More...
 
void SetBaselineOfComparison (NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::BaselineOfComparisonType baselineOfComparison)
 Sets the baseline of comparison
Created in NX11.0.0. More...
 
void SetChangeSymbolSize (double symbolSize)
 Sets the change symbol size
Created in NX11.0.0. More...
 
void SetChangeSymbolType (NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SymbolType symbolType)
 Sets the change symbol type
Created in NX11.0.0. More...
 
void SetCompareMethod (NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareMethodType compareMethod)
 Sets the compare method
Created in NX11.0.0. More...
 
void SetCompareTolerance (double compareTolerance)
 Sets the compare tolerance
Created in NX11.0.0. More...
 
void SetCreateOverlayDataWithSnapshotData (bool createOverlayDataWithSnapshotData)
 Sets the create overlay data with snapshot data
Created in NX11.0.0. More...
 
void SetDisplayChangeSymbol (bool displayChangeSymbol)
 Sets the display change symbol
Created in NX11.0.0. More...
 
void SetIncrementIDNumberPerReport (bool incrementIDNumberPerReport)
 Sets the increment id number per report
Created in NX11.0.0. More...
 
void SetPreserveChangeSymbolDisplay (bool preserveChangeSymbolDisplay)
 Sets the preserve Change Symbol Display
Created in NX11.0.0. More...
 
void SetRestartIDNumbersWithNewReport (bool restartIDNumbersWithNewReport)
 Sets the restart id numbers with new report
Created in NX11.0.0. More...
 
void SetSnapshotDataToUse (NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SnapshotDataToUseType snapshotDataToUse)
 Sets the snapshot data to use
Created in NX11.0.0. More...
 
NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SnapshotDataToUseType SnapshotDataToUse ()
 Returns the snapshot data to use
Created in NX11.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

Represents a NXOpen::Drawings::TrackDrawingChangesGeneralBuilder.


Created in NX11.0.0.

Member Enumeration Documentation

Represents baseline Of comparison type.

Enumerator
BaselineOfComparisonTypeSnapshot 

snapshot

BaselineOfComparisonTypeTrackedChanges 

tracked changes

Represents compare method type.

Enumerator
CompareMethodTypeAgainstAnotherDrawing 

This option is used to compare different part over current part.

CompareMethodTypeAgainstSnapshotDataInActiveDrawing 

This option is used to compare current part on itself.

CompareMethodTypeOpenSavedComparisonReport 

This option is used to open a compare report that is saved in the current part.

Represents snapshot data to use type.

Enumerator
SnapshotDataToUseTypeAskAtRunTime 

This option tells to show messages at rumtime.

SnapshotDataToUseTypeAlwaysUseExistingData 

This option will use existing snapshot data.

SnapshotDataToUseTypeAlwaysCreateNewData 

This option will always create new snapshot data.

SnapshotDataToUseTypeCreateNewDataifNoneExists 

This option will create new sanpshot data if none exists.

Represents symbol type.

Enumerator
SymbolTypeCircle 

circle

SymbolTypeTriangleUp 

triangle up

SymbolTypeTriangleDown 

triangle down

SymbolTypeSquare 

square

SymbolTypeHexagon 

hexagon

Member Function Documentation

NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::BaselineOfComparisonType NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::BaselineOfComparison ( )

Returns the baseline of comparison
Created in NX11.0.0.



License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::ChangeSymbolLineColorFontWidth ( )

Returns the change symbol line color font width
Created in NX11.0.0.



License requirements : None

double NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::ChangeSymbolSize ( )

Returns the change symbol size
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SymbolType NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::ChangeSymbolType ( )

Returns the change symbol type
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareMethodType NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareMethod ( )

Returns the compare method
Created in NX11.0.0.



License requirements : None

double NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareTolerance ( )

Returns the compare tolerance
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CreateOverlayDataWithSnapshotData ( )

Returns the create overlay data with snapshot data
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::DisplayChangeSymbol ( )

Returns the display change symbol
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::IncrementIDNumberPerReport ( )

Returns the increment id number per report
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::PreserveChangeSymbolDisplay ( )

Returns the preserve Change Symbol Display
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::RestartIDNumbersWithNewReport ( )

Returns the restart id numbers with new report
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetBaselineOfComparison ( NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::BaselineOfComparisonType  baselineOfComparison)

Sets the baseline of comparison
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
baselineOfComparisonbaselineofcomparison
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetChangeSymbolSize ( double  symbolSize)

Sets the change symbol size
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
symbolSizesymbolsize
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetChangeSymbolType ( NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SymbolType  symbolType)

Sets the change symbol type
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
symbolTypesymboltype
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetCompareMethod ( NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::CompareMethodType  compareMethod)

Sets the compare method
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
compareMethodcomparemethod
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetCompareTolerance ( double  compareTolerance)

Sets the compare tolerance
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
compareTolerancecomparetolerance
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetCreateOverlayDataWithSnapshotData ( bool  createOverlayDataWithSnapshotData)

Sets the create overlay data with snapshot data
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
createOverlayDataWithSnapshotDatacreateoverlaydatawithsnapshotdata
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetDisplayChangeSymbol ( bool  displayChangeSymbol)

Sets the display change symbol
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
displayChangeSymboldisplaychangesymbol
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetIncrementIDNumberPerReport ( bool  incrementIDNumberPerReport)

Sets the increment id number per report
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
incrementIDNumberPerReportincrementidnumberperreport
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetPreserveChangeSymbolDisplay ( bool  preserveChangeSymbolDisplay)

Sets the preserve Change Symbol Display
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
preserveChangeSymbolDisplaypreservechangesymboldisplay
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetRestartIDNumbersWithNewReport ( bool  restartIDNumbersWithNewReport)

Sets the restart id numbers with new report
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
restartIDNumbersWithNewReportrestartidnumberswithnewreport
void NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SetSnapshotDataToUse ( NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SnapshotDataToUseType  snapshotDataToUse)

Sets the snapshot data to use
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
snapshotDataToUsesnapshotdatatouse
NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SnapshotDataToUseType NXOpen::Drawings::TrackDrawingChangesGeneralBuilder::SnapshotDataToUse ( )

Returns the snapshot data to use
Created in NX11.0.0.



License requirements : None

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