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

Represents a VirtuallabImporter to be used when importing the Virtuallab Data This class is created using DexManager . More...

Inheritance diagram for NXOpen::VirtuallabImporter:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString OutputDirectory ()
 Returns the output directory - where the sim file will be created
Created in NX12.0.0. More...
 
void SaveSettings (const NXString &filename)
 Save the settings - this will save the settings to a file specified
Created in NX12.0.0. More...
 
void SaveSettings (const char *filename)
 Save the settings - this will save the settings to a file specified
Created in NX12.0.0. More...
 
void SetOutputDirectory (const NXString &outputDirectory)
 Sets the output directory - where the sim file will be created
Created in NX12.0.0. More...
 
void SetOutputDirectory (const char *outputDirectory)
 Sets the output directory - where the sim file will be created
Created in NX12.0.0. More...
 
void SetSettingsFile (const NXString &filename)
 Sets the settings file - definition file for default options
Created in NX12.0.0. More...
 
void SetSettingsFile (const char *filename)
 Sets the settings file - definition file for default options
Created in NX12.0.0. More...
 
NXString SettingsFile ()
 Returns the settings file - definition file for default options
Created in NX12.0.0. More...
 
void SetUseFileDirectory (bool useFileDirectory)
 Sets the use file directory - if set to true then sim files will be created in the same directory as the input file
Created in NX12.0.0. More...
 
bool UseFileDirectory ()
 Returns the use file directory - if set to true then sim files will be created in the same directory as the input file
Created in NX12.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 VirtuallabImporter to be used when importing the Virtuallab Data This class is created using DexManager .

NULL object will be returned from Commit()
To create a new instance of this class, use NXOpen::DexManager::CreateVirtuallabImporter
Default values.

Property Value

UseFileDirectory

1


Created in NX12.0.0.

Member Function Documentation

NXString NXOpen::VirtuallabImporter::OutputDirectory ( )

Returns the output directory - where the sim file will be created
Created in NX12.0.0.



License requirements : None

void NXOpen::VirtuallabImporter::SaveSettings ( const NXString filename)

Save the settings - this will save the settings to a file specified
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::VirtuallabImporter::SaveSettings ( const char *  filename)

Save the settings - this will save the settings to a file specified
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::VirtuallabImporter::SetOutputDirectory ( const NXString outputDirectory)

Sets the output directory - where the sim file will be created
Created in NX12.0.0.



License requirements : None

Parameters
outputDirectoryoutputdirectory
void NXOpen::VirtuallabImporter::SetOutputDirectory ( const char *  outputDirectory)

Sets the output directory - where the sim file will be created
Created in NX12.0.0.



License requirements : None

Parameters
outputDirectoryoutputdirectory
void NXOpen::VirtuallabImporter::SetSettingsFile ( const NXString filename)

Sets the settings file - definition file for default options
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::VirtuallabImporter::SetSettingsFile ( const char *  filename)

Sets the settings file - definition file for default options
Created in NX12.0.0.



License requirements : None

Parameters
filenamefilename
NXString NXOpen::VirtuallabImporter::SettingsFile ( )

Returns the settings file - definition file for default options
Created in NX12.0.0.



License requirements : None

void NXOpen::VirtuallabImporter::SetUseFileDirectory ( bool  useFileDirectory)

Sets the use file directory - if set to true then sim files will be created in the same directory as the input file
Created in NX12.0.0.



License requirements : None

Parameters
useFileDirectoryusefiledirectory
bool NXOpen::VirtuallabImporter::UseFileDirectory ( )

Returns the use file directory - if set to true then sim files will be created in the same directory as the input file
Created in NX12.0.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.