NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder Class Reference

Represents a NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder builder used to import and export expressions from and to a spreadsheet. More...

Inheritance diagram for NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ExportOptions { ExportOptionsNewItem, ExportOptionsExistingItem }
 This enum represents the option to indicate if the expressions are to be exported to a new item or an existing item in Teamcenter. More...
 
enum  OperateOptions { OperateOptionsImport, OperateOptionsExport }
 This enum represents the import or export operate options. More...
 

Public Member Functions

void AssignItemNumber (NXString *itemId, NXString *itemName, NXString *itemRevision, bool *idSensitivity, bool *revSensitivity)
 Used to assign Item number and revision in Teamcenter . More...
 
void AssignItemRevision (const NXString &itemId, NXString *itemRevision, bool *revSensitivity)
 Used to assign Item revision in Teamcenter. More...
 
void AssignItemRevision (const char *itemId, NXString *itemRevision, bool *revSensitivity)
 Used to assign Item revision in Teamcenter. More...
 
NXString DatasetName ()
 Returns the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to. More...
 
NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::ExportOptions ExportOption ()
 Returns the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter. More...
 
NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OperateOptions OperateOption ()
 Returns the option which indicates if the spreadsheet is to be imported or exported. More...
 
bool OverrideExistingExpressions ()
 Returns the value which indicates whether to override existing expressions in the work part when importing. More...
 
void SetDatasetName (const NXString &datasetName)
 Sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to. More...
 
void SetDatasetName (const char *datasetName)
 Sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to. More...
 
void SetExportOption (NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::ExportOptions exportOption)
 Sets the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter. More...
 
void SetObjectCreateBuilder (NXOpen::PDM::ObjectCreateBuilder *objectCreateBuilder)
 Sets NXOpen::PDM::ObjectCreateBuilder
Created in NX10.0.0. More...
 
void SetOperateOption (NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OperateOptions operateOptions)
 Sets the option which indicates if the spreadsheet is to be imported or exported. More...
 
void SetOverrideExistingExpressions (bool overrideExistingExpressions)
 Sets the value which indicates whether to override existing expressions in the work part when importing. More...
 
void SetSpreadSheetFileName (const NXString &spreadSheetFileName)
 Sets the spreadsheet name which indicates the spreadsheet to be imported or exported. More...
 
void SetSpreadSheetFileName (const char *spreadSheetFileName)
 Sets the spreadsheet name which indicates the spreadsheet to be imported or exported. More...
 
void SetSpreadsheetItemID (const NXString &spreadsheetItemID)
 Sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to. More...
 
void SetSpreadsheetItemID (const char *spreadsheetItemID)
 Sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to. More...
 
void SetSpreadsheetItemName (const NXString &spreadsheetItemName)
 Sets the item name of the spreadsheet in Teamcenter. More...
 
void SetSpreadsheetItemName (const char *spreadsheetItemName)
 Sets the item name of the spreadsheet in Teamcenter. More...
 
void SetSpreadsheetItemRevision (const NXString &spreadsheetItemRevision)
 Sets the item revision of the spreadsheet that is to be imported from or exported to. More...
 
void SetSpreadsheetItemRevision (const char *spreadsheetItemRevision)
 Sets the item revision of the spreadsheet that is to be imported from or exported to. More...
 
NXString SpreadSheetFileName ()
 Returns the spreadsheet name which indicates the spreadsheet to be imported or exported. More...
 
NXString SpreadsheetItemID ()
 Returns the item ID number which indicates the item that the spreadsheet is to be imported from or exported to. More...
 
NXString SpreadsheetItemName ()
 Returns the item name of the spreadsheet in Teamcenter. More...
 
NXString SpreadsheetItemRevision ()
 Returns the item revision of the spreadsheet that is to be imported from or exported to. 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 NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder builder used to import and export expressions from and to a spreadsheet.


To create a new instance of this class, use NXOpen::Features::VehicleDesignCollection::CreateBaseDataImportExportBuilder
Default values.

Property Value

ExportOption

NewItem

OperateOption

Import

OverrideExistingExpressions

0


Created in NX8.5.0.

Member Enumeration Documentation

This enum represents the option to indicate if the expressions are to be exported to a new item or an existing item in Teamcenter.

Enumerator
ExportOptionsNewItem 

new item

ExportOptionsExistingItem 

existing item

This enum represents the import or export operate options.

Enumerator
OperateOptionsImport 

import

OperateOptionsExport 

export

Member Function Documentation

void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::AssignItemNumber ( NXString itemId,
NXString itemName,
NXString itemRevision,
bool *  idSensitivity,
bool *  revSensitivity 
)

Used to assign Item number and revision in Teamcenter .


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
itemIditemid
itemNameitemname
itemRevisionitemrevision
idSensitivityidsensitivity
revSensitivityrevsensitivity
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::AssignItemRevision ( const NXString itemId,
NXString itemRevision,
bool *  revSensitivity 
)

Used to assign Item revision in Teamcenter.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
itemIditemid
itemRevisionitemrevision
revSensitivityrevsensitivity
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::AssignItemRevision ( const char *  itemId,
NXString itemRevision,
bool *  revSensitivity 
)

Used to assign Item revision in Teamcenter.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
itemIditemid
itemRevisionitemrevision
revSensitivityrevsensitivity
NXString NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::DatasetName ( )

Returns the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::ExportOptions NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::ExportOption ( )

Returns the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OperateOptions NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OperateOption ( )

Returns the option which indicates if the spreadsheet is to be imported or exported.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OverrideExistingExpressions ( )

Returns the value which indicates whether to override existing expressions in the work part when importing.


Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetDatasetName ( const NXString datasetName)

Sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
datasetNamedatasetname
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetDatasetName ( const char *  datasetName)

Sets the name of the Teamcenter dataset from which the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
datasetNamedatasetname
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetExportOption ( NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::ExportOptions  exportOption)

Sets the option which indicates if the expressions are to be exported a new create item or an existing item in Teamcenter.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
exportOptionexportoption
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetObjectCreateBuilder ( NXOpen::PDM::ObjectCreateBuilder objectCreateBuilder)

Sets NXOpen::PDM::ObjectCreateBuilder
Created in NX10.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
objectCreateBuilderobjectcreatebuilder
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetOperateOption ( NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::OperateOptions  operateOptions)

Sets the option which indicates if the spreadsheet is to be imported or exported.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
operateOptionsoperateoptions
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetOverrideExistingExpressions ( bool  overrideExistingExpressions)

Sets the value which indicates whether to override existing expressions in the work part when importing.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
overrideExistingExpressionsoverrideexistingexpressions
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadSheetFileName ( const NXString spreadSheetFileName)

Sets the spreadsheet name which indicates the spreadsheet to be imported or exported.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadSheetFileNamespreadsheetfilename
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadSheetFileName ( const char *  spreadSheetFileName)

Sets the spreadsheet name which indicates the spreadsheet to be imported or exported.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadSheetFileNamespreadsheetfilename
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemID ( const NXString spreadsheetItemID)

Sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemIDspreadsheetitemid
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemID ( const char *  spreadsheetItemID)

Sets the item ID number which indicates the item that the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemIDspreadsheetitemid
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemName ( const NXString spreadsheetItemName)

Sets the item name of the spreadsheet in Teamcenter.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemNamespreadsheetitemname
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemName ( const char *  spreadsheetItemName)

Sets the item name of the spreadsheet in Teamcenter.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemNamespreadsheetitemname
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemRevision ( const NXString spreadsheetItemRevision)

Sets the item revision of the spreadsheet that is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemRevisionspreadsheetitemrevision
void NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SetSpreadsheetItemRevision ( const char *  spreadsheetItemRevision)

Sets the item revision of the spreadsheet that is to be imported from or exported to.


Created in NX8.5.0.

License requirements : gateway ("UG GATEWAY")

Parameters
spreadsheetItemRevisionspreadsheetitemrevision
NXString NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SpreadSheetFileName ( )

Returns the spreadsheet name which indicates the spreadsheet to be imported or exported.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SpreadsheetItemID ( )

Returns the item ID number which indicates the item that the spreadsheet is to be imported from or exported to.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SpreadsheetItemName ( )

Returns the item name of the spreadsheet in Teamcenter.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::BaseDataImportExportBuilder::SpreadsheetItemRevision ( )

Returns the item revision of the spreadsheet that is to be imported from or exported to.


Created in NX8.5.0.

License requirements : None


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