BaseTemplateManager Class

class NXOpen.CAE.Xyplot.BaseTemplateManager

Bases: NXOpen.NXObject

Manages the graph template

Not support KF.

New in version NX7.5.0.

Properties

Property	Description
ActiveTemplate	Returns or sets the active template file
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteTemplate	Deletes template file
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetDefaultTemplate	Returns the default template file
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
LoadTemplate	Loads the graph template file
Print	Prints a representation of this object to the system log file.
ReloadAllTemplateFiles	Reload all graph template files so that the modification on the loaded graph template files are reset.
RenameTemplateFile	Renames template file
ResetSystemTemplate	Resets system template
ResetTemplate	Resets to default value
SaveAllTemplates	Saves all templates
SaveAsTemplate	Saves to new template file
SaveTemplate	Saves to template file
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetDefaultTemplate	Sets the default template file.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
UnloadAllTemplates	Unloads all graph template files
UnloadTemplate	Unloads the graph template file

Property Detail

ActiveTemplate

BaseTemplateManager.ActiveTemplate

Returns or sets the active template file

-------------------------------------

Getter Method

Signature ActiveTemplate

Returns:Template file name with full path Return type:str

New in version NX7.5.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.BaseTemplateManager.GetDefaultTemplate()

License requirements: None.

-------------------------------------

Setter Method

Signature ActiveTemplate

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.BaseTemplateManager.SetDefaultTemplate()

License requirements: None.

IsOccurrence

BaseTemplateManager.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

BaseTemplateManager.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

BaseTemplateManager.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

BaseTemplateManager.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

BaseTemplateManager.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

BaseTemplateManager.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

DeleteTemplate

BaseTemplateManager.DeleteTemplate

Deletes template file

Signature DeleteTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

License requirements: None.

FindObject

BaseTemplateManager.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetDefaultTemplate

BaseTemplateManager.GetDefaultTemplate

Returns the default template file

Signature GetDefaultTemplate()

Returns:Template file name with full path Return type:str

New in version NX12.0.0.

License requirements: None.

LoadTemplate

BaseTemplateManager.LoadTemplate

Loads the graph template file

Signature LoadTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

License requirements: None.

Print

BaseTemplateManager.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

ReloadAllTemplateFiles

BaseTemplateManager.ReloadAllTemplateFiles

Reload all graph template files so that the modification on the loaded graph template files are reset.

The unloaded files under customer directories which is defined by environement variable UGII_BASE_DIR, UGII_VENDOR_DIR, UGII_SITE_DIR and UGII_USER_DIR will be reloaded. Also the graph templates in active root part directory will be reloaded if they are unloaded.

Signature ReloadAllTemplateFiles()

New in version NX12.0.0.

License requirements: None.

RenameTemplateFile

BaseTemplateManager.RenameTemplateFile

Renames template file

Signature RenameTemplateFile(oldTemplateFile, newTemplateFileName)

Parameters:

• oldTemplateFile (str) – old template file with full path
• newTemplateFileName (str) – new template file with simple name.

New in version NX12.0.0.

License requirements: None.

ResetSystemTemplate

BaseTemplateManager.ResetSystemTemplate

Resets system template

Signature ResetSystemTemplate()

New in version NX12.0.0.

License requirements: None.

ResetTemplate

BaseTemplateManager.ResetTemplate

Resets to default value

Signature ResetTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

License requirements: None.

SaveAllTemplates

BaseTemplateManager.SaveAllTemplates

Saves all templates

Signature SaveAllTemplates()

New in version NX12.0.0.

License requirements: None.

SaveAsTemplate

BaseTemplateManager.SaveAsTemplate

Saves to new template file

Signature SaveAsTemplate(sourceTemplateFile, destinationTemplateFile)

Parameters:

• sourceTemplateFile (str) – Source template file name with full path
• destinationTemplateFile (str) – Destination template file name with full path

New in version NX7.5.0.

License requirements: None.

SaveTemplate

BaseTemplateManager.SaveTemplate

Saves to template file

Signature SaveTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

License requirements: None.

SetDefaultTemplate

BaseTemplateManager.SetDefaultTemplate

Sets the default template file.

If the input template file is NULL, it will remove default template state.

If the input template file is not NULL, it will set the input template as default template.

Signature SetDefaultTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX12.0.0.

License requirements: None.

SetName

BaseTemplateManager.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

UnloadAllTemplates

BaseTemplateManager.UnloadAllTemplates

Unloads all graph template files

Signature UnloadAllTemplates()

New in version NX7.5.0.

License requirements: None.

UnloadTemplate

BaseTemplateManager.UnloadTemplate

Unloads the graph template file

Signature UnloadTemplate(templateFile)

Parameters:templateFile (str) – Template file name with full path

New in version NX7.5.0.

License requirements: None.