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

This class is used for the Machine Library Dialog. More...

Inheritance diagram for NXOpen::SIM::MachineLibraryBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void EditMachineLibrary (const NXString &machineName, const NXString &attName, const NXString &value)
 Edit a specific machine of the database. More...
 
void EditMachineLibrary (const char *machineName, const char *attName, const char *value)
 Edit a specific machine of the database. More...
 
std::vector< NXStringGetAllAttributeNames ()
 Returns a array of the library attributes. More...
 
std::vector< NXStringGetAllMachineNames ()
 Returns a array of the machine names(librefs) that are in the machine database. More...
 
NXString GetValue (const NXString &machineName, const NXString &attName)
 Returns the attribute value of a specific machine. More...
 
NXString GetValue (const char *machineName, const char *attName)
 Returns the attribute value of a specific machine. More...
 
NXString InsertEntryToMachineLibrary (const NXString &selectedMachineName)
 Insert a machine entry to the machine_database.dat. More...
 
NXString InsertEntryToMachineLibrary (const char *selectedMachineName)
 Insert a machine entry to the machine_database.dat. More...
 
void RemoveEntryFromMachineLibrary (const NXString &machineName)
 Removes a machine entry from the machine_database.dat. More...
 
void RemoveEntryFromMachineLibrary (const char *machineName)
 Removes a machine entry from the machine_database.dat. 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

This class is used for the Machine Library Dialog.

Calling Builder::Commit on this builder will only return NULL.
Use the Part class to create a MachineLibraryBuilder object.

Created in NX10.0.2.

Member Function Documentation

void NXOpen::SIM::MachineLibraryBuilder::EditMachineLibrary ( const NXString machineName,
const NXString attName,
const NXString value 
)

Edit a specific machine of the database.

That will write the machine_database.dat.
Created in NX10.0.2.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
machineNamemachine name (libref)
attNamelibrary attribute name
valuethe new value that will be set
void NXOpen::SIM::MachineLibraryBuilder::EditMachineLibrary ( const char *  machineName,
const char *  attName,
const char *  value 
)

Edit a specific machine of the database.

That will write the machine_database.dat.
Created in NX10.0.2.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
machineNamemachine name (libref)
attNamelibrary attribute name
valuethe new value that will be set
std::vector<NXString> NXOpen::SIM::MachineLibraryBuilder::GetAllAttributeNames ( )

Returns a array of the library attributes.

This function allocates the memory for attributeNames. The caller is responsible to deallocate the memory.

Returns
array of all attribute names
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
std::vector<NXString> NXOpen::SIM::MachineLibraryBuilder::GetAllMachineNames ( )

Returns a array of the machine names(librefs) that are in the machine database.

This function allocates the memory for machineNames. The caller is responsible to deallocate the memory.

Returns
array of all machine names (libref)
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
NXString NXOpen::SIM::MachineLibraryBuilder::GetValue ( const NXString machineName,
const NXString attName 
)

Returns the attribute value of a specific machine.

Returns

Created in NX10.0.2.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
machineNamemachine name (libref)
attNamelibrary attribute name
NXString NXOpen::SIM::MachineLibraryBuilder::GetValue ( const char *  machineName,
const char *  attName 
)

Returns the attribute value of a specific machine.

Returns

Created in NX10.0.2.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
machineNamemachine name (libref)
attNamelibrary attribute name
NXString NXOpen::SIM::MachineLibraryBuilder::InsertEntryToMachineLibrary ( const NXString selectedMachineName)

Insert a machine entry to the machine_database.dat.

The libref is the name of the machine entry, that is copied, the libref appended by a count and the new entry is put in the list as next entry. If the libref is empty, a default entry is add to the bottom of the list.

Returns
machine name (libref), of the new machien entry
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
selectedMachineNamemachine name (libref), that will copied
NXString NXOpen::SIM::MachineLibraryBuilder::InsertEntryToMachineLibrary ( const char *  selectedMachineName)

Insert a machine entry to the machine_database.dat.

The libref is the name of the machine entry, that is copied, the libref appended by a count and the new entry is put in the list as next entry. If the libref is empty, a default entry is add to the bottom of the list.

Returns
machine name (libref), of the new machien entry
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
selectedMachineNamemachine name (libref), that will copied
void NXOpen::SIM::MachineLibraryBuilder::RemoveEntryFromMachineLibrary ( const NXString machineName)

Removes a machine entry from the machine_database.dat.

The libref is the name of the machine entry, that will reomved from the Library.
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
machineNamemachine name (libref)
void NXOpen::SIM::MachineLibraryBuilder::RemoveEntryFromMachineLibrary ( const char *  machineName)

Removes a machine entry from the machine_database.dat.

The libref is the name of the machine entry, that will reomved from the Library.
Created in NX10.0.3.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
machineNamemachine name (libref)

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