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

Object Name Index JA class
Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::ObjectNameIndexBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString ObjectDescription ()
 Returns the object description
Created in NX11.0.0. More...
 
NXString ObjectIndex ()
 Returns the object index
Created in NX11.0.0. More...
 
NXString ObjectName ()
 Returns the object name
Created in NX11.0.0. More...
 
void SetObjectDescription (const NXString &objectDescription)
 Sets the object description
Created in NX11.0.0. More...
 
void SetObjectDescription (const char *objectDescription)
 Sets the object description
Created in NX11.0.0. More...
 
void SetObjectName (const NXString &objectName)
 Sets the object name
Created in NX11.0.0. More...
 
void SetObjectName (const char *objectName)
 Sets the object name
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

Object Name Index JA class
Created in NX11.0.0.


Member Function Documentation

NXString NXOpen::AME::ObjectNameIndexBuilder::ObjectDescription ( )

Returns the object description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ObjectNameIndexBuilder::ObjectIndex ( )

Returns the object index
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ObjectNameIndexBuilder::ObjectName ( )

Returns the object name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ObjectNameIndexBuilder::SetObjectDescription ( const NXString objectDescription)

Sets the object description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectDescriptionobjectdescription
void NXOpen::AME::ObjectNameIndexBuilder::SetObjectDescription ( const char *  objectDescription)

Sets the object description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectDescriptionobjectdescription
void NXOpen::AME::ObjectNameIndexBuilder::SetObjectName ( const NXString objectName)

Sets the object name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectNameobjectname
void NXOpen::AME::ObjectNameIndexBuilder::SetObjectName ( const char *  objectName)

Sets the object name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectNameobjectname
virtual bool NXOpen::AME::ObjectNameIndexBuilder::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.