public interface ScCollector extends DisplayableObject
ScRuleFactory
for more details on available selection intent rules.
ScRuleFactory
.
ScCollectorCollection.createCollector()
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
void |
addEvaluationFilter(ScEvaluationFiltertype filterType)
Sets the evaluation filter on ScCollector
License requirements: None. |
ScCollector |
copyCollector()
Copy collector object
License requirements: None. |
void |
destroy()
Destroy the ScCollector object
License requirements: None. |
boolean |
getMultiComponent()
Gets the option set on ScCollector for collection from multiple components.
|
boolean |
getNonFeatureMode()
Gets the option set on ScCollector for collection in non-feature mode.
|
TaggedObject[] |
getObjects()
Returns the contents of a collector.
|
TaggedObject[] |
getObjectsSortedById()
Returns the contents of a collector which are guaranteed to be sorted.
|
SelectionIntentRule[] |
getRules()
Returns the rules of the a collector.
|
boolean |
isEvaluationFilterEnabled(ScEvaluationFiltertype filterType)
Checks whether the evaluation filter is present on ScCollector
License requirements: None. |
void |
removeEvaluationFilter(ScEvaluationFiltertype filterType)
Removes the evaluation filter on ScCollector
License requirements: None. |
void |
removeRule(int ruleIndex)
Remove collector rule
License requirements: None. |
void |
removeRules(SelectionIntentRule[] rules)
Remove collector rules
License requirements: None. |
void |
replaceRules(SelectionIntentRule[] rules,
boolean createRulesWoUpdate)
Replace collector rules.
|
void |
replaceRules(SelectionIntentRule[] rules,
DisplayableObject[] negatedEntities,
boolean createRulesWoUpdate)
Replace collector rules and specify negated entities.
|
void |
setAllowRefCurves(boolean allowRefCurves)
Sets whether to allow reference curves or not in the ScCollector
License requirements: None. |
void |
setInterpart(boolean interpart)
Sets inter-part status
This function sets the value of interpart flag on ScCollector. |
void |
setMultiComponent()
Sets the true option on ScCollector for collection from multiple components.
|
void |
setNonFeatureMode()
Sets the true option on ScCollector for collection in non-feature mode.
|
blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, 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
void replaceRules(SelectionIntentRule[] rules, boolean createRulesWoUpdate) throws NXException, RemoteException
rules
- Selection intent rules. To create selection intent rules see
documentation of ScRuleFactory
for more details.createRulesWoUpdate
- Flag to tell whether rules should be created wo_updateNXException
RemoteException
void replaceRules(SelectionIntentRule[] rules, DisplayableObject[] negatedEntities, boolean createRulesWoUpdate) throws NXException, RemoteException
rules
- Selection intent rules. To create selection intent rules see
documentation of ScRuleFactory
for more details.negatedEntities
- Entities in the rules that should be removed from the collector.createRulesWoUpdate
- Flag to tell whether rules should be created wo_updateNXException
RemoteException
void destroy() throws NXException, RemoteException
NXException
RemoteException
TaggedObject[] getObjects() throws NXException, RemoteException
NXException
RemoteException
SelectionIntentRule[] getRules() throws NXException, RemoteException
NXException
RemoteException
void setInterpart(boolean interpart) throws NXException, RemoteException
interpart
- True to set collector as interpartNXException
RemoteException
void removeRule(int ruleIndex) throws NXException, RemoteException
ruleIndex
- index (starting from 0) of the rule to be removedNXException
RemoteException
void removeRules(SelectionIntentRule[] rules) throws NXException, RemoteException
rules
- Selection intent rules to be removedNXException
RemoteException
ScCollector copyCollector() throws NXException, RemoteException
NXException
RemoteException
boolean getMultiComponent() throws NXException, RemoteException
NXException
RemoteException
void setMultiComponent() throws NXException, RemoteException
NXException
RemoteException
boolean getNonFeatureMode() throws NXException, RemoteException
NXException
RemoteException
void setNonFeatureMode() throws NXException, RemoteException
NXException
RemoteException
TaggedObject[] getObjectsSortedById() throws NXException, RemoteException
NXException
RemoteException
void addEvaluationFilter(ScEvaluationFiltertype filterType) throws NXException, RemoteException
filterType
- Enum ValueNXException
RemoteException
void removeEvaluationFilter(ScEvaluationFiltertype filterType) throws NXException, RemoteException
filterType
- Enum ValueNXException
RemoteException
boolean isEvaluationFilterEnabled(ScEvaluationFiltertype filterType) throws NXException, RemoteException
filterType
- Enum ValueNXException
RemoteException
void setAllowRefCurves(boolean allowRefCurves) throws NXException, RemoteException
allowRefCurves
- True to allow reference curves in ScCollectorNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.