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

Represents a Fragment creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateFragmentBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::FragmentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::AME::AspectDetailsBuilderAspectDetailsBuilder ()
 Returns the fragment aspect details
Created in NX11.0.0. More...
 
NXOpen::AME::FragmentAttributeHolderFragmentAttributeHolder ()
 Returns the attribute holder
Created in NX11.0.0. More...
 
NXString FragmentDescription ()
 Returns the fragment description
Created in NX11.0.0. More...
 
NXString FragmentName ()
 Returns the fragment name
Created in NX11.0.0. More...
 
void SetFragmentDescription (const NXString &fragmentDescription)
 Sets the fragment description
Created in NX11.0.0. More...
 
void SetFragmentDescription (const char *fragmentDescription)
 Sets the fragment description
Created in NX11.0.0. More...
 
void SetFragmentName (const NXString &fragmentName)
 Sets the fragment name
Created in NX11.0.0. More...
 
void SetFragmentName (const char *fragmentName)
 Sets the fragment name
Created in NX11.0.0. More...
 
void SetType (NXOpen::AME::PageBuilder::Types fragmentType)
 Sets the fragment type
Created in NX11.0.0. More...
 
NXOpen::AME::PageBuilder::Types Type ()
 Returns the fragment type
Created in NX11.0.0. 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

Represents a Fragment creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateFragmentBuilder

Created in NX11.0.0.


Member Function Documentation

NXOpen::AME::AspectDetailsBuilder* NXOpen::AME::FragmentBuilder::AspectDetailsBuilder ( )

Returns the fragment aspect details
Created in NX11.0.0.



License requirements : None

NXOpen::AME::FragmentAttributeHolder* NXOpen::AME::FragmentBuilder::FragmentAttributeHolder ( )

Returns the attribute holder
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::FragmentBuilder::FragmentDescription ( )

Returns the fragment description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::FragmentBuilder::FragmentName ( )

Returns the fragment name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::FragmentBuilder::SetFragmentDescription ( const NXString fragmentDescription)

Sets the fragment description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fragmentDescriptionfragmentdescription
void NXOpen::AME::FragmentBuilder::SetFragmentDescription ( const char *  fragmentDescription)

Sets the fragment description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fragmentDescriptionfragmentdescription
void NXOpen::AME::FragmentBuilder::SetFragmentName ( const NXString fragmentName)

Sets the fragment name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fragmentNamefragmentname
void NXOpen::AME::FragmentBuilder::SetFragmentName ( const char *  fragmentName)

Sets the fragment name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fragmentNamefragmentname
void NXOpen::AME::FragmentBuilder::SetType ( NXOpen::AME::PageBuilder::Types  fragmentType)

Sets the fragment type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
fragmentTypefragmenttype
NXOpen::AME::PageBuilder::Types NXOpen::AME::FragmentBuilder::Type ( )

Returns the fragment type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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