public interface VisualReport extends NXObject
VisualReportManager
to
apply colors to objects in the graphics window.
An active visual report groups objects according to filtering conditions and classification
rules. The contents of the groups can be accessed via getGroupLabels()
and getObjectsInGroup(nxopen.visualreporting.GroupLabel)
.
Modifier and Type | Interface and Description |
---|---|
static class |
VisualReport.ObjectTypeOption
Represents the possible report object type options
for a
VisualReport . |
static class |
VisualReport.ReportContextOption
Represents the possible
reportContext() options
for a VisualReport . |
static class |
VisualReport.ReportingObjectTypeOption
Represents the possible
reportingObjectType()
for a VisualReport . |
static class |
VisualReport.ReportingStyleOption
Represents the possible
reportingStyle()
for a VisualReport . |
static class |
VisualReport.SaveDestinationOption
Represents the possible
saveDestination() options
for a VisualReport . |
static class |
VisualReport.ScopeTypeOption
Represents the possible
scopeType() options
for a VisualReport . |
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
String |
bitmapName()
Returns the bitmap name of this
VisualReport . |
String |
customMessage()
Returns the custom message of this
VisualReport . |
String |
description()
Returns the description of this
VisualReport
License requirements: None. |
String |
descriptiveCategory()
Returns the category of this
VisualReport . |
String |
destinationTeamcenterFolder()
Returns the destination Teamcenter folder for saving the
VisualReport to Teamcenter database. |
String |
filename()
Returns the filename where this
VisualReport was opened from or will be saved to. |
Property[] |
getAllDefinedProperties()
Returns the
Property s which has been defined in this VisualReport . |
GroupLabel[] |
getGroupLabels()
Returns the result
GroupLabel s from the activated VisualReport . |
GroupLabel[] |
getGroupLabelsOfResultCategory(ResultCategory category)
|
String |
getKeywords()
Gets a comma separated string of the keywords for this
VisualReport . |
NXObject[] |
getObjectsInGroup(GroupLabel groupLabel)
Returns the
NXObject s that belong to the group
with this GroupLabel . |
VisualReport.ObjectTypeOption[] |
getObjectTypes()
Returns the
VisualReport.ObjectTypeOption s of this VisualReport . |
String |
getPropertyValueOfObject(Property property,
GroupLabel groupLabel,
NXObject nxObject)
|
ResultCategory[] |
getResultCategories()
Returns the
ResultCategory s from the activated VisualReport . |
Rule |
getRule(int index)
|
Rule[] |
getRules()
|
boolean |
isUnmatchedGroupEnabled()
Returns whether use of
unmatchedGroupLabel()
is enabled. |
void |
removeResultCategory(ResultCategory theCategory)
Removes the
ResultCategory from VisualReport . |
VisualReport.ReportContextOption |
reportContext()
Returns the
VisualReport.ReportContextOption of this VisualReport . |
VisualReport.ReportingObjectTypeOption |
reportingObjectType()
Returns the
VisualReport.ReportingObjectTypeOption of this VisualReport . |
VisualReport.ReportingStyleOption |
reportingStyle()
Returns the
VisualReport.ReportingStyleOption of this VisualReport . |
void |
save()
Saves this
VisualReport to its current filename() . |
VisualReport.SaveDestinationOption |
saveDestination()
Returns the
VisualReport.SaveDestinationOption of the VisualReport . |
VisualReport.ScopeTypeOption |
scopeType()
Returns the
VisualReport.ScopeTypeOption of this VisualReport . |
void |
setBitmapName(String bitmapName)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setCustomMessage(String customMessage)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setDescription(String description)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setDescriptiveCategory(String category)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setDestinationTeamcenterFolder(String foldername)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setFilename(String filename)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setKeywords(String keywords)
Sets a comma separated string of the keywords for this
VisualReport . |
void |
setReportContext(VisualReport.ReportContextOption reportContext)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setReportingObjectType(VisualReport.ReportingObjectTypeOption reportingObjectType)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setReportingStyle(VisualReport.ReportingStyleOption reportingStyle)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setSaveDestination(VisualReport.SaveDestinationOption destinationOption)
License requirements: nx_visual_reporting ("Visual Reporting") . |
void |
setUnmatchedGroupEnabled(boolean isUnmatchedGroupEnabled)
License requirements: nx_visual_reporting ("Visual Reporting") . |
GroupLabel |
unmatchedGroupLabel()
Returns the
GroupLabel which is used for unmatched object. |
UnmatchedResultCategory |
unmatchedResultCategory()
Returns the
UnmatchedResultCategory from the activated VisualReport . |
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
VisualReport.SaveDestinationOption saveDestination() throws NXException, RemoteException
VisualReport.SaveDestinationOption
of the VisualReport
.
Note that this property will always be VisualReport.SaveDestinationOption.LOCAL
when NX is not connected to Teamcenter.
NXException
RemoteException
void setSaveDestination(VisualReport.SaveDestinationOption destinationOption) throws NXException, RemoteException
destinationOption
- The destination optionNXException
RemoteException
String destinationTeamcenterFolder() throws NXException, RemoteException
VisualReport
to Teamcenter database.
Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database.
This destinationTeamcenterFolder()
may return null if you haven't
set a folder name on this property.
NXException
RemoteException
void setDestinationTeamcenterFolder(String foldername) throws NXException, RemoteException
foldername
- The Teamcenter folder nameNXException
RemoteException
void save() throws NXException, RemoteException
VisualReport
to its current filename()
.
Note that when NX is connected to Teamcenter, the filename()
will be
updated to the report dataset identifier after the report is saved to Teamcenter database.
NXException
RemoteException
String filename() throws NXException, RemoteException
VisualReport
was opened from or will be saved to.
Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database.
If it is a new report, it will be the report dataset name. When the report is save by save()
,
the report dataset identifier will be saved in this property.
NXException
RemoteException
void setFilename(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
String description() throws NXException, RemoteException
NXException
RemoteException
void setDescription(String description) throws NXException, RemoteException
description
- NXException
RemoteException
Rule getRule(int index) throws NXException, RemoteException
index
- The index of the returned Rule
.NXException
RemoteException
Rule[] getRules() throws NXException, RemoteException
NXException
RemoteException
VisualReport.ReportingStyleOption reportingStyle() throws NXException, RemoteException
VisualReport.ReportingStyleOption
of this VisualReport
.
NXException
RemoteException
void setReportingStyle(VisualReport.ReportingStyleOption reportingStyle) throws NXException, RemoteException
reportingStyle
- NXException
RemoteException
VisualReport.ReportingObjectTypeOption reportingObjectType() throws NXException, RemoteException
VisualReport.ReportingObjectTypeOption
of this VisualReport
.
Only valid if the scopeType()
of the VisualReport
is VisualReport.ScopeTypeOption.COMPONENT
type.
NXException
RemoteException
void setReportingObjectType(VisualReport.ReportingObjectTypeOption reportingObjectType) throws NXException, RemoteException
reportingObjectType
- NXException
RemoteException
ResultCategory[] getResultCategories() throws NXException, RemoteException
ResultCategory
s from the activated VisualReport
.
There are no ResultCategory
s if the VisualReport
is not activated.
NXException
RemoteException
GroupLabel[] getGroupLabelsOfResultCategory(ResultCategory category) throws NXException, RemoteException
GroupLabel
s of a ResultCategory
from the activated VisualReport
.
category
- NXException
RemoteException
UnmatchedResultCategory unmatchedResultCategory() throws NXException, RemoteException
UnmatchedResultCategory
from the activated VisualReport
.
It will return null if the VisualReport
is not activated.
NXException
RemoteException
GroupLabel[] getGroupLabels() throws NXException, RemoteException
GroupLabel
s from the activated VisualReport
.
There are no GroupLabel
s if the VisualReport
is not activated.
You can acess the user defined GroupLabel
s by VisualReportBuilder.getManualGroupLabelsOfRule(nxopen.visualreporting.Rule)
.
NXException
RemoteException
boolean isUnmatchedGroupEnabled() throws NXException, RemoteException
unmatchedGroupLabel()
is enabled.
NXException
RemoteException
void setUnmatchedGroupEnabled(boolean isUnmatchedGroupEnabled) throws NXException, RemoteException
isUnmatchedGroupEnabled
- Whether the unmatched group is enabledNXException
RemoteException
GroupLabel unmatchedGroupLabel() throws NXException, RemoteException
GroupLabel
which is used for unmatched object.
It will return null if the VisualReport
is not activated.
NXException
RemoteException
NXObject[] getObjectsInGroup(GroupLabel groupLabel) throws NXException, RemoteException
NXObject
s that belong to the group
with this GroupLabel
.
groupLabel
- A group label of this visual reportNXException
RemoteException
String descriptiveCategory() throws NXException, RemoteException
NXException
RemoteException
void setDescriptiveCategory(String category) throws NXException, RemoteException
category
- NXException
RemoteException
String getKeywords() throws NXException, RemoteException
VisualReport
.
NXException
RemoteException
void setKeywords(String keywords) throws NXException, RemoteException
VisualReport
.
keywords
- NXException
RemoteException
String bitmapName() throws NXException, RemoteException
NXException
RemoteException
void setBitmapName(String bitmapName) throws NXException, RemoteException
bitmapName
- NXException
RemoteException
String customMessage() throws NXException, RemoteException
NXException
RemoteException
void setCustomMessage(String customMessage) throws NXException, RemoteException
customMessage
- NXException
RemoteException
void removeResultCategory(ResultCategory theCategory) throws NXException, RemoteException
ResultCategory
from VisualReport
.
The Classifier
which populates this ResultCategory
will also be removed from the Rule
in the VisualReport
.
theCategory
- NXException
RemoteException
Property[] getAllDefinedProperties() throws NXException, RemoteException
Property
s which has been defined in this VisualReport
.
The returned properties include those properties defined in Condition
s, in Classifier
s,
and in the referenced properties.
NXException
RemoteException
String getPropertyValueOfObject(Property property, GroupLabel groupLabel, NXObject nxObject) throws NXException, RemoteException
Property
s for the NXObject
in the result GroupLabel
.
It will return null if the VisualReport
is not activated, or the Property
does not belong to the properties defined in this VisualReport
, or the NXObject
doesn't belong to
the specified result GroupLabel
.
property
- A property defined in this visual reportgroupLabel
- A result group of this visual reportnxObject
- A NXObject
which belongs to the result groupNXException
RemoteException
VisualReport.ScopeTypeOption scopeType() throws NXException, RemoteException
VisualReport.ScopeTypeOption
of this VisualReport
.
NXException
RemoteException
VisualReport.ObjectTypeOption[] getObjectTypes() throws NXException, RemoteException
VisualReport.ObjectTypeOption
s of this VisualReport
.
Only valid if the scopeType()
of the VisualReport
is VisualReport.ScopeTypeOption.SUB_PART
type.
NXException
RemoteException
VisualReport.ReportContextOption reportContext() throws NXException, RemoteException
VisualReport.ReportContextOption
of this VisualReport
.
NXException
RemoteException
void setReportContext(VisualReport.ReportContextOption reportContext) throws NXException, RemoteException
reportContext
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.