NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::PDM::AlternateIdManager Class Reference

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

Inheritance diagram for NXOpen::PDM::AlternateIdManager:
NXOpen::TransientObject

List of all members.

Classes

struct  AlternateIdsData
 Contains alternate Ids data. More...
struct  AssignAlternateRevData
 Contains alternate Revision Id data. More...

Public Member Functions

void AssignAlternateId (NXString *alternateItemId, NXString *alternateRevId)
 This method generates alternate item and revision IDs and sets these generated values on this manager class.
NXOpen::PDM::AlternateIdManager::AlternateIdsData AssignAlternateIds (const NXString &context, const NXString &idType)
 Generates the alternate ID information by calling AssignAlternateIds .
NXString AssignAlternateRevId ()
 This method generates an alternate rev ID and sets this generated value on this manager class.
NXOpen::PDM::AlternateIdManager::AssignAlternateRevData AssignAlternateRevision ()
 Generates the alternate Revision ID information.
void CreateAlternateIdInformation ()
 Adds the alternate ID information set by calling SetAlternateIdInformation and the various "assign" and "set" methods.
std::vector< NXStringGetAllContexts ()
 Gets a list of all the available contexts.
std::vector< NXStringGetAllIdTypes (const NXString &context)
 Gets a list of all the available ID types for a given context.
NXString GetAlternateDescription ()
 Gets the value of a alternate name as it is currently set on this manager class.
bool GetAlternateIdAsDefaultIndentifier ()
 Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.
NXString GetAlternateItemId ()
 Gets the value of a alternate ID as it is currently set on this manager class.
NXString GetAlternateName ()
 Gets the value of a alternate name as it is currently set on this manager class.
NXString GetAlternateRevId ()
 Gets the value of a alternate rev ID as it is currently set on this manager class.
NXString GetContext ()
 Gets the value of a context as it is currently set on this manager class.
NXString GetIdType ()
 Gets the value of a ID type as it is currently set on this manager class.
void SetAlternateDescription (const NXString &alternateDescription)
 Sets the value of the alternate description.
void SetAlternateIdAsDefaultIndentifier (bool alternateIdAsDefaultIndentifier)
 Sets whether the alternate ID information should be the default indentifier.
void SetAlternateIdInformation (const NXString &context, const NXString &idType, const NXString &alternateItemId, const NXString &alternateRevId, const NXString &alternateName, const NXString &alternateDescription, bool alternateIdAsDefaultIndentifier)
 Sets alternate ID information on this manager class.
void SetAlternateItemId (const NXString &alternateItemId)
 Sets the value of the alternate item ID.
void SetAlternateName (const NXString &alternateName)
 Sets the value of the alternate name.
void SetAlternateRevId (const NXString &alternateRevId)
 Sets the value of the alternate rev ID.
void SetContext (const NXString &context)
 Sets the value of a context.
void SetIdType (const NXString &idType)
 Sets the value of an ID type.
virtual ~AlternateIdManager ()
 Free resources associated with the instance.

Detailed Description

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


Use PDM::PartBuilder::NewAlternateIdManager to get the instance of this class.

Created in NX4.0.0.


Constructor & Destructor Documentation

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

void NXOpen::PDM::AlternateIdManager::AssignAlternateId ( NXString alternateItemId,
NXString alternateRevId 
)

This method generates alternate item and revision IDs and sets these generated values on this manager class.

Note that the ID context and type must be set on the builder in order for this assign operation to be successful.
Created in NX4.0.0.

License requirements : None

Parameters:
alternateItemIdthe newly generated alternate item ID value that was set on this manager
alternateRevIdthe newly generated alternate revision ID value that was set on this manager

Generates the alternate ID information by calling AssignAlternateIds .

Returns pointer to PDM.Altids.AlternateIdsData object. Sets Alternate Name,Alternate Id,Alternate Revision ,Alternate Description, flag for alternate Id modifiable and flag for revision modifiable into Alternate Manager object.

Returns:
Contains alternate Ids data
Created in NX5.0.0.

License requirements : None
Parameters:
contextthe context
NOTE: The full Unicode character set is not supported for this parameter.
idTypethe Id type
NOTE: The full Unicode character set is not supported for this parameter.

This method generates an alternate rev ID and sets this generated value on this manager class.

Note that the ID context and type must be set on the builder in order for this assign operation to be successful.

Returns:
the newly generated alternate rev ID value that was set on this manager
Created in NX4.0.0.

License requirements : None

Generates the alternate Revision ID information.

Sets Alternate Revision and flag for revision modifiable into Alternate Manager object.

Returns:
Contains alternate Revision Id data
Created in NX5.0.0.

License requirements : None

Adds the alternate ID information set by calling SetAlternateIdInformation and the various "assign" and "set" methods.

The context, ID type, alternate ID, alternate revision ID, and the alternate name must all be set before calling this method.
Created in NX4.0.0.

License requirements : None

Gets a list of all the available contexts.

Returns:
list of contexts
Created in NX4.0.0.

License requirements : None

Gets a list of all the available ID types for a given context.

Returns:
list of ID types
Created in NX4.0.0.

License requirements : None
Parameters:
contextthe context
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of a alternate name as it is currently set on this manager class.

Returns:
the current value of the alternate description on this manager
Created in NX4.0.0.

License requirements : None

Gets (as it is currently set on this manager class) whether the alternate ID information should be the default indentifier.

Returns:
the current value of option on this manager
Created in NX4.0.0.

License requirements : None

Gets the value of a alternate ID as it is currently set on this manager class.

Returns:
the current value of the alternate item ID on this manager
Created in NX4.0.0.

License requirements : None

Gets the value of a alternate name as it is currently set on this manager class.

Returns:
the current value of the alternate name on this manager
Created in NX4.0.0.

License requirements : None

Gets the value of a alternate rev ID as it is currently set on this manager class.

Returns:
the current value of the alternate rev ID on this manager
Created in NX4.0.0.

License requirements : None

Gets the value of a context as it is currently set on this manager class.

Returns:
the current value of the context on this manager
Created in NX4.0.0.

License requirements : None

Gets the value of a ID type as it is currently set on this manager class.

Returns:
the current value of the ID type on this manager
Created in NX4.0.0.

License requirements : None

Sets the value of the alternate description.


Created in NX4.0.0.

License requirements : None

Parameters:
alternateDescriptionthe new value the alternate description is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PDM::AlternateIdManager::SetAlternateIdAsDefaultIndentifier ( bool  alternateIdAsDefaultIndentifier)

Sets whether the alternate ID information should be the default indentifier.


Created in NX4.0.0.

License requirements : None

Parameters:
alternateIdAsDefaultIndentifierthe new value the option is to be set to
void NXOpen::PDM::AlternateIdManager::SetAlternateIdInformation ( const NXString context,
const NXString idType,
const NXString alternateItemId,
const NXString alternateRevId,
const NXString alternateName,
const NXString alternateDescription,
bool  alternateIdAsDefaultIndentifier 
)

Sets alternate ID information on this manager class.

NULL can be specified for parameters which are set via other set or assign methods on this builder.
Created in NX4.0.0.

License requirements : None

Parameters:
contextthe new value the context is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
idTypethe new value the ID type is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
alternateItemIdthe new value the alternate item ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
alternateRevIdthe new value the alternate rev ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
alternateNamethe new value the alternate name is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
alternateDescriptionthe new value the alternate description is to be set to
NOTE: The full Unicode character set is not supported for this parameter.
alternateIdAsDefaultIndentifierthe new value the option is to be set to

Sets the value of the alternate item ID.


Created in NX4.0.0.

License requirements : None

Parameters:
alternateItemIdthe new value the alternate item ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Sets the value of the alternate name.


Created in NX4.0.0.

License requirements : None

Parameters:
alternateNamethe new value the alternate name is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Sets the value of the alternate rev ID.


Created in NX4.0.0.

License requirements : None

Parameters:
alternateRevIdthe new value the alternate rev ID is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Sets the value of a context.


Created in NX4.0.0.

License requirements : None

Parameters:
contextthe new value the context is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

Sets the value of an ID type.


Created in NX4.0.0.

License requirements : None

Parameters:
idTypethe new value the ID type is to be set to
NOTE: The full Unicode character set is not supported for this parameter.

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