public interface Run extends NXObject
Routing.RunCollection#createRun
Modifier and Type | Interface and Description |
---|---|
static class |
Run.CompareStatus
Represents discrepancies in the run compared to another run
|
static class |
Run.FlipStatus
Represents result of flip component
|
static class |
Run.Status
Represents the status of a run
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat
Modifier and Type | Method and Description |
---|---|
void |
deleteRunPath()
This will delete the Run path and member items in a run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
ObjectList[] |
detectRunSpools()
This will detect spools in a run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
Run.Status |
edit(String runId,
String runType,
NXObject[] from,
NXObject[] to,
NXObject[] member)
Edits an existing run with new items.
|
void |
edit(String runId,
String runType,
RunItem[] fromItems,
RunItem[] toItems,
RunItem[] memberItems)
Edits an existing run with new run item data.
|
Run.FlipStatus |
flipComponent(Component component)
Flips a component that is part of a run by rotating the component so that it's input and output ports reverse.
|
boolean |
getActiveStatus()
Get status of Run, Active or Inactive
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
CharacteristicList |
getCharacteristics()
Get all of the characteristics values on the this object.
|
CharacteristicList |
getCharacteristicsWithId()
Get all of the characteristics values on the this object, including RunId.
|
RunItem[] |
getFromItemData()
Retrieves the data of the "From" items of a run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
NXObject[] |
getFromItems()
Retrieves the from items of a run.
|
RunItem[] |
getMemberItemData()
Retrieves the data of the "Member" items of a run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
NXObject[] |
getMemberItems()
Deprecated.
Deprecated in NX9.0.0. Use
getMembers() instead.
|
NXObject[] |
getMembers()
Retrieves the member items of a run.
|
RoutingSystem |
getRoutingSystem()
Ask the
RoutingSystem run belongs to
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") Created in NX4.0.0 |
Run.CompareStatus |
getRunCompareStatus()
Ask the compare status of run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getRunId()
Retrieves the run_id of run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
Run.Status |
getRunStatus()
Ask the status of run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
String |
getRunType()
Retrieves the run type of run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
RunItem[] |
getToItemData()
Retrieves the data of the "To" items of a run
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
NXObject[] |
getToItems()
Retrieves the to items of a run.
|
void |
makeActive()
Set a Run as Active.
|
void |
makeInactive()
Set a Run as Inactive and the Active Specification will be changed to Default Specification of the
discipline, if no discipline is being used then the Active Specification will be set to None.
|
int |
runSegmentGetFlowDirection(ISegment segment)
Get flow direction of a run segment
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
runSegmentReverseFlowDirection(ISegment segment)
Reverse flow direction of a run segment
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
runSegmentSetFlowDirection(ISegment segment,
int flowState)
Set flow direction of a run segment
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setCharacteristics(CharacteristicList values)
Set all of the characteristics values on this object.
|
deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
String getRunId() throws NXException, RemoteException
NXException
RemoteException
String getRunType() throws NXException, RemoteException
NXException
RemoteException
NXObject[] getFromItems() throws NXException, RemoteException
NXException
RemoteException
RunItem[] getFromItemData() throws NXException, RemoteException
NXException
RemoteException
NXObject[] getToItems() throws NXException, RemoteException
NXException
RemoteException
RunItem[] getToItemData() throws NXException, RemoteException
NXException
RemoteException
NXObject[] getMemberItems() throws NXException, RemoteException
getMembers()
instead.
NXException
RemoteException
RunItem[] getMemberItemData() throws NXException, RemoteException
NXException
RemoteException
Run.Status edit(String runId, String runType, NXObject[] from, NXObject[] to, NXObject[] member) throws NXException, RemoteException
runId
- Unique identifier of the Run runType
- Type of the Run from
- Array of to items. Must be nxopen.routing.Port
,
Run
or ControlPoint
to
- Array of to items. Must be nxopen.routing.Port
,
Run
or ControlPoint
member
- Array of member items. Must be Component
,
ISegment
or Routing.StockNXException
RemoteException
void edit(String runId, String runType, RunItem[] fromItems, RunItem[] toItems, RunItem[] memberItems) throws NXException, RemoteException
runId
- Unique identifier of the Run runType
- Type of the Run fromItems
- Array of "From" item data.toItems
- Array of "To" item data.memberItems
- Array of "Member" item data.NXException
RemoteException
Run.Status getRunStatus() throws NXException, RemoteException
NXException
RemoteException
RoutingSystem getRoutingSystem() throws NXException, RemoteException
RoutingSystem
run belongs to
NXException
RemoteException
Run.CompareStatus getRunCompareStatus() throws NXException, RemoteException
NXException
RemoteException
int runSegmentGetFlowDirection(ISegment segment) throws NXException, RemoteException
segment
- NXException
RemoteException
void runSegmentSetFlowDirection(ISegment segment, int flowState) throws NXException, RemoteException
segment
- flowState
- NXException
RemoteException
void runSegmentReverseFlowDirection(ISegment segment) throws NXException, RemoteException
segment
- NXException
RemoteException
ObjectList[] detectRunSpools() throws NXException, RemoteException
NXException
RemoteException
void deleteRunPath() throws NXException, RemoteException
NXException
RemoteException
CharacteristicList getCharacteristics() throws NXException, RemoteException
NXException
RemoteException
void setCharacteristics(CharacteristicList values) throws NXException, RemoteException
values
- NXException
RemoteException
Run.FlipStatus flipComponent(Component component) throws NXException, RemoteException
component
- NXException
RemoteException
void makeActive() throws NXException, RemoteException
makeInactive()
to make a Run as Inactive.
NXException
RemoteException
void makeInactive() throws NXException, RemoteException
makeActive()
to make a Run as Active.
NXException
RemoteException
boolean getActiveStatus() throws NXException, RemoteException
NXException
RemoteException
NXObject[] getMembers() throws NXException, RemoteException
NXException
RemoteException
CharacteristicList getCharacteristicsWithId() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.