Represents a NXOpen::FileNew
This class is not directly created.
More...
Public Member Functions | |
| NXOpen::FileNewApplication | Application () |
| Returns the application type for the new file being created More... | |
| NXString | ApplicationName () |
| Returns the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names. More... | |
| NXString | DesignElementState () |
| Returns the state for the new design element. More... | |
| NXString | DesignElementType () |
| Returns the design element type for the new design element. More... | |
| NXOpen::DisplayPartOption | DisplayPartOption () |
| Returns the display part option. More... | |
| bool | GetAddMasterFlag () |
| Returns logical value to indicate whether master to be added as child component. More... | |
| std::vector< NXString > | GetApplicationNames () |
| Returns all registered application names. More... | |
| std::vector< NXString > | GetAvailableTemplates () |
| Returns the available templates for the session. More... | |
| bool | GetCanCreateAltrep () |
| Gets the flag specifying if the current template customization allows Alternate representation creation using the template. More... | |
| NXString | ItemType () |
| Returns the item type for the new file. More... | |
| bool | MakeDisplayedPart () |
| Returns the property that controls if the new file should be made the displayed part Created in NX5.0.0. More... | |
| NXString | MasterFileName () |
| Returns the name of the master model part to be referenced. More... | |
| NXString | NewFileName () |
| Returns the name of the new file being created Created in NX5.0.0. More... | |
| NXString | RelationType () |
| Returns the relation type of the underlying template which is used for the new file being created. More... | |
| void | SetAddMasterFlag (bool addMaster) |
| Sets addMaster flag More... | |
| void | SetApplication (NXOpen::FileNewApplication application) |
| Sets the application type for the new file being created More... | |
| void | SetApplicationName (const NXString &application) |
| Sets the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names. More... | |
| void | SetApplicationName (const char *application) |
| Sets the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names. More... | |
| void | SetCanCreateAltrep (bool createAltrep) |
| Sets the flag specifying if the current template customization allows Alternate representation creation using the template Created in NX10.0.0. More... | |
| void | SetDesignElementState (const NXString &deState) |
| Sets the state for the new design element. More... | |
| void | SetDesignElementState (const char *deState) |
| Sets the state for the new design element. More... | |
| void | SetDesignElementType (const NXString &deType) |
| Sets the design element type for the new design element. More... | |
| void | SetDesignElementType (const char *deType) |
| Sets the design element type for the new design element. More... | |
| void | SetDisplayPartOption (NXOpen::DisplayPartOption displayPartOption) |
| Sets the display part option. More... | |
| void | SetItemType (const NXString &itemType) |
| Sets the item type for the new file. More... | |
| void | SetItemType (const char *itemType) |
| Sets the item type for the new file. More... | |
| void | SetMakeDisplayedPart (bool makeDisplayedPart) |
| Sets the property that controls if the new file should be made the displayed part Created in NX5.0.0. More... | |
| void | SetMasterFileName (const NXString &masterFileName) |
| Sets the name of the master model part to be referenced. More... | |
| void | SetMasterFileName (const char *masterFileName) |
| Sets the name of the master model part to be referenced. More... | |
| void | SetNewFileName (const NXString &fileName) |
| Sets the name of the new file being created Created in NX5.0.0. More... | |
| void | SetNewFileName (const char *fileName) |
| Sets the name of the new file being created Created in NX5.0.0. More... | |
| void | SetPartOperationCreateBuilder (NXOpen::PDM::PartOperationBuilder *partOperationBuilder) |
| Sets NXOpen::PDM::PartOperationBuilder Created in NX10.0.0. More... | |
| void | SetProjectsData (std::vector< NXString > &projectName, const std::vector< int > &assignmentState) |
| Teamcenter projects data More... | |
| void | SetRelationType (const NXString &relationType) |
| Sets the relation type of the underlying template which is used for the new file being created. More... | |
| void | SetRelationType (const char *relationType) |
| Sets the relation type of the underlying template which is used for the new file being created. More... | |
| void | SetSpecialization (const NXString &specialization) |
| Sets the specialization for the new file Created in NX8.5.0. More... | |
| void | SetSpecialization (const char *specialization) |
| Sets the specialization for the new file Created in NX8.5.0. More... | |
| void | SetTemplateFileName (const NXString &templateFileName) |
| Sets the name of the template part from which to create the new file Created in NX5.0.0. More... | |
| void | SetTemplateFileName (const char *templateFileName) |
| Sets the name of the template part from which to create the new file Created in NX5.0.0. More... | |
| void | SetTemplatePresentationName (const NXString &presentationName) |
| Sets the presentation name of the underlying template which is used for the new file being created Created in NX8.5.0. More... | |
| void | SetTemplatePresentationName (const char *presentationName) |
| Sets the presentation name of the underlying template which is used for the new file being created Created in NX8.5.0. More... | |
| void | SetTemplateType (NXOpen::FileNewTemplateType templateType) |
| Sets the template type for the new file being created Created in NX8.0.0. More... | |
| void | SetUnits (NXOpen::Part::Units units) |
| Sets the units for the new file being created Created in NX5.0.0. More... | |
| void | SetUseBlankTemplate (bool useBlankTemplate) |
| Sets the property that controls if the new file should be created using a blank template. More... | |
| void | SetUsesMasterModel (const NXString &usesMasterModel) |
| Sets the uses master model flag of the underlying template which is used for the new file being created. More... | |
| void | SetUsesMasterModel (const char *usesMasterModel) |
| Sets the uses master model flag of the underlying template which is used for the new file being created. More... | |
| NXString | Specialization () |
| Returns the specialization for the new file Created in NX8.5.0. More... | |
| NXString | TemplateFileName () |
| Returns the name of the template part from which to create the new file Created in NX5.0.0. More... | |
| NXString | TemplatePresentationName () |
| Returns the presentation name of the underlying template which is used for the new file being created Created in NX8.5.0. More... | |
| NXOpen::FileNewTemplateType | TemplateType () |
| Returns the template type for the new file being created Created in NX8.0.0. More... | |
| NXOpen::Part::Units | Units () |
| Returns the units for the new file being created Created in NX5.0.0. More... | |
| bool | UseBlankTemplate () |
| Returns the property that controls if the new file should be created using a blank template. More... | |
| NXString | UsesMasterModel () |
| Returns the uses master model flag of the underlying template which is used for the new file being created. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| 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::NXObject * | GetObject () |
| 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 NXOpen::FileNew
This class is not directly created.
The creator of the super class does the real work
Created in NX5.0.0.
Member Function Documentation
| NXOpen::FileNewApplication NXOpen::FileNew::Application | ( | ) |
Returns the application type for the new file being created
- Deprecated:
- Deprecated in NX9.0.0.
Use NXOpen::FileNew::ApplicationName that takes a string name instead.
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::ApplicationName | ( | ) |
Returns the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names.
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::DesignElementState | ( | ) |
Returns the state for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element states
Created in NX8.5.0.
License requirements : None
| NXString NXOpen::FileNew::DesignElementType | ( | ) |
Returns the design element type for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element types
Created in NX8.5.0.
License requirements : None
| NXOpen::DisplayPartOption NXOpen::FileNew::DisplayPartOption | ( | ) |
Returns the display part option.
See NXOpen::DisplayPartOption .
Created in NX12.0.0.
License requirements : None
| bool NXOpen::FileNew::GetAddMasterFlag | ( | ) |
Returns logical value to indicate whether master to be added as child component.
- Returns
- whether master to be added as child component
- Deprecated:
- Deprecated in NX10.0.0. Use NXOpen::PDM::PartOperationCreateBuilder::GetAddMaster to get addMaster flag.
Created in NX6.0.0.
License requirements : None
| std::vector<NXString> NXOpen::FileNew::GetApplicationNames | ( | ) |
Returns all registered application names.
These name should be used while setting the application name in SetApplicationName .
- Returns
- All registered application names
Created in NX9.0.0.
License requirements : None
| std::vector<NXString> NXOpen::FileNew::GetAvailableTemplates | ( | ) |
Returns the available templates for the session.
- Returns
- array of available template names
Created in NX6.0.0.
License requirements : None
| bool NXOpen::FileNew::GetCanCreateAltrep | ( | ) |
Gets the flag specifying if the current template customization allows Alternate representation creation using the template.
- Returns
Created in NX10.0.0.
License requirements : None
| NXString NXOpen::FileNew::ItemType | ( | ) |
Returns the item type for the new file.
It can be a comma separated string in case the underlying template supports multiple item types
Created in NX8.5.0.
License requirements : None
| bool NXOpen::FileNew::MakeDisplayedPart | ( | ) |
Returns the property that controls if the new file should be made the displayed part
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::MasterFileName | ( | ) |
Returns the name of the master model part to be referenced.
May be NULL if creating a master part
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::NewFileName | ( | ) |
Returns the name of the new file being created
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::RelationType | ( | ) |
Returns the relation type of the underlying template which is used for the new file being created.
If set to 'Specification', this means non-master template is used for part creation and it will require NXOpen::FileNew::SetUsesMasterModel to be set to 'Yes'
Created in NX8.5.3.
License requirements : None
| void NXOpen::FileNew::SetAddMasterFlag | ( | bool | addMaster | ) |
Sets addMaster flag
- Deprecated:
- Deprecated in NX10.0.0.
Use NXOpen::PDM::PartOperationCreateBuilder::SetAddMaster to set addMaster flag.
Created in NX6.0.0.
License requirements : None
- Parameters
-
addMaster whether master to be added as child component
| void NXOpen::FileNew::SetApplication | ( | NXOpen::FileNewApplication | application | ) |
Sets the application type for the new file being created
- Deprecated:
- Deprecated in NX9.0.0.
Use NXOpen::FileNew::SetApplicationName that takes a string name instead.
Created in NX5.0.0.
License requirements : None
- Parameters
-
application application
| void NXOpen::FileNew::SetApplicationName | ( | const NXString & | application | ) |
Sets the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names.
Created in NX5.0.0.
License requirements : None
- Parameters
-
application application
| void NXOpen::FileNew::SetApplicationName | ( | const char * | application | ) |
Sets the application type for the new file being created Use NXOpen::FileNew::GetApplicationNames to get valid application names.
Created in NX5.0.0.
License requirements : None
- Parameters
-
application application
| void NXOpen::FileNew::SetCanCreateAltrep | ( | bool | createAltrep | ) |
Sets the flag specifying if the current template customization allows Alternate representation creation using the template
Created in NX10.0.0.
License requirements : None
- Parameters
-
createAltrep createaltrep
| void NXOpen::FileNew::SetDesignElementState | ( | const NXString & | deState | ) |
Sets the state for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element states
Created in NX8.5.0.
License requirements : None
- Parameters
-
deState destate
| void NXOpen::FileNew::SetDesignElementState | ( | const char * | deState | ) |
Sets the state for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element states
Created in NX8.5.0.
License requirements : None
- Parameters
-
deState destate
| void NXOpen::FileNew::SetDesignElementType | ( | const NXString & | deType | ) |
Sets the design element type for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element types
Created in NX8.5.0.
License requirements : None
- Parameters
-
deType detype
| void NXOpen::FileNew::SetDesignElementType | ( | const char * | deType | ) |
Sets the design element type for the new design element.
It can be a comma separated string in case the underlying template supports multiple design element types
Created in NX8.5.0.
License requirements : None
- Parameters
-
deType detype
| void NXOpen::FileNew::SetDisplayPartOption | ( | NXOpen::DisplayPartOption | displayPartOption | ) |
Sets the display part option.
See NXOpen::DisplayPartOption .
Created in NX12.0.0.
License requirements : None
- Parameters
-
displayPartOption display part option
| void NXOpen::FileNew::SetItemType | ( | const NXString & | itemType | ) |
Sets the item type for the new file.
It can be a comma separated string in case the underlying template supports multiple item types
Created in NX8.5.0.
License requirements : None
- Parameters
-
itemType itemtype
| void NXOpen::FileNew::SetItemType | ( | const char * | itemType | ) |
Sets the item type for the new file.
It can be a comma separated string in case the underlying template supports multiple item types
Created in NX8.5.0.
License requirements : None
- Parameters
-
itemType itemtype
| void NXOpen::FileNew::SetMakeDisplayedPart | ( | bool | makeDisplayedPart | ) |
Sets the property that controls if the new file should be made the displayed part
Created in NX5.0.0.
License requirements : None
- Parameters
-
makeDisplayedPart make displayed part
| void NXOpen::FileNew::SetMasterFileName | ( | const NXString & | masterFileName | ) |
Sets the name of the master model part to be referenced.
May be NULL if creating a master part
Created in NX5.0.0.
License requirements : None
- Parameters
-
masterFileName masterfilename
| void NXOpen::FileNew::SetMasterFileName | ( | const char * | masterFileName | ) |
Sets the name of the master model part to be referenced.
May be NULL if creating a master part
Created in NX5.0.0.
License requirements : None
- Parameters
-
masterFileName masterfilename
| void NXOpen::FileNew::SetNewFileName | ( | const NXString & | fileName | ) |
Sets the name of the new file being created
Created in NX5.0.0.
License requirements : None
- Parameters
-
fileName filename
| void NXOpen::FileNew::SetNewFileName | ( | const char * | fileName | ) |
Sets the name of the new file being created
Created in NX5.0.0.
License requirements : None
- Parameters
-
fileName filename
| void NXOpen::FileNew::SetPartOperationCreateBuilder | ( | NXOpen::PDM::PartOperationBuilder * | partOperationBuilder | ) |
Sets NXOpen::PDM::PartOperationBuilder
Created in NX10.0.0.
License requirements : None
- Parameters
-
partOperationBuilder partoperationbuilder
| void NXOpen::FileNew::SetProjectsData | ( | std::vector< NXString > & | projectName, |
| const std::vector< int > & | assignmentState | ||
| ) |
Teamcenter projects data
- Deprecated:
- Deprecated in NX10.0.0.
Use NXOpen::Session::AssignRemoveProjects to assign/remove projects.
Created in NX6.0.0.
License requirements : None
- Parameters
-
projectName name of the project assignmentState assignment state
| void NXOpen::FileNew::SetRelationType | ( | const NXString & | relationType | ) |
Sets the relation type of the underlying template which is used for the new file being created.
If set to 'Specification', this means non-master template is used for part creation and it will require NXOpen::FileNew::SetUsesMasterModel to be set to 'Yes'
Created in NX8.5.3.
License requirements : None
- Parameters
-
relationType relationtype
| void NXOpen::FileNew::SetRelationType | ( | const char * | relationType | ) |
Sets the relation type of the underlying template which is used for the new file being created.
If set to 'Specification', this means non-master template is used for part creation and it will require NXOpen::FileNew::SetUsesMasterModel to be set to 'Yes'
Created in NX8.5.3.
License requirements : None
- Parameters
-
relationType relationtype
| void NXOpen::FileNew::SetSpecialization | ( | const NXString & | specialization | ) |
Sets the specialization for the new file
Created in NX8.5.0.
License requirements : None
- Parameters
-
specialization specialization
| void NXOpen::FileNew::SetSpecialization | ( | const char * | specialization | ) |
Sets the specialization for the new file
Created in NX8.5.0.
License requirements : None
- Parameters
-
specialization specialization
| void NXOpen::FileNew::SetTemplateFileName | ( | const NXString & | templateFileName | ) |
Sets the name of the template part from which to create the new file
Created in NX5.0.0.
License requirements : None
- Parameters
-
templateFileName templatefilename
| void NXOpen::FileNew::SetTemplateFileName | ( | const char * | templateFileName | ) |
Sets the name of the template part from which to create the new file
Created in NX5.0.0.
License requirements : None
- Parameters
-
templateFileName templatefilename
| void NXOpen::FileNew::SetTemplatePresentationName | ( | const NXString & | presentationName | ) |
Sets the presentation name of the underlying template which is used for the new file being created
Created in NX8.5.0.
License requirements : None
- Parameters
-
presentationName presentationname
| void NXOpen::FileNew::SetTemplatePresentationName | ( | const char * | presentationName | ) |
Sets the presentation name of the underlying template which is used for the new file being created
Created in NX8.5.0.
License requirements : None
- Parameters
-
presentationName presentationname
| void NXOpen::FileNew::SetTemplateType | ( | NXOpen::FileNewTemplateType | templateType | ) |
Sets the template type for the new file being created
Created in NX8.0.0.
License requirements : None
- Parameters
-
templateType templatetype
| void NXOpen::FileNew::SetUnits | ( | NXOpen::Part::Units | units | ) |
Sets the units for the new file being created
Created in NX5.0.0.
License requirements : None
- Parameters
-
units units
| void NXOpen::FileNew::SetUseBlankTemplate | ( | bool | useBlankTemplate | ) |
Sets the property that controls if the new file should be created using a blank template.
If set to False, then a valid file name for an existing template part file must be supplied to NXOpen::FileNew::SetTemplateFileName . If set to True, this means that no template is used during creation.
Note: This property should be set to True only while creating traditional items with template type set as FileNewTemplateTypeItem
Created in NX5.0.0.
License requirements : None
- Parameters
-
useBlankTemplate use blank template
| void NXOpen::FileNew::SetUsesMasterModel | ( | const NXString & | usesMasterModel | ) |
Sets the uses master model flag of the underlying template which is used for the new file being created.
If set to 'No', this means that master template is used for part creation. If set to 'Yes', this means non-master template is used and it will require master model part to be specified for part creation
Created in NX8.5.3.
License requirements : None
- Parameters
-
usesMasterModel usesmastermodel
| void NXOpen::FileNew::SetUsesMasterModel | ( | const char * | usesMasterModel | ) |
Sets the uses master model flag of the underlying template which is used for the new file being created.
If set to 'No', this means that master template is used for part creation. If set to 'Yes', this means non-master template is used and it will require master model part to be specified for part creation
Created in NX8.5.3.
License requirements : None
- Parameters
-
usesMasterModel usesmastermodel
| NXString NXOpen::FileNew::Specialization | ( | ) |
Returns the specialization for the new file
Created in NX8.5.0.
License requirements : None
| NXString NXOpen::FileNew::TemplateFileName | ( | ) |
Returns the name of the template part from which to create the new file
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::TemplatePresentationName | ( | ) |
Returns the presentation name of the underlying template which is used for the new file being created
Created in NX8.5.0.
License requirements : None
| NXOpen::FileNewTemplateType NXOpen::FileNew::TemplateType | ( | ) |
Returns the template type for the new file being created
Created in NX8.0.0.
License requirements : None
| NXOpen::Part::Units NXOpen::FileNew::Units | ( | ) |
Returns the units for the new file being created
Created in NX5.0.0.
License requirements : None
| bool NXOpen::FileNew::UseBlankTemplate | ( | ) |
Returns the property that controls if the new file should be created using a blank template.
If set to False, then a valid file name for an existing template part file must be supplied to NXOpen::FileNew::SetTemplateFileName . If set to True, this means that no template is used during creation.
Note: This property should be set to True only while creating traditional items with template type set as FileNewTemplateTypeItem
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::FileNew::UsesMasterModel | ( | ) |
Returns the uses master model flag of the underlying template which is used for the new file being created.
If set to 'No', this means that master template is used for part creation. If set to 'Yes', this means non-master template is used and it will require master model part to be specified for part creation
Created in NX8.5.3.
License requirements : None
The documentation for this class was generated from the following file:
- FileNew.hxx