NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::LineDesigner::DefineToolBuilder Class Reference

Define Tool
To create a new instance of this class, use NXOpen::LineDesigner::LineDesignerManager::CreateDefineToolBuilder

Created in NX12.0.1. More...

Inheritance diagram for NXOpen::LineDesigner::DefineToolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ToolType {
  ToolTypeGun, ToolTypeServoGun, ToolTypePneumaticServoGun, ToolTypePaintGun,
  ToolTypeGripper
}
 This enum is providing possible tool type. More...
 

Public Member Functions

NXString BaseFrameCompitableTypeName ()
 Returns the base frame compitable type name
Created in NX12.0.1. More...
 
NXOpen::DirectionBaseFrameDirectionOfConnector ()
 Returns the base frame direction of connector
Created in NX12.0.1. More...
 
NXOpen::DirectionBaseFrameParallelToObjectDirection ()
 Returns the base frame parallel to object direction
Created in NX12.0.1. More...
 
NXOpen::PointBaseFramePoint ()
 Returns the base frame point
Created in NX12.0.1. More...
 
std::vector< NXStringGetBaseFrameCompatibleTypeList ()
 The base frame compatible connector types are returns
Created in NX12.0.0. More...
 
std::vector< NXOpen::Expression * > GetBaseFramePropagatedExpression ()
 The base frame connector propagated expressions
Created in NX12.0.0. More...
 
void SetBaseFrameCompatibleTypeList (const std::vector< NXString > &baseFrameCompatibleTypeList)
 The base connector compatible types are set
Created in NX12.0.0. More...
 
void SetBaseFrameCompitableTypeName (const NXString &baseFrameCompitableTypeName)
 Sets the base frame compitable type name
Created in NX12.0.1. More...
 
void SetBaseFrameCompitableTypeName (const char *baseFrameCompitableTypeName)
 Sets the base frame compitable type name
Created in NX12.0.1. More...
 
void SetBaseFrameDirectionOfConnector (NXOpen::Direction *baseFrameDirectionOfConnector)
 Sets the base frame direction of connector
Created in NX12.0.1. More...
 
void SetBaseFrameParallelToObjectDirection (NXOpen::Direction *baseFrameParallelToObjectDirection)
 Sets the base frame parallel to object direction
Created in NX12.0.1. More...
 
void SetBaseFramePoint (NXOpen::Point *baseFramePoint)
 Sets the base frame point
Created in NX12.0.1. More...
 
void SetBaseFramePropagatedExpression (const std::vector< NXOpen::Expression * > &baseFramePropagatedExpression)
 The base frame connector propagated expressions are set
Created in NX12.0.0. More...
 
void SetNthBaseFramePropagatedExpression (int nthBaseFramePropagatedExpression, NXOpen::Expression *baseFramePropagatedExpression)
 The Nth expressions from base frame connector propagated expressions are set
Created in NX12.0.0. More...
 
void SetToolFrameDirectionOfConnector (NXOpen::Direction *toolFrameDirectionOfConnector)
 Sets the tool frame direction of connector
Created in NX12.0.1. More...
 
void SetToolFrameParallelToObjectDirection (NXOpen::Direction *toolFrameParallelToObjectDirection)
 Sets the tool frame parallel to object direction
Created in NX12.0.1. More...
 
void SetToolFramePoint (NXOpen::Point *toolFramePoint)
 Sets the tool frame point
Created in NX12.0.1. More...
 
void SetToolTypeList (NXOpen::LineDesigner::DefineToolBuilder::ToolType enumToolType)
 Sets the tool type list
Created in NX12.0.1. More...
 
NXOpen::DirectionToolFrameDirectionOfConnector ()
 Returns the tool frame direction of connector
Created in NX12.0.1. More...
 
NXOpen::DirectionToolFrameParallelToObjectDirection ()
 Returns the tool frame parallel to object direction
Created in NX12.0.1. More...
 
NXOpen::PointToolFramePoint ()
 Returns the tool frame point
Created in NX12.0.1. More...
 
NXOpen::LineDesigner::DefineToolBuilder::ToolType ToolTypeList ()
 Returns the tool type list
Created in NX12.0.1. 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

Define Tool
To create a new instance of this class, use NXOpen::LineDesigner::LineDesignerManager::CreateDefineToolBuilder

Created in NX12.0.1.


Member Enumeration Documentation

This enum is providing possible tool type.

Enumerator
ToolTypeGun 

gun

ToolTypeServoGun 

servo gun

ToolTypePneumaticServoGun 

pneumatic servo gun

ToolTypePaintGun 

paint gun

ToolTypeGripper 

gripper

Member Function Documentation

NXString NXOpen::LineDesigner::DefineToolBuilder::BaseFrameCompitableTypeName ( )

Returns the base frame compitable type name
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Direction* NXOpen::LineDesigner::DefineToolBuilder::BaseFrameDirectionOfConnector ( )

Returns the base frame direction of connector
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Direction* NXOpen::LineDesigner::DefineToolBuilder::BaseFrameParallelToObjectDirection ( )

Returns the base frame parallel to object direction
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Point* NXOpen::LineDesigner::DefineToolBuilder::BaseFramePoint ( )

Returns the base frame point
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

std::vector<NXString> NXOpen::LineDesigner::DefineToolBuilder::GetBaseFrameCompatibleTypeList ( )

The base frame compatible connector types are returns
Created in NX12.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

std::vector<NXOpen::Expression *> NXOpen::LineDesigner::DefineToolBuilder::GetBaseFramePropagatedExpression ( )

The base frame connector propagated expressions
Created in NX12.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFrameCompatibleTypeList ( const std::vector< NXString > &  baseFrameCompatibleTypeList)

The base connector compatible types are set
Created in NX12.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFrameCompatibleTypeListbaseframecompatibletypelist
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFrameCompitableTypeName ( const NXString baseFrameCompitableTypeName)

Sets the base frame compitable type name
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFrameCompitableTypeNamebaseframecompitabletypename
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFrameCompitableTypeName ( const char *  baseFrameCompitableTypeName)

Sets the base frame compitable type name
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFrameCompitableTypeNamebaseframecompitabletypename
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFrameDirectionOfConnector ( NXOpen::Direction baseFrameDirectionOfConnector)

Sets the base frame direction of connector
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFrameDirectionOfConnectorbaseframedirectionofconnector
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFrameParallelToObjectDirection ( NXOpen::Direction baseFrameParallelToObjectDirection)

Sets the base frame parallel to object direction
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFrameParallelToObjectDirectionbaseframeparalleltoobjectdirection
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFramePoint ( NXOpen::Point baseFramePoint)

Sets the base frame point
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFramePointbaseframepoint
void NXOpen::LineDesigner::DefineToolBuilder::SetBaseFramePropagatedExpression ( const std::vector< NXOpen::Expression * > &  baseFramePropagatedExpression)

The base frame connector propagated expressions are set
Created in NX12.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
baseFramePropagatedExpressionbaseframepropagatedexpression
void NXOpen::LineDesigner::DefineToolBuilder::SetNthBaseFramePropagatedExpression ( int  nthBaseFramePropagatedExpression,
NXOpen::Expression baseFramePropagatedExpression 
)

The Nth expressions from base frame connector propagated expressions are set
Created in NX12.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
nthBaseFramePropagatedExpressionnthbaseframepropagatedexpression
baseFramePropagatedExpressionbaseframepropagatedexpression
void NXOpen::LineDesigner::DefineToolBuilder::SetToolFrameDirectionOfConnector ( NXOpen::Direction toolFrameDirectionOfConnector)

Sets the tool frame direction of connector
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
toolFrameDirectionOfConnectortoolframedirectionofconnector
void NXOpen::LineDesigner::DefineToolBuilder::SetToolFrameParallelToObjectDirection ( NXOpen::Direction toolFrameParallelToObjectDirection)

Sets the tool frame parallel to object direction
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
toolFrameParallelToObjectDirectiontoolframeparalleltoobjectdirection
void NXOpen::LineDesigner::DefineToolBuilder::SetToolFramePoint ( NXOpen::Point toolFramePoint)

Sets the tool frame point
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
toolFramePointtoolframepoint
void NXOpen::LineDesigner::DefineToolBuilder::SetToolTypeList ( NXOpen::LineDesigner::DefineToolBuilder::ToolType  enumToolType)

Sets the tool type list
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
enumToolTypeenumtooltype
NXOpen::Direction* NXOpen::LineDesigner::DefineToolBuilder::ToolFrameDirectionOfConnector ( )

Returns the tool frame direction of connector
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Direction* NXOpen::LineDesigner::DefineToolBuilder::ToolFrameParallelToObjectDirection ( )

Returns the tool frame parallel to object direction
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Point* NXOpen::LineDesigner::DefineToolBuilder::ToolFramePoint ( )

Returns the tool frame point
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::LineDesigner::DefineToolBuilder::ToolType NXOpen::LineDesigner::DefineToolBuilder::ToolTypeList ( )

Returns the tool type list
Created in NX12.0.1.



License requirements : ld_line_designer ("FULL LINE DESIGNER")


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