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

This class is responsible for setting and getting NX Manager database attribute. More...

Inheritance diagram for NXOpen::PDM::DatabaseAttributeManager:
NXOpen::TransientObject

Public Member Functions

NXString GetAttribute (const NXString &attributeTitle)
 Gets the value of a writable database attribute. More...
 
NXString GetAttribute (const char *attributeTitle)
 Gets the value of a writable database attribute. More...
 
void LoadAttributes (bool reload)
 Load the Database Attributes from Teamcenter. More...
 
void LoadAttributesRecursively (bool reload)
 Recursively load the Database Attributes of this part and all its partially or fully loaded components from Teamcenter. More...
 
void RefreshAttributes ()
 Force load the Database Attributes from Teamcenter. More...
 
void SetAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of a writable database attribute. More...
 
void SetAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of a writable database attribute. More...
 
void StoreAttributes ()
 Register DB_PART_NAME and DB_PART_DESC attributes with values set in the attribute_manager
Created in NX4.0.0. More...
 
virtual ~DatabaseAttributeManager ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class is responsible for setting and getting NX Manager database attribute.


Use PDM::PartBuilder::NewDatabaseAttributeManager or PDM::PdmPart::NewDatabaseAttributeManager to get the instance of this class.

Created in NX4.0.0.

Constructor & Destructor Documentation

virtual NXOpen::PDM::DatabaseAttributeManager::~DatabaseAttributeManager ( )
virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX4.0.0.

License requirements : None

Member Function Documentation

NXString NXOpen::PDM::DatabaseAttributeManager::GetAttribute ( const NXString attributeTitle)

Gets the value of a writable database attribute.

Returns
the value of the attribute
Created in NX4.0.0.

License requirements : None
Parameters
attributeTitlethe title of the attribute
NXString NXOpen::PDM::DatabaseAttributeManager::GetAttribute ( const char *  attributeTitle)

Gets the value of a writable database attribute.

Returns
the value of the attribute
Created in NX4.0.0.

License requirements : None
Parameters
attributeTitlethe title of the attribute
void NXOpen::PDM::DatabaseAttributeManager::LoadAttributes ( bool  reload)

Load the Database Attributes from Teamcenter.

This operation will not discard any changes made in this session that aren't committed to Teamcenter. If 'reload' is set to 'true', attributes that have already been loaded will be loaded again, if otherwise allowed.


Created in NX8.0.0.

License requirements : None

Parameters
reloadReload attributes that have already been loaded, if otherwise allowed.
void NXOpen::PDM::DatabaseAttributeManager::LoadAttributesRecursively ( bool  reload)

Recursively load the Database Attributes of this part and all its partially or fully loaded components from Teamcenter.

This operation will not discard any changes made in this session that aren't committed to Teamcenter.


Created in NX8.0.0.

License requirements : None

Parameters
reloadReload attributes that have already been loaded, if otherwise allowed.
void NXOpen::PDM::DatabaseAttributeManager::RefreshAttributes ( )

Force load the Database Attributes from Teamcenter.

This removes changes to values made in NX.
Created in NX6.0.0.

License requirements : None

void NXOpen::PDM::DatabaseAttributeManager::SetAttribute ( const NXString attributeTitle,
const NXString attributeValue 
)

Sets the value of a writable database attribute.


Created in NX4.0.0.

License requirements : None

Parameters
attributeTitlethe title of the attribute to be set
attributeValuethe new value the attribute is to be set to
void NXOpen::PDM::DatabaseAttributeManager::SetAttribute ( const char *  attributeTitle,
const char *  attributeValue 
)

Sets the value of a writable database attribute.


Created in NX4.0.0.

License requirements : None

Parameters
attributeTitlethe title of the attribute to be set
attributeValuethe new value the attribute is to be set to
void NXOpen::PDM::DatabaseAttributeManager::StoreAttributes ( )

Register DB_PART_NAME and DB_PART_DESC attributes with values set in the attribute_manager
Created in NX4.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.