NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Layout2d::ComponentNameBuilder Class Reference

This class is used to construct the component name and part file name block, if it is in manage mode, we also have item number, item revision and item name . More...

Inheritance diagram for NXOpen::Layout2d::ComponentNameBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Layout2d::Layout2dDefinitionLocation Location ()
 Returns the location type of the component indicating local, native or team center
Created in NX10.0.0. More...
 
NXString Name ()
 Returns the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free. More...
 
NXString PartName ()
 Returns the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0. More...
 
void SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation location)
 Sets the location type of the component indicating local, native or team center
Created in NX10.0.0. More...
 
void SetName (const NXString &name)
 Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free. More...
 
void SetName (const char *name)
 Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free. More...
 
void SetPartName (const NXString &partName)
 Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0. More...
 
void SetPartName (const char *partName)
 Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0. More...
 
void SetPartOperationBuilder (NXOpen::PDM::PartOperationCreateBuilder *partOperationBuilder)
 Sets NXOpen::PDM::PartOperationCreateBuilder
Created in NX10.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

This class is used to construct the component name and part file name block, if it is in manage mode, we also have item number, item revision and item name .


Created in NX10.0.0.

Member Function Documentation

NXOpen::Layout2d::Layout2dDefinitionLocation NXOpen::Layout2d::ComponentNameBuilder::Location ( )

Returns the location type of the component indicating local, native or team center
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::Name ( )

Returns the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.


Created in NX10.0.0.

License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::PartName ( )

Returns the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0.



License requirements : None

void NXOpen::Layout2d::ComponentNameBuilder::SetLocation ( NXOpen::Layout2d::Layout2dDefinitionLocation  location)

Sets the location type of the component indicating local, native or team center
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
locationlocation
void NXOpen::Layout2d::ComponentNameBuilder::SetName ( const NXString name)

Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.


Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters
namename
void NXOpen::Layout2d::ComponentNameBuilder::SetName ( const char *  name)

Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.


Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters
namename
void NXOpen::Layout2d::ComponentNameBuilder::SetPartName ( const NXString partName)

Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNamepartname
void NXOpen::Layout2d::ComponentNameBuilder::SetPartName ( const char *  partName)

Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partNamepartname
void NXOpen::Layout2d::ComponentNameBuilder::SetPartOperationBuilder ( NXOpen::PDM::PartOperationCreateBuilder partOperationBuilder)

Sets NXOpen::PDM::PartOperationCreateBuilder
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partOperationBuilderpartoperationbuilder
virtual bool NXOpen::Layout2d::ComponentNameBuilder::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.