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

Represents a NXOpen::Features::TabNoteCfgBuilder. More...

Inheritance diagram for NXOpen::Features::TabNoteCfgBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Refplane {
  RefplaneXy, RefplaneYz, RefplaneZx, RefplaneNegXy,
  RefplaneNegYz, RefplaneNegZx
}
 the reference plane type. More...
 

Public Member Functions

double BlockOffset ()
 Returns the block offset
Created in NX5.0.3. More...
 
bool DeletePreviousDiagrams ()
 Returns the delete previous diagrams
Created in NX5.0.3. More...
 
NXOpen::PointInsertionPoint ()
 Returns the insertion point
Created in NX5.0.3. More...
 
int NumberOfRows ()
 Returns the number of rows
Created in NX5.0.3. More...
 
NXOpen::Features::TabNoteCfgBuilder::Refplane ReferencePlane ()
 Returns the reference plane
Created in NX5.0.3. More...
 
void SetBlockOffset (double blockOffset)
 Sets the block offset
Created in NX5.0.3. More...
 
void SetDeletePreviousDiagrams (bool deletePreviousDiagrams)
 Sets the delete previous diagrams
Created in NX5.0.3. More...
 
void SetInsertionPoint (NXOpen::Point *insertionPoint)
 Sets the insertion point
Created in NX5.0.3. More...
 
void SetNumberOfRows (int numberOfRows)
 Sets the number of rows
Created in NX5.0.3. More...
 
void SetReferencePlane (NXOpen::Features::TabNoteCfgBuilder::Refplane referencePlane)
 Sets the reference plane
Created in NX5.0.3. 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::Features::TabNoteCfgBuilder.


Created in NX5.0.3.

Member Enumeration Documentation

the reference plane type.

Enumerator
RefplaneXy 

0 : Xc-Yc plane

RefplaneYz 

1 : Yc-Zc plane

RefplaneZx 

2 : Zc-Xc plane

RefplaneNegXy 

3 : - Xc-Yc plane

RefplaneNegYz 

4 : - Yc-Zc plane

RefplaneNegZx 

5 : - Zc-Xc plane

Member Function Documentation

double NXOpen::Features::TabNoteCfgBuilder::BlockOffset ( )

Returns the block offset
Created in NX5.0.3.



License requirements : None

bool NXOpen::Features::TabNoteCfgBuilder::DeletePreviousDiagrams ( )

Returns the delete previous diagrams
Created in NX5.0.3.



License requirements : None

NXOpen::Point* NXOpen::Features::TabNoteCfgBuilder::InsertionPoint ( )

Returns the insertion point
Created in NX5.0.3.



License requirements : None

int NXOpen::Features::TabNoteCfgBuilder::NumberOfRows ( )

Returns the number of rows
Created in NX5.0.3.



License requirements : None

NXOpen::Features::TabNoteCfgBuilder::Refplane NXOpen::Features::TabNoteCfgBuilder::ReferencePlane ( )

Returns the reference plane
Created in NX5.0.3.



License requirements : None

void NXOpen::Features::TabNoteCfgBuilder::SetBlockOffset ( double  blockOffset)

Sets the block offset
Created in NX5.0.3.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
blockOffsetblockoffset
void NXOpen::Features::TabNoteCfgBuilder::SetDeletePreviousDiagrams ( bool  deletePreviousDiagrams)

Sets the delete previous diagrams
Created in NX5.0.3.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
deletePreviousDiagramsdeletepreviousdiagrams
void NXOpen::Features::TabNoteCfgBuilder::SetInsertionPoint ( NXOpen::Point insertionPoint)

Sets the insertion point
Created in NX5.0.3.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
insertionPointinsertionpoint
void NXOpen::Features::TabNoteCfgBuilder::SetNumberOfRows ( int  numberOfRows)

Sets the number of rows
Created in NX5.0.3.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
numberOfRowsnumberofrows
void NXOpen::Features::TabNoteCfgBuilder::SetReferencePlane ( NXOpen::Features::TabNoteCfgBuilder::Refplane  referencePlane)

Sets the reference plane
Created in NX5.0.3.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
referencePlanereferenceplane
virtual bool NXOpen::Features::TabNoteCfgBuilder::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.