public interface Session extends BaseSession
Modifier and Type | Interface and Description |
---|---|
static class |
Session.MarkVisibility
Indicates the visibility of an undo mark
|
static class |
Session.NamedPropertiesData
This class holds the data returned from
getNamedProperties(nxopen.TaggedObject) |
static class |
Session.ProjectAssignmentObjectType
Indicates whether project assignment is for item, item revision or dataset
|
static class |
Session.ProjectAssignmentState
Indicates project assignment state
|
static class |
Session.TransientPartPolicy
Persistence policies for transient modified parts
|
static class |
Session.UndoLastNVisibleMarksData
This class holds the data returned from
undoLastNVisibleMarks(int) |
static class |
Session.UndoMarkData
This structure contains data about an undo mark
|
BaseSession.LibraryUnloadOption
Modifier and Type | Method and Description |
---|---|
Sketch |
activeSketch()
Returns the active sketch
License requirements: None. |
AfuManager |
afuManager()
|
String |
applicationName()
Returns the name of the current application.
|
void |
applicationSwitchImmediate(String applicationName)
Registers a request to immediately switch to the specified application and open the corresponding user environment.
|
AssembliesUtils |
assembliesUtils()
|
void |
assignRemoveProjects(String[] cliNames,
Session.ProjectAssignmentObjectType[] objectTypes,
String[] projectNames,
Session.ProjectAssignmentState[] assignmentStates)
Assign or remove projects to/from objects
License requirements: None. |
void |
assignRemoveProjectsBasedOnPartOccs(TaggedObject[] partOccs,
Session.ProjectAssignmentObjectType[] objectTypes,
String[] projectNames,
Session.ProjectAssignmentState[] assignmentStates)
Assign or remove projects to/from CPD objects
License requirements: None. |
AttributeManager |
attributeManager()
|
void |
beginTaskEnvironment()
This method is called by the NX user interface before
entering a task environment.
|
BookmarkFile |
bookmarkFile()
|
CaeSession |
caeSession()
|
CAMSession |
camsession()
Returns the CAM session .
|
void |
cleanUpFacetedFacesAndEdges()
|
CollaborativeContentManager |
collaborativeContentManager()
|
ConfigurationManager |
configurationManager()
|
void |
createCamSession()
Create the CAM session
License requirements: None. |
void |
createInspectionSession()
Create the Inspection session
License requirements: None. |
TableEditorDefaultDataProvider |
createTableEditorDefaultDataProvider(BasePart part)
Creates a data provider for a table editor.
|
CustomFeatureClassManager |
customFeatureClassManager()
|
DataManager |
dataManager()
|
void |
deleteAllUndoMarks()
Deletes all undo marks
License requirements: None. |
boolean |
deleteTransientDynamicSectionCutData()
Delete transient data associated with
DynamicSectionCut
objects in the session. |
void |
deleteUndoMark(int markId,
String markName)
Deletes an undo mark.
|
void |
deleteUndoMarksSetInTaskEnvironment()
This method deletes all the undo marks that have been created since
entering the task environment via
beginTaskEnvironment() . |
void |
deleteUndoMarksUpToMark(int markId,
String markName,
boolean deleteAllIfNotFound)
Deletes all undo marks up to and including the specified mark.
|
DesignRuleManager |
designRuleManager()
Returns the
DesignRuleManager . |
DexManager |
dexManager()
|
DisplayManager |
displayManager()
|
boolean |
doesUndoMarkExist(int markId,
String markName)
Returns true if the specified mark exists
License requirements: None. |
DrawingUtils |
drawingUtils()
|
boolean |
enableRedo(boolean enableRedo)
Enable redo for NXOpen programs.
|
void |
endTaskEnvironment()
This method is called by the NX user interface when leaving
a task environment.
|
EngineeringFunction |
engineeringFunction()
|
Object |
execute(String libName,
String className,
String methodName,
Object[] inputArgs)
Invokes a method in a managed library.
|
Object[] |
executeGrip(String gripExecutable,
Object[] inputArgs)
Call a grip subroutine.
|
String |
executingJournal()
Returns the full path to the journal that is currently being
executed
License requirements: None. |
void |
exitPartNavigator()
Exits the part navigator
License requirements: None. |
void |
freezePartNavigator()
Freeze Part Navigator updates.
|
FTKManager |
ftkmanager()
|
Session.UndoMarkData[] |
getAllUndoMarks(Session.MarkVisibility visibility)
Returns a list of all the undo marks with the specified visibility
License requirements: None. |
String[] |
getClasses()
Gets a list of the classes defined in the current session
License requirements: None. |
String |
getEnvironmentVariableValue(String envVaribable)
Returns the value of a NX enviroment variable
License requirements: None. |
Session.NamedPropertiesData |
getNamedProperties(String className)
Gets a list of the named properties of a named class
License requirements: None. |
String[] |
getNamedProperties(TaggedObject object)
Gets a list of the named properties of this object
License requirements: None. |
int |
getNewestUndoMark(Session.MarkVisibility visibility)
Returns the newest undo mark with the specified visibility
License requirements: None. |
String |
getProperty(TaggedObject object,
String propertyName)
Gets a named property of the object.
|
String |
getUndoMarkName(int markId)
Returns the name of the specified undo mark
License requirements: None. |
Session.MarkVisibility |
getUndoMarkVisibility(int markId,
String markName)
Returns the visibility of the specified undo mark
License requirements: None. |
Information |
information()
|
boolean |
isBatch()
Returns true if and only if NX is batch mode (or in other words not running interactively).
|
boolean |
isCamSessionInitialized()
Check if the CAM session is initialized
License requirements: None. |
boolean |
isInspectionSessionInitialized()
Check if the Inspection session is initialized
License requirements: None. |
boolean |
isInTaskEnvironment()
Returns true if and only if NX is in a task environment
License requirements: None. |
boolean |
isPartNavigatorFrozen()
Check if the Part Navigator update is frozen
License requirements: None. |
boolean |
isPartNavigatorOpen()
Check if the Part Navigator is open or close
License requirements: None. |
IssueManager |
issueManager()
|
JournalManager |
journalManager()
Returns the JournalManager instance belonging to this session .
|
LicenseManager |
licenseManager()
|
LinkedPartManager |
linkedPartManager()
|
ListingWindow |
listingWindow()
|
LogFile |
logFile()
Returns the log file instance for this session .
|
MarkupManager |
markupManager()
Returns the
MarkupManager instance belonging to this session
Created in NX10.0.0 NX_REMOVE_FROM_JAVA_API |
MathUtils |
mathUtils()
|
Measurement |
measurement()
|
MechatronicsSession |
mechatronicsSession()
|
MotionSession |
motionSession()
Returns the Motion session .
|
MotionSimulation |
motionSimulation()
Returns the Motion session .
|
GRMSearch |
newCaeGrmsearch()
Creates a new CAE GRM Search object
License requirements: None. |
PersistentSettings |
newDatabasePersistentOptions()
Creates a new database persistent option controller
License requirements: None. |
SessionSettings |
newDatabaseSessionOptions()
Creates a new database session option controller
License requirements: None. |
ErrorList |
newErrorList()
Creates a new error list.
|
int |
newestVisibleUndoMark()
Returns the newest visible undo mark
License requirements: None. |
PartCleanup |
newPartCleanup()
Constructs a new PartCleanup object.
|
TransientText |
newTransientText()
Returns a new
TransientText object
License requirements: None. |
void |
openPartNavigator()
Opens the part navigator
License requirements: None. |
OptionsManager |
optionsManager()
|
PartCollection |
parts()
|
PdmSearchManager |
pdmSearchManager()
|
PdmSession |
pdmSession()
|
PolygonModelingTaskEnvironment |
polygonModelingTaskEnvironment()
|
Post |
post()
|
PostConfiguratorManager |
postConfiguratorManager()
|
SessionPreferences |
preferences()
Returns the preferences instance for the session .
|
PvtransManager |
pvtransManager()
|
void |
redo()
Redo the last undo if possible.
|
ReportManager |
reportManager()
Returns the
ReportManager belonging to this session. |
RequirementUtils |
requirementUtils()
|
ResultManager |
resultManager()
|
CustomManager |
routeCustomManager()
Returns the
CustomManager for this session. |
void |
setEnvironmentVariableValue(String envVaribable,
String envValue)
Sets the value of a NX enviroment variable
License requirements: None. |
void |
setProperty(TaggedObject object,
String propertyName,
String value)
Sets a named property of the object.
|
void |
setTransientPartPersistencePolicy(Session.TransientPartPolicy policy)
Sets the persistence policy for transient parts in the session
License requirements: None. |
int |
setUndoMark(Session.MarkVisibility markVisibility,
String name)
Creates an undo mark
License requirements: None. |
void |
setUndoMarkName(int markId,
String markName)
Sets the name of the undo mark
License requirements: None. |
void |
setUndoMarkVisibility(int markId,
String markName,
Session.MarkVisibility visibility)
Sets the visibility of the specified undo mark
License requirements: None. |
SheetManager |
sheetManager()
Returns the SheetManager instance belonging to this session .
|
ShipSession |
shipSession()
Returns the
ShipSession belonging to this session. |
SpreadsheetManager |
spreadsheetManager()
|
SubdivisionTaskEnvironment |
subdivisionTaskEnvironment()
|
ToolingSession |
toolingSession()
|
Session.TransientPartPolicy |
transientPartPersistencePolicy()
Returns the persistence policy for transient parts in the session
License requirements: None. |
Session.UndoLastNVisibleMarksData |
undoLastNVisibleMarks(int n)
Undo to a specified number of visible marks starting with the most
recently created visible mark.
|
void |
undoToLastVisibleMark()
Undo to last visible mark.
|
void |
undoToMark(int markId,
String markName)
Undo to the specified mark
License requirements: None. |
void |
undoToMarkWithStatus(int markId,
String markName)
Undo to the specified mark and output status to status bar.
|
void |
unfreezePartNavigator()
Unfreeze Part Navigator updates.
|
Update |
updateManager()
|
UserDefinedClassManager |
userDefinedClassManager()
|
UserDefinedFeatureClassManager |
userDefinedFeatureClassManager()
|
ValidationManager |
validationManager()
|
VisualReportManager |
visualReportManager()
|
WebAppSession |
webAppSession()
|
WeldCpdUtils |
weldCpdUtils()
|
CustomManager |
weldCustomManager()
|
XmlComparator |
xmlComparator()
|
XYPlotManager |
xyplotManager()
|
closeTestOutput, compareTestOutput, setTestOutput, setTestOutput, taggedObjectManager
printTestData, printTestData, tag, tagValue
AfuManager afuManager() throws RemoteException
RemoteException
DexManager dexManager() throws RemoteException
RemoteException
PvtransManager pvtransManager() throws RemoteException
RemoteException
FTKManager ftkmanager() throws RemoteException
RemoteException
Post post() throws RemoteException
RemoteException
ResultManager resultManager() throws RemoteException
RemoteException
CaeSession caeSession() throws RemoteException
RemoteException
Update updateManager() throws RemoteException
RemoteException
PartCollection parts() throws RemoteException
RemoteException
CustomManager weldCustomManager() throws RemoteException
RemoteException
ValidationManager validationManager() throws RemoteException
RemoteException
ListingWindow listingWindow() throws RemoteException
RemoteException
SpreadsheetManager spreadsheetManager() throws RemoteException
RemoteException
DisplayManager displayManager() throws RemoteException
RemoteException
MathUtils mathUtils() throws RemoteException
RemoteException
EngineeringFunction engineeringFunction() throws RemoteException
RemoteException
Measurement measurement() throws RemoteException
RemoteException
Information information() throws RemoteException
RemoteException
SessionPreferences preferences() throws RemoteException
RemoteException
LogFile logFile() throws RemoteException
RemoteException
CAMSession camsession() throws RemoteException
RemoteException
DesignRuleManager designRuleManager() throws RemoteException
RemoteException
CustomManager routeCustomManager() throws RemoteException
RemoteException
OptionsManager optionsManager() throws RemoteException
RemoteException
LicenseManager licenseManager() throws RemoteException
RemoteException
UserDefinedClassManager userDefinedClassManager() throws RemoteException
RemoteException
AssembliesUtils assembliesUtils() throws RemoteException
RemoteException
DrawingUtils drawingUtils() throws RemoteException
RemoteException
RequirementUtils requirementUtils() throws RemoteException
RemoteException
MotionSession motionSession() throws RemoteException
RemoteException
MotionSimulation motionSimulation() throws RemoteException
RemoteException
PdmSearchManager pdmSearchManager() throws RemoteException
RemoteException
XmlComparator xmlComparator() throws RemoteException
RemoteException
DataManager dataManager() throws RemoteException
RemoteException
VisualReportManager visualReportManager() throws RemoteException
RemoteException
XYPlotManager xyplotManager() throws RemoteException
RemoteException
PdmSession pdmSession() throws RemoteException
RemoteException
ToolingSession toolingSession() throws RemoteException
RemoteException
UserDefinedFeatureClassManager userDefinedFeatureClassManager() throws RemoteException
RemoteException
IssueManager issueManager() throws RemoteException
RemoteException
AttributeManager attributeManager() throws RemoteException
RemoteException
LinkedPartManager linkedPartManager() throws RemoteException
RemoteException
CollaborativeContentManager collaborativeContentManager() throws RemoteException
RemoteException
MechatronicsSession mechatronicsSession() throws RemoteException
RemoteException
ConfigurationManager configurationManager() throws RemoteException
RemoteException
BookmarkFile bookmarkFile() throws RemoteException
RemoteException
SubdivisionTaskEnvironment subdivisionTaskEnvironment() throws RemoteException
RemoteException
WeldCpdUtils weldCpdUtils() throws RemoteException
RemoteException
MarkupManager markupManager() throws RemoteException
MarkupManager
instance belonging to this session
RemoteException
CustomFeatureClassManager customFeatureClassManager() throws RemoteException
RemoteException
PostConfiguratorManager postConfiguratorManager() throws RemoteException
RemoteException
JournalManager journalManager() throws RemoteException
RemoteException
WebAppSession webAppSession() throws RemoteException
RemoteException
ReportManager reportManager() throws RemoteException
RemoteException
ShipSession shipSession() throws RemoteException
RemoteException
SheetManager sheetManager() throws RemoteException
RemoteException
PolygonModelingTaskEnvironment polygonModelingTaskEnvironment() throws RemoteException
RemoteException
int setUndoMark(Session.MarkVisibility markVisibility, String name) throws NXException, RemoteException
markVisibility
- name
- mark nameNXException
RemoteException
void undoToLastVisibleMark() throws NXException, RemoteException
undoLastNVisibleMarks(int)
to delete the undo mark also.
NXException
RemoteException
Session.UndoLastNVisibleMarksData undoLastNVisibleMarks(int n) throws NXException, RemoteException
redo()
if the operations undone permit it.
n
- Number of visible marks to undoNXException
RemoteException
void redo() throws NXException, RemoteException
undoLastNVisibleMarks(int)
are redoable.
NXException
RemoteException
void undoToMark(int markId, String markName) throws NXException, RemoteException
markId
- ID of mark to undo tomarkName
- Name of mark to undo to. Used only if mark_id not foundNXException
RemoteException
void undoToMarkWithStatus(int markId, String markName) throws NXException, RemoteException
markId
- ID of mark to undo tomarkName
- Name of mark to undo to. Used only if mark_id not foundNXException
RemoteException
void deleteUndoMark(int markId, String markName) throws NXException, RemoteException
deleteUndoMarksUpToMark(int, java.lang.String, boolean)
instead.
markId
- ID of markmarkName
- Name of mark. Used only if mark_id not foundNXException
RemoteException
void deleteUndoMarksUpToMark(int markId, String markName, boolean deleteAllIfNotFound) throws NXException, RemoteException
deleteUndoMark(int, java.lang.String)
instead.
markId
- ID of markmarkName
- Name of mark. Used only if mark_id not founddeleteAllIfNotFound
- Whether to delete all marks if the specified mark is not foundNXException
RemoteException
void deleteAllUndoMarks() throws NXException, RemoteException
NXException
RemoteException
void setUndoMarkVisibility(int markId, String markName, Session.MarkVisibility visibility) throws NXException, RemoteException
markId
- ID of markmarkName
- Name of the mark. Used only if mark_id not foundvisibility
- the new visibilityNXException
RemoteException
Session.MarkVisibility getUndoMarkVisibility(int markId, String markName) throws NXException, RemoteException
markId
- ID of markmarkName
- Name of the mark. Used only if mark_id not foundNXException
RemoteException
String getUndoMarkName(int markId) throws NXException, RemoteException
markId
- ID of the markNXException
RemoteException
void setUndoMarkName(int markId, String markName) throws NXException, RemoteException
markId
- ID of the markmarkName
- Name of the mark.NXException
RemoteException
boolean doesUndoMarkExist(int markId, String markName) throws NXException, RemoteException
markId
- ID of markmarkName
- Name of the mark. Used only if mark_id not foundNXException
RemoteException
Session.UndoMarkData[] getAllUndoMarks(Session.MarkVisibility visibility) throws NXException, RemoteException
visibility
- Used to limit the results to marks with the specified visibilityNXException
RemoteException
int getNewestUndoMark(Session.MarkVisibility visibility) throws NXException, RemoteException
visibility
- the visibility maskNXException
RemoteException
int newestVisibleUndoMark() throws NXException, RemoteException
NXException
RemoteException
void beginTaskEnvironment() throws NXException, RemoteException
endTaskEnvironment()
will restore the marks to the visibility that they had before this
method was called.
This method should not be called if NX is already in a task environment.
NXException
RemoteException
void deleteUndoMarksSetInTaskEnvironment() throws NXException, RemoteException
beginTaskEnvironment()
.
An exception will be thrown if this method is called
when NX is not in a task environment.
NXException
RemoteException
void endTaskEnvironment() throws NXException, RemoteException
beginTaskEnvironment()
.
An exception will be thrown if this method is called
when NX is not in a task environment.
NXException
RemoteException
boolean isInTaskEnvironment() throws NXException, RemoteException
NXException
RemoteException
Sketch activeSketch() throws NXException, RemoteException
NXException
RemoteException
PartCleanup newPartCleanup() throws NXException, RemoteException
NXException
RemoteException
ErrorList newErrorList() throws NXException, RemoteException
NXException
RemoteException
SessionSettings newDatabaseSessionOptions() throws NXException, RemoteException
NXException
RemoteException
PersistentSettings newDatabasePersistentOptions() throws NXException, RemoteException
NXException
RemoteException
GRMSearch newCaeGrmsearch() throws NXException, RemoteException
NXException
RemoteException
String executingJournal() throws NXException, RemoteException
NXException
RemoteException
Object[] executeGrip(String gripExecutable, Object[] inputArgs) throws NXException, RemoteException
gripExecutable
- Name of Grip executable to runinputArgs
- Input arguments for Grip subroutineNXException
RemoteException
Object execute(String libName, String className, String methodName, Object[] inputArgs) throws NXException, RemoteException
libName
- Name of the library containing the method. The full path to the library is required.className
- Name of the classmethodName
- Name of the method to invokeinputArgs
- Input arguments for managed methodNXException
RemoteException
void createCamSession() throws NXException, RemoteException
NXException
RemoteException
boolean isCamSessionInitialized() throws NXException, RemoteException
NXException
RemoteException
void createInspectionSession() throws NXException, RemoteException
NXException
RemoteException
boolean isInspectionSessionInitialized() throws NXException, RemoteException
NXException
RemoteException
void setTransientPartPersistencePolicy(Session.TransientPartPolicy policy) throws NXException, RemoteException
policy
- NXException
RemoteException
Session.TransientPartPolicy transientPartPersistencePolicy() throws NXException, RemoteException
NXException
RemoteException
String getProperty(TaggedObject object, String propertyName) throws NXException, RemoteException
object
- The object to querypropertyName
- The name of the propertyNXException
RemoteException
void setProperty(TaggedObject object, String propertyName, String value) throws NXException, RemoteException
object
- The object to querypropertyName
- The name of the propertyvalue
- The value of the property, expressed as a stringNXException
RemoteException
String[] getNamedProperties(TaggedObject object) throws NXException, RemoteException
object
- The object to queryNXException
RemoteException
String[] getClasses() throws NXException, RemoteException
NXException
RemoteException
Session.NamedPropertiesData getNamedProperties(String className) throws NXException, RemoteException
className
- The name of the class to queryNXException
RemoteException
void cleanUpFacetedFacesAndEdges() throws NXException, RemoteException
FacetedFace
and FacetedEdge
objects
in the current session
NXException
RemoteException
void assignRemoveProjects(String[] cliNames, Session.ProjectAssignmentObjectType[] objectTypes, String[] projectNames, Session.ProjectAssignmentState[] assignmentStates) throws NXException, RemoteException
cliNames
- cli names of the objects to assign projects toobjectTypes
- one of item, item rev or dataset typeprojectNames
- names of the projects to assignassignmentStates
- assignment statesNXException
RemoteException
String getEnvironmentVariableValue(String envVaribable) throws NXException, RemoteException
envVaribable
- the environment variable name, which may be case sensitive on some platformsNXException
RemoteException
boolean isBatch() throws NXException, RemoteException
NXException
RemoteException
void setEnvironmentVariableValue(String envVaribable, String envValue) throws NXException, RemoteException
envVaribable
- the environment variable name, which may be case sensitive on some platformsenvValue
- the value to be assigned to this environment variableNXException
RemoteException
boolean enableRedo(boolean enableRedo) throws NXException, RemoteException
enableRedo
- True will enable redo for NXOpen programs.
False should disable the redo for NXOpen programsNXException
RemoteException
TransientText newTransientText() throws NXException, RemoteException
NXException
RemoteException
void assignRemoveProjectsBasedOnPartOccs(TaggedObject[] partOccs, Session.ProjectAssignmentObjectType[] objectTypes, String[] projectNames, Session.ProjectAssignmentState[] assignmentStates) throws NXException, RemoteException
partOccs
- Array of components to assign/remove projects toobjectTypes
- currently only DEprojectNames
- names of the projects to assignassignmentStates
- assignment statesNXException
RemoteException
void applicationSwitchImmediate(String applicationName) throws NXException, RemoteException
applicationName
- Button name of requested applicationNXException
RemoteException
String applicationName() throws NXException, RemoteException
NXException
RemoteException
TableEditorDefaultDataProvider createTableEditorDefaultDataProvider(BasePart part) throws NXException, RemoteException
part
- The part that owns the data provider. The owner is not strictly required
(that is, it can be null), but its use is suggested if a part exists to
ensure proper cleanup of the builder in case the client does not explicitly
clean it up properly.NXException
RemoteException
boolean deleteTransientDynamicSectionCutData() throws NXException, RemoteException
DynamicSectionCut
objects in the session. One example of transient data generation is
measurement to a dynamic section-cut. Transient section curves are
generated in order to perform non-associative measurement. These
transient curves are destroyed once measurement operation is
finished.
NXException
RemoteException
void exitPartNavigator() throws NXException, RemoteException
NXException
RemoteException
void openPartNavigator() throws NXException, RemoteException
NXException
RemoteException
boolean isPartNavigatorOpen() throws NXException, RemoteException
NXException
RemoteException
boolean isPartNavigatorFrozen() throws NXException, RemoteException
NXException
RemoteException
void freezePartNavigator() throws NXException, RemoteException
unfreezePartNavigator()
subsequently to enable Part Navigator updates again.
NXException
RemoteException
void unfreezePartNavigator() throws NXException, RemoteException
freezePartNavigator()
.
This should be followed by a call to Update.doUpdate(int)
.
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.