NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::ReadDataSetBuilder Class Reference

This class will read a data set file from Team Center
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::Features::ShipDesign::ReadDataSetBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool CreateDataSetToggle ()
 Returns the property that if the toggle is on then the native file will be added to current work part as a data set
Created in NX8.5.0. More...
 
int DataSets ()
 Returns the index value of the available data set names
Created in NX8.5.0. More...
 
void GetDataSetNames (std::vector< NXString > &dataSetNames)
 The list of available data set names under the current work part
Created in NX8.5.0. More...
 
NXString NativeFileBrowser ()
 Returns the file name of the data set from the native file system
Created in NX8.5.0. More...
 
bool NativeToggle ()
 Returns the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system
Created in NX8.5.0. More...
 
void SetCreateDataSetToggle (bool createDataSetToggle)
 Sets the property that if the toggle is on then the native file will be added to current work part as a data set
Created in NX8.5.0. More...
 
void SetDataSets (int dataSets)
 Sets the index value of the available data set names
Created in NX8.5.0. More...
 
void SetNativeFileBrowser (const NXString &filename)
 Sets the file name of the data set from the native file system
Created in NX8.5.0. More...
 
void SetNativeFileBrowser (const char *filename)
 Sets the file name of the data set from the native file system
Created in NX8.5.0. More...
 
void SetNativeToggle (bool nativeToggle)
 Sets the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system
Created in NX8.5.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

This class will read a data set file from Team Center
Created in NX8.5.0.


Member Function Documentation

bool NXOpen::Features::ShipDesign::ReadDataSetBuilder::CreateDataSetToggle ( )

Returns the property that if the toggle is on then the native file will be added to current work part as a data set
Created in NX8.5.0.



License requirements : None

int NXOpen::Features::ShipDesign::ReadDataSetBuilder::DataSets ( )

Returns the index value of the available data set names
Created in NX8.5.0.



License requirements : None

void NXOpen::Features::ShipDesign::ReadDataSetBuilder::GetDataSetNames ( std::vector< NXString > &  dataSetNames)

The list of available data set names under the current work part
Created in NX8.5.0.



License requirements : None

Parameters
dataSetNamesAvailable data set names derived from the input Team Center relations.
NXString NXOpen::Features::ShipDesign::ReadDataSetBuilder::NativeFileBrowser ( )

Returns the file name of the data set from the native file system
Created in NX8.5.0.



License requirements : None

bool NXOpen::Features::ShipDesign::ReadDataSetBuilder::NativeToggle ( )

Returns the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system
Created in NX8.5.0.



License requirements : None

void NXOpen::Features::ShipDesign::ReadDataSetBuilder::SetCreateDataSetToggle ( bool  createDataSetToggle)

Sets the property that if the toggle is on then the native file will be added to current work part as a data set
Created in NX8.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
createDataSetTogglecreatedatasettoggle
void NXOpen::Features::ShipDesign::ReadDataSetBuilder::SetDataSets ( int  dataSets)

Sets the index value of the available data set names
Created in NX8.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
dataSetsdatasets
void NXOpen::Features::ShipDesign::ReadDataSetBuilder::SetNativeFileBrowser ( const NXString filename)

Sets the file name of the data set from the native file system
Created in NX8.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
filenamefilename
void NXOpen::Features::ShipDesign::ReadDataSetBuilder::SetNativeFileBrowser ( const char *  filename)

Sets the file name of the data set from the native file system
Created in NX8.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
filenamefilename
void NXOpen::Features::ShipDesign::ReadDataSetBuilder::SetNativeToggle ( bool  nativeToggle)

Sets the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system
Created in NX8.5.0.



License requirements : nx_ship_concept ("Ship Concept")

Parameters
nativeTogglenativetoggle
virtual bool NXOpen::Features::ShipDesign::ReadDataSetBuilder::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.