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

Represents a re-usable component for basic properties such as name and description
This object does not need a creator. More...

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

Public Member Functions

NXString Description ()
 Returns the description
Created in NX12.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX12.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX12.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX12.0.0. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX12.0.0. More...
 
void SetName (const char *name)
 Sets the name
Created in NX12.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 re-usable component for basic properties such as name and description
This object does not need a creator.



Created in NX12.0.0.

Member Function Documentation

NXString NXOpen::AME::BasicPropertiesBuilder::Description ( )

Returns the description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::BasicPropertiesBuilder::Name ( )

Returns the name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::BasicPropertiesBuilder::SetDescription ( const NXString description)

Sets the description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::BasicPropertiesBuilder::SetDescription ( const char *  description)

Sets the description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::BasicPropertiesBuilder::SetName ( const NXString name)

Sets the name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename
void NXOpen::AME::BasicPropertiesBuilder::SetName ( const char *  name)

Sets the name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename
virtual bool NXOpen::AME::BasicPropertiesBuilder::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.