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

Represents a class that performs various operations on NonMaster Datasets
Created in NX11.0.0. More...

Inheritance diagram for NXOpen::PDM::NonMasterData:
NXOpen::TransientObject

Public Types

enum  CopyNonMasterPartsOption { CopyNonMasterPartsOptionAll, CopyNonMasterPartsOptionNone }
 This enum is used to specify which non-master parts should be copied to new part during the save as operation. More...
 

Public Member Functions

void CreateNonMasterListForLogicalObject (NXOpen::PDM::LogicalObject *logicalObject)
 Create NonMaster list for the selected logical Object
Created in NX11.0.0. More...
 
bool EditNonMasterToCopyName (NXOpen::PDM::LogicalObject *logicalObject, const NXString &oldName, const NXString &newName)
 Sets the name the non-master part will get saved as. More...
 
bool EditNonMasterToCopyName (NXOpen::PDM::LogicalObject *logicalObject, const char *oldName, const char *newName)
 Sets the name the non-master part will get saved as. More...
 
NXOpen::PDM::NonMasterData::CopyNonMasterPartsOption GetCopyNonMasterPartsOption (NXOpen::PDM::LogicalObject *logicalObject)
 Get the nonmasters saveAs option for given logical object. More...
 
std::vector< NXStringGetNonMasterListForCopyLogicalObject (NXOpen::PDM::LogicalObject *logicalObject)
 Gets NonMaster list for the given logical Object. More...
 
bool IsNonMasterForLogicalObjectBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const NXString &partName)
 Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More...
 
bool IsNonMasterForLogicalObjectBeingCopied (NXOpen::PDM::LogicalObject *logicalObject, const char *partName)
 Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation. More...
 
void SetNonMasterSaveAsOption (NXOpen::PDM::LogicalObject *logicalObject, NXOpen::PDM::NonMasterData::CopyNonMasterPartsOption saveOption)
 Set the nonmasters saveAs option for given logical object. More...
 
void SetSelectedNonMasterToCopy (NXOpen::PDM::LogicalObject *logicalObject, const NXString &partName)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
void SetSelectedNonMasterToCopy (NXOpen::PDM::LogicalObject *logicalObject, const char *partName)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
virtual ~NonMasterData ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents a class that performs various operations on NonMaster Datasets
Created in NX11.0.0.


Member Enumeration Documentation

This enum is used to specify which non-master parts should be copied to new part during the save as operation.


Created in NX11.0.0.

Enumerator
CopyNonMasterPartsOptionAll 

save all during save as

CopyNonMasterPartsOptionNone 

save none during save as

Constructor & Destructor Documentation

virtual NXOpen::PDM::NonMasterData::~NonMasterData ( )
virtual

Frees the object from memory.

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 NX11.0.0.

License requirements : None

Member Function Documentation

void NXOpen::PDM::NonMasterData::CreateNonMasterListForLogicalObject ( NXOpen::PDM::LogicalObject logicalObject)

Create NonMaster list for the selected logical Object
Created in NX11.0.0.



License requirements : None

Parameters
logicalObjectlogicalobject
bool NXOpen::PDM::NonMasterData::EditNonMasterToCopyName ( NXOpen::PDM::LogicalObject logicalObject,
const NXString oldName,
const NXString newName 
)

Sets the name the non-master part will get saved as.

It will get saved as the original non-master name if this method is not called.

Returns
flag to indicate whether the newName is valid
Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
oldNamethe non-master part whose save as name is being set here
newNamethe new name
bool NXOpen::PDM::NonMasterData::EditNonMasterToCopyName ( NXOpen::PDM::LogicalObject logicalObject,
const char *  oldName,
const char *  newName 
)

Sets the name the non-master part will get saved as.

It will get saved as the original non-master name if this method is not called.

Returns
flag to indicate whether the newName is valid
Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
oldNamethe non-master part whose save as name is being set here
newNamethe new name
NXOpen::PDM::NonMasterData::CopyNonMasterPartsOption NXOpen::PDM::NonMasterData::GetCopyNonMasterPartsOption ( NXOpen::PDM::LogicalObject logicalObject)

Get the nonmasters saveAs option for given logical object.

Save As option can be one of these NonMasterData::CopyNonMasterPartsOptionAll and NonMasterData::CopyNonMasterPartsOptionNone

Returns

Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
std::vector<NXString> NXOpen::PDM::NonMasterData::GetNonMasterListForCopyLogicalObject ( NXOpen::PDM::LogicalObject logicalObject)

Gets NonMaster list for the given logical Object.

Returns
Non-master part file names
Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
bool NXOpen::PDM::NonMasterData::IsNonMasterForLogicalObjectBeingCopied ( NXOpen::PDM::LogicalObject logicalObject,
const NXString partName 
)

Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation.

Returns
True means that this non-master will be saved. False means that this non-master will not be saved.
Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
partNamethe non-master part that the caller wants to save or not save
bool NXOpen::PDM::NonMasterData::IsNonMasterForLogicalObjectBeingCopied ( NXOpen::PDM::LogicalObject logicalObject,
const char *  partName 
)

Returns whether or not the non-master part specified for the given NXOpen::PDM::LogicalObject will actually get saved during the save as operation.

Returns
True means that this non-master will be saved. False means that this non-master will not be saved.
Created in NX11.0.0.

License requirements : None
Parameters
logicalObjectlogicalobject
partNamethe non-master part that the caller wants to save or not save
void NXOpen::PDM::NonMasterData::SetNonMasterSaveAsOption ( NXOpen::PDM::LogicalObject logicalObject,
NXOpen::PDM::NonMasterData::CopyNonMasterPartsOption  saveOption 
)

Set the nonmasters saveAs option for given logical object.

Save As option can be one of these NonMasterData::CopyNonMasterPartsOptionAll and NonMasterData::CopyNonMasterPartsOptionNone
Created in NX11.0.0.

License requirements : None

Parameters
logicalObjectlogicalobject
saveOptionsaveoption
void NXOpen::PDM::NonMasterData::SetSelectedNonMasterToCopy ( NXOpen::PDM::LogicalObject logicalObject,
const NXString partName 
)

Sets whether or not the non-master part specified will actually get saved during the save as operation.

True means that it will be saved. False means that it will not be saved.
Created in NX11.0.0.

License requirements : None

Parameters
logicalObjectlogicalobject
partNamethe non-master part whose save option is being set here
void NXOpen::PDM::NonMasterData::SetSelectedNonMasterToCopy ( NXOpen::PDM::LogicalObject logicalObject,
const char *  partName 
)

Sets whether or not the non-master part specified will actually get saved during the save as operation.

True means that it will be saved. False means that it will not be saved.
Created in NX11.0.0.

License requirements : None

Parameters
logicalObjectlogicalobject
partNamethe non-master part whose save option is being set here

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