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

Contains the collection objects for creating and iterating over issue objects. More...

Public Types

enum  Mode { ModeTeamcenterCommunity, ModeTeamcenter, ModeBriefcase }
 Represents the possible issue site modes. More...
 
enum  State { StateOriginal, StateCreated, StateModified, StateRemoved }
 Represents the possible issue object states. More...
 

Public Member Functions

NXOpen::Issue::IssueAttachmentCaptureAndCreateAttachmentForSnapshot ()
 Creates a NXOpen::Issue::IssueAttachment for Snapshot. More...
 
NXOpen::Issue::IssueSiteConnect (const NXString &siteUrl, const NXString &userName, const NXString &password)
 Connects to issue server and returns the NXOpen::Issue::IssueSite. More...
 
NXOpen::Issue::IssueSiteConnect (const char *siteUrl, const char *userName, const char *password)
 Connects to issue server and returns the NXOpen::Issue::IssueSite. More...
 
NXOpen::Issue::IssueAttachmentCreateAttachmentForBookMark ()
 Creates a NXOpen::Issue::IssueAttachment for BookMark. More...
 
NXOpen::Issue::IssueAttachmentCreateAttachmentForScreenImage ()
 Creates a NXOpen::Issue::IssueAttachment for ScreenImage. More...
 
NXOpen::Issue::IssueAttachmentCreateAttachmentForSnapshot (const NXString &bookmarkFileSpec, const NXString &imageFileSpec, const NXString &name)
 Creates a NXOpen::Issue::IssueAttachment for Sanpshot. More...
 
NXOpen::Issue::IssueAttachmentCreateAttachmentForSnapshot (const char *bookmarkFileSpec, const char *imageFileSpec, const char *name)
 Creates a NXOpen::Issue::IssueAttachment for Sanpshot. More...
 
NXOpen::Issue::IssueBriefcaseCreateBriefcase (const NXString &briefcaseName, const NXString &filePath)
 Creates an NXOpen::Issue::IssueBriefcase . More...
 
NXOpen::Issue::IssueBriefcaseCreateBriefcase (const char *briefcaseName, const char *filePath)
 Creates an NXOpen::Issue::IssueBriefcase . More...
 
NXOpen::Issue::IssueAttachmentCreateIssueAttachment (const NXString &fileSpec, const NXString &name, NXOpen::Issue::IssueAttachment::Type type)
 Creates a NXOpen::Issue::IssueAttachment. More...
 
NXOpen::Issue::IssueAttachmentCreateIssueAttachment (const char *fileSpec, const char *name, NXOpen::Issue::IssueAttachment::Type type)
 Creates a NXOpen::Issue::IssueAttachment. More...
 
NXOpen::Issue::IssueContentCreateIssueContent (NXOpen::Issue::IssueList *list)
 Creates a NXOpen::Issue::IssueContent. More...
 
NXOpen::Issue::IssueContentBuilderCreateIssueContentBuilder (NXOpen::Issue::IssueContent *issue)
 Creates a NXOpen::Issue::IssueContentBuilder. More...
 
NXOpen::Issue::SnapshotSubsetBuilderCreateIssueSnapshotSubsetBuilder (NXOpen::Part *subsetPart)
 Creates a NXOpen::Issue::SnapshotSubsetBuilder. More...
 
NXOpen::Issue::SnapshotWorksetBuilderCreateIssueSnapshotWorksetBuilder (NXOpen::Issue::IssueContent *issue)
 Creates a NXOpen::Issue::SnapshotWorksetBuilder. More...
 
NXOpen::Issue::IssueManager::Mode CurrentMode ()
 Returns the current mode
Created in NX8.5.0. More...
 
NXOpen::Issue::IssueSiteCurrentSite ()
 Returns the current NXOpen::Issue::IssueSite
Created in NX8.5.0. More...
 
void Disconnect ()
 Disconnects from issue server
Created in NX8.5.0. More...
 
NXOpen::Issue::IssueManager::State GetAttachmentState (NXOpen::Issue::IssueAttachment *attachment)
 Gets the modified state of NXOpen::Issue::IssueAttachment. More...
 
NXOpen::Issue::IssueManager::State GetIssueState (NXOpen::Issue::IssueContent *issue)
 Gets the modified state of NXOpen::Issue::IssueContent. More...
 
NXOpen::Issue::IssueManager::State GetPropertyState (NXOpen::Issue::IssueProperty *property)
 Gets the modified state of NXOpen::Issue::IssueProperty. More...
 
NXOpen::Issue::IssueListGetWorkingList ()
 Gets the current working NXOpen::Issue::IssueList. More...
 
NXOpen::Issue::IssueListCollectionIssueListCollection ()
 Returns the NXOpen::Issue::IssueListCollection instance
Created in NX8.5.0. More...
 
NXOpen::Issue::IssueBriefcaseOpenBriefcase (const NXString &filePath)
 Opens an NXOpen::Issue::IssueBriefcase . More...
 
NXOpen::Issue::IssueBriefcaseOpenBriefcase (const char *filePath)
 Opens an NXOpen::Issue::IssueBriefcase . More...
 
void SetCurrentMode (NXOpen::Issue::IssueManager::Mode mode)
 Sets the current mode
Created in NX8.5.0. More...
 
void SetWorkingList (NXOpen::Issue::IssueList *list)
 Sets the current working NXOpen::Issue::IssueList
Created in NX8.5.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Contains the collection objects for creating and iterating over issue objects.


To obtain an instance of this class, refer to NXOpen::Session

Created in NX8.5.0.

Member Enumeration Documentation

Represents the possible issue site modes.

Enumerator
ModeTeamcenterCommunity 

Teamcenter community mode.

ModeTeamcenter 

Teamcenter mode.

ModeBriefcase 

Briefcase mode.

Represents the possible issue object states.

Enumerator
StateOriginal 

Original state.

StateCreated 

Created state.

StateModified 

Modified state.

StateRemoved 

Removed state.

Member Function Documentation

NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CaptureAndCreateAttachmentForSnapshot ( )

Creates a NXOpen::Issue::IssueAttachment for Snapshot.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
NXOpen::Issue::IssueSite* NXOpen::Issue::IssueManager::Connect ( const NXString siteUrl,
const NXString userName,
const NXString password 
)

Connects to issue server and returns the NXOpen::Issue::IssueSite.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
siteUrlsiteurl
userNameusername
passwordpassword
NXOpen::Issue::IssueSite* NXOpen::Issue::IssueManager::Connect ( const char *  siteUrl,
const char *  userName,
const char *  password 
)

Connects to issue server and returns the NXOpen::Issue::IssueSite.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
siteUrlsiteurl
userNameusername
passwordpassword
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateAttachmentForBookMark ( )

Creates a NXOpen::Issue::IssueAttachment for BookMark.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateAttachmentForScreenImage ( )

Creates a NXOpen::Issue::IssueAttachment for ScreenImage.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateAttachmentForSnapshot ( const NXString bookmarkFileSpec,
const NXString imageFileSpec,
const NXString name 
)

Creates a NXOpen::Issue::IssueAttachment for Sanpshot.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
bookmarkFileSpecThe bookmark file
imageFileSpecThe image file
nameThe name of snapshot attachment
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateAttachmentForSnapshot ( const char *  bookmarkFileSpec,
const char *  imageFileSpec,
const char *  name 
)

Creates a NXOpen::Issue::IssueAttachment for Sanpshot.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
bookmarkFileSpecThe bookmark file
imageFileSpecThe image file
nameThe name of snapshot attachment
NXOpen::Issue::IssueBriefcase* NXOpen::Issue::IssueManager::CreateBriefcase ( const NXString briefcaseName,
const NXString filePath 
)

Creates an NXOpen::Issue::IssueBriefcase .

Returns

Created in NX10.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
briefcaseNameThe briefcase name
filePathThe briefcase work root path
NXOpen::Issue::IssueBriefcase* NXOpen::Issue::IssueManager::CreateBriefcase ( const char *  briefcaseName,
const char *  filePath 
)

Creates an NXOpen::Issue::IssueBriefcase .

Returns

Created in NX10.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
briefcaseNameThe briefcase name
filePathThe briefcase work root path
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateIssueAttachment ( const NXString fileSpec,
const NXString name,
NXOpen::Issue::IssueAttachment::Type  type 
)

Creates a NXOpen::Issue::IssueAttachment.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
fileSpecfilespec
namename
typetype
NXOpen::Issue::IssueAttachment* NXOpen::Issue::IssueManager::CreateIssueAttachment ( const char *  fileSpec,
const char *  name,
NXOpen::Issue::IssueAttachment::Type  type 
)

Creates a NXOpen::Issue::IssueAttachment.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
fileSpecfilespec
namename
typetype
NXOpen::Issue::IssueContent* NXOpen::Issue::IssueManager::CreateIssueContent ( NXOpen::Issue::IssueList list)

Creates a NXOpen::Issue::IssueContent.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
listlist
NXOpen::Issue::IssueContentBuilder* NXOpen::Issue::IssueManager::CreateIssueContentBuilder ( NXOpen::Issue::IssueContent issue)

Creates a NXOpen::Issue::IssueContentBuilder.

Returns

Created in NX8.5.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
issueissue
NXOpen::Issue::SnapshotSubsetBuilder* NXOpen::Issue::IssueManager::CreateIssueSnapshotSubsetBuilder ( NXOpen::Part subsetPart)

Creates a NXOpen::Issue::SnapshotSubsetBuilder.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
subsetPartsubsetpart
NXOpen::Issue::SnapshotWorksetBuilder* NXOpen::Issue::IssueManager::CreateIssueSnapshotWorksetBuilder ( NXOpen::Issue::IssueContent issue)

Creates a NXOpen::Issue::SnapshotWorksetBuilder.

Returns

Created in NX9.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
issueissue
NXOpen::Issue::IssueManager::Mode NXOpen::Issue::IssueManager::CurrentMode ( )

Returns the current mode
Created in NX8.5.0.



License requirements : None

NXOpen::Issue::IssueSite* NXOpen::Issue::IssueManager::CurrentSite ( )

Returns the current NXOpen::Issue::IssueSite
Created in NX8.5.0.



License requirements : nx_issue_mgmt ("NX Issue Tracking")

void NXOpen::Issue::IssueManager::Disconnect ( )

Disconnects from issue server
Created in NX8.5.0.



License requirements : nx_issue_mgmt ("NX Issue Tracking")

NXOpen::Issue::IssueManager::State NXOpen::Issue::IssueManager::GetAttachmentState ( NXOpen::Issue::IssueAttachment attachment)

Gets the modified state of NXOpen::Issue::IssueAttachment.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
attachmentattachment
NXOpen::Issue::IssueManager::State NXOpen::Issue::IssueManager::GetIssueState ( NXOpen::Issue::IssueContent issue)

Gets the modified state of NXOpen::Issue::IssueContent.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
issueissue
NXOpen::Issue::IssueManager::State NXOpen::Issue::IssueManager::GetPropertyState ( NXOpen::Issue::IssueProperty property)

Gets the modified state of NXOpen::Issue::IssueProperty.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
propertyproperty
NXOpen::Issue::IssueList* NXOpen::Issue::IssueManager::GetWorkingList ( )

Gets the current working NXOpen::Issue::IssueList.

Returns

Created in NX8.5.0.

License requirements : None
NXOpen::Issue::IssueListCollection* NXOpen::Issue::IssueManager::IssueListCollection ( )

Returns the NXOpen::Issue::IssueListCollection instance
Created in NX8.5.0.


NXOpen::Issue::IssueBriefcase* NXOpen::Issue::IssueManager::OpenBriefcase ( const NXString filePath)

Opens an NXOpen::Issue::IssueBriefcase .

Returns

Created in NX10.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
filePathThe briefcase file path
NXOpen::Issue::IssueBriefcase* NXOpen::Issue::IssueManager::OpenBriefcase ( const char *  filePath)

Opens an NXOpen::Issue::IssueBriefcase .

Returns

Created in NX10.0.0.

License requirements : nx_issue_mgmt ("NX Issue Tracking")
Parameters
filePathThe briefcase file path
void NXOpen::Issue::IssueManager::SetCurrentMode ( NXOpen::Issue::IssueManager::Mode  mode)

Sets the current mode
Created in NX8.5.0.



License requirements : nx_issue_mgmt ("NX Issue Tracking")

Parameters
modemode
void NXOpen::Issue::IssueManager::SetWorkingList ( NXOpen::Issue::IssueList list)

Sets the current working NXOpen::Issue::IssueList
Created in NX8.5.0.



License requirements : nx_issue_mgmt ("NX Issue Tracking")

Parameters
listlist
tag_t NXOpen::Issue::IssueManager::Tag ( ) const

Returns the tag of this object.


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