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

Represents a builder class that performs Generic File New operations. More...

Inheritance diagram for NXOpen::PID::FileNewApplicationBuilder:
NXOpen::Gateway::IGenericFileNewApplicationBuilder NXOpen::Builder NXOpen::IAttributeSourceObjectBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::DisplayPartOption DisplayPartOption ()
 Returns the display part option for the new file being created
Created in NX12.0.0. More...
 
NXOpen::CollaborativeDesignGetCollaborativeDesign ()
 The NXOpen::CollaborativeDesign of the subset. More...
 
std::vector
< NXOpen::Assemblies::Partition * > 
GetTargetPartitions ()
 The NXOpen::Assemblies::Partition of the subset. More...
 
void SetCollaborativeDesign (NXOpen::CollaborativeDesign *collaborativeDesign)
 The NXOpen::CollaborativeDesign of the subset. More...
 
void SetDisplayPartOption (NXOpen::DisplayPartOption displayPartOption)
 Sets the display part option for the new file being created
Created in NX12.0.0. More...
 
void SetTargetPartitions (const std::vector< NXOpen::Assemblies::Partition * > &partitions)
 The Assemblies::Partition of the subset. More...
 
void SetTemplateBaseTcType (const NXString &baseTCType)
 Sets the BaseTCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplateBaseTcType (const char *baseTCType)
 Sets the BaseTCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplateFileName (const NXString &templateFileName)
 Sets the name of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplateFileName (const char *templateFileName)
 Sets the name of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplatePresentationName (const NXString &presentationName)
 Sets the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0. More...
 
void SetTemplatePresentationName (const char *presentationName)
 Sets the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0. More...
 
void SetTemplateTcType (const NXString &tcType)
 Sets the TCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplateTcType (const char *tcType)
 Sets the TCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
void SetTemplateType (NXOpen::FileNewTemplateType templateType)
 Sets the template type for the new file being created
Created in NX11.0.0. More...
 
void SetTemplateUnits (NXOpen::Part::Units units)
 Sets the units for the new file being created
Created in NX11.0.0. More...
 
NXString TemplateBaseTcType ()
 Returns the BaseTCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
NXString TemplateFileName ()
 Returns the name of the template part from which to create the new file
Created in NX11.0.0. More...
 
NXString TemplatePresentationName ()
 Returns the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0. More...
 
NXString TemplateTcType ()
 Returns the TCType of the template part from which to create the new file
Created in NX11.0.0. More...
 
NXOpen::FileNewTemplateType TemplateType ()
 Returns the template type for the new file being created
Created in NX11.0.0. More...
 
NXOpen::Part::Units TemplateUnits ()
 Returns the units for the new file being created
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Gateway::IGenericFileNewApplicationBuilder
virtual NXOpen::ErrorListAutoAssignAttributes (const std::vector< NXOpen::NXObject * > &objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::ErrorListAutoAssignAttributesWithNamingPattern (const std::vector< NXOpen::NXObject * > &objects, const std::vector< NXOpen::NXObject * > &properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
virtual NXOpen::NXObjectCreateAttributeTitleToNamingPatternMap (std::vector< NXString > &attributeTitles, std::vector< NXString > &titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern. 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 builder class that performs Generic File New operations.


To create a new instance of this class, use NXOpen::PID::PidManager::CreateFilenewapplicationBuilder

Created in NX11.0.0.

Member Function Documentation

NXOpen::DisplayPartOption NXOpen::PID::FileNewApplicationBuilder::DisplayPartOption ( )

Returns the display part option for the new file being created
Created in NX12.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::CollaborativeDesign* NXOpen::PID::FileNewApplicationBuilder::GetCollaborativeDesign ( )

The NXOpen::CollaborativeDesign of the subset.

Returns

Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
std::vector<NXOpen::Assemblies::Partition *> NXOpen::PID::FileNewApplicationBuilder::GetTargetPartitions ( )

The NXOpen::Assemblies::Partition of the subset.

Returns

Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")
void NXOpen::PID::FileNewApplicationBuilder::SetCollaborativeDesign ( NXOpen::CollaborativeDesign collaborativeDesign)

The NXOpen::CollaborativeDesign of the subset.


Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
collaborativeDesigncollaborativedesign
void NXOpen::PID::FileNewApplicationBuilder::SetDisplayPartOption ( NXOpen::DisplayPartOption  displayPartOption)

Sets the display part option for the new file being created
Created in NX12.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
displayPartOptiondisplaypartoption
void NXOpen::PID::FileNewApplicationBuilder::SetTargetPartitions ( const std::vector< NXOpen::Assemblies::Partition * > &  partitions)

The Assemblies::Partition of the subset.


Created in NX11.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
partitionspartitions
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateBaseTcType ( const NXString baseTCType)

Sets the BaseTCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
baseTCTypebasetctype
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateBaseTcType ( const char *  baseTCType)

Sets the BaseTCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
baseTCTypebasetctype
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateFileName ( const NXString templateFileName)

Sets the name of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
templateFileNametemplatefilename
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateFileName ( const char *  templateFileName)

Sets the name of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
templateFileNametemplatefilename
void NXOpen::PID::FileNewApplicationBuilder::SetTemplatePresentationName ( const NXString presentationName)

Sets the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
presentationNamepresentationname
void NXOpen::PID::FileNewApplicationBuilder::SetTemplatePresentationName ( const char *  presentationName)

Sets the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
presentationNamepresentationname
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateTcType ( const NXString tcType)

Sets the TCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
tcTypetctype
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateTcType ( const char *  tcType)

Sets the TCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
tcTypetctype
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateType ( NXOpen::FileNewTemplateType  templateType)

Sets the template type for the new file being created
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
templateTypetemplatetype
void NXOpen::PID::FileNewApplicationBuilder::SetTemplateUnits ( NXOpen::Part::Units  units)

Sets the units for the new file being created
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
unitsunits
NXString NXOpen::PID::FileNewApplicationBuilder::TemplateBaseTcType ( )

Returns the BaseTCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXString NXOpen::PID::FileNewApplicationBuilder::TemplateFileName ( )

Returns the name of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXString NXOpen::PID::FileNewApplicationBuilder::TemplatePresentationName ( )

Returns the presentation name of the underlying template which is used for creating new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXString NXOpen::PID::FileNewApplicationBuilder::TemplateTcType ( )

Returns the TCType of the template part from which to create the new file
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::FileNewTemplateType NXOpen::PID::FileNewApplicationBuilder::TemplateType ( )

Returns the template type for the new file being created
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Part::Units NXOpen::PID::FileNewApplicationBuilder::TemplateUnits ( )

Returns the units for the new file being created
Created in NX11.0.0.



License requirements : nx_pid_design_author ("NX P and ID Design Author")


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