public interface CGMBuilder extends Builder
CGMBuilder
to be used when exporting the Current Display
or drawing sheets to a CGM. This class is created using PlotManager
.
All sheets provided must be in the displayed part.
The user must specify the sheets to be exported by setting the appropriate fields
through the PlotSourceBuilder
.
If running in native mode, use the Filenames field to specify the full path location
of the CGM(s).
If running Teamcenter, there are several options:
1. Exporting a single CGM. More than one sheet can be exported to one CGM if the Multiple
option is set to Single. The Dataset Name field must be filled with one
dataset name.
2. Exporting multiple CGMs. This requires the Dataset Names field to be filled with the
same number of dataset names as sheets selected for export. The Multiple option
needs to be set to Individual for this functionality.
3. Overwriting an existing CGM. This requires the Dataset Name field to be filled
with the dataset name that is to be overwritten.
4. Export CGM(s) locally. This is possible by setting the Action option to File Browser.
If exporting locally then the Filenames field must be set with full path filenames.
All options when exporting to Teamcenter require the Dataset Type and Named Reference Type
fields to be set.
PlotManager.createCgmBuilder()
Property | Value |
---|---|
Action | CreateNew |
Colors | AsDisplayed |
ImageResolution | Draft |
Multiple | Individual |
OutputText | Text |
RasterImages | 0 |
Scale | 1 |
ShadedGeometry | 0 |
Size | FullScale |
Units | Metric |
VdcCoordinates | Real |
Widths | StandardWidths |
XDimension | 0 |
YDimension | 0 |
Modifier and Type | Interface and Description |
---|---|
static class |
CGMBuilder.ActionOption
Specifies the action option to be used when running Teamcenter
|
static class |
CGMBuilder.Color
Specifies the color option to use when creating the CGM
|
static class |
CGMBuilder.ImageResolutionOption
Specifies the image resolution when exporting a raster image
|
static class |
CGMBuilder.MultipleOption
Specifies how to export multiple drawing sheets in Native mode
|
static class |
CGMBuilder.OutputTextOption
Specifies the text option, as either text or polylines
|
static class |
CGMBuilder.RelationOption
Specifies the relation to use when exporting a CGM to Teamcenter
|
static class |
CGMBuilder.SizeOption
Specifies the size option of the CGM.
|
static class |
CGMBuilder.UnitsOption
Specifies which units are associated to the dimensions
|
static class |
CGMBuilder.Vdc
Specifies the VDC coordinates to use when creating the CGM
|
static class |
CGMBuilder.Width
Specifies the primary selection of which type of width assignment to use.
|
Modifier and Type | Method and Description |
---|---|
CGMBuilder.ActionOption |
action()
Returns the action option to be used when exporting the CGM file when in Teamcenter
mode.
|
CGMBuilder.Color |
colors()
Returns the color option to be used when creating the CGM.
|
CDF |
createCdf()
Creates and returns a
CDF object representing the Color Palette. |
WidthDefinition |
createWidthDefinition()
Creates and returns a
WidthDefinition object representing
the Width Palette. |
boolean |
customSymbolsInForeground()
Returns the plotting custom symbols in the foreground option.
|
String |
datasetType()
Returns the dataset type to be used when exporting a CGM to Teamcenter
License requirements: None. |
CDF |
getCdf()
Returns a
CDF object representing the Color Palette. |
String[] |
getDatasetNames()
Gets the dataset names to be used when creating CGMs in a Teamcenter
environment.
|
String[] |
getFilenames()
Gets all the CGM filenames.
|
WidthDefinition |
getWidthDefinition()
Returns a
WidthDefinition object representing the Width Palette. |
CGMBuilder.ImageResolutionOption |
imageResolution()
Returns the resolution of images created for export of shaded views.
|
CGMBuilder.MultipleOption |
multiple()
Returns the multiple option is used when more than one drawing is exported.
|
String |
namedReferenceType()
Returns the named reference type to be used when exporting a CGM to Teamcenter
License requirements: None. |
CGMBuilder.OutputTextOption |
outputText()
Returns the output text of the CGM.
|
boolean |
rasterImages()
Returns the Raster Images option.
|
CGMBuilder.RelationOption |
relation()
Returns the relation to be used when exporting a CGM to Teamcenter
License requirements: None. |
double |
scale()
Returns the scale factor to be used when creating a CGM.
|
void |
setAction(CGMBuilder.ActionOption action)
License requirements: None. |
void |
setColors(CGMBuilder.Color colors)
License requirements: None. |
void |
setCustomSymbolsInForeground(boolean customSymbolsInForeground)
License requirements: None. |
void |
setDatasetNames(String[] datasetNames)
Sets all the dataset names to be used when creating CGMs in a Teamcenter
environment.
|
void |
setDatasetType(String datasetType)
License requirements: None. |
void |
setFilenames(String[] filenames)
Sets all the CGM filenames.
|
void |
setImageResolution(CGMBuilder.ImageResolutionOption imageResolution)
License requirements: None. |
void |
setMultiple(CGMBuilder.MultipleOption multiple)
License requirements: None. |
void |
setNamedReferenceType(String namedReferenceType)
License requirements: None. |
void |
setOutputText(CGMBuilder.OutputTextOption outputText)
License requirements: None. |
void |
setRasterImages(boolean rasterImages)
License requirements: None. |
void |
setRelation(CGMBuilder.RelationOption relation)
License requirements: None. |
void |
setScale(double scale)
License requirements: None. |
void |
setShadedGeometry(boolean shadedGeometry)
License requirements: None. |
void |
setSize(CGMBuilder.SizeOption size)
License requirements: None. |
void |
setUnits(CGMBuilder.UnitsOption units)
License requirements: None. |
void |
setVdcCoordinates(CGMBuilder.Vdc vdc)
License requirements: None. |
void |
setWidths(CGMBuilder.Width widths)
License requirements: None. |
void |
setXDimension(double xDimension)
License requirements: None. |
void |
setYDimension(double yDimension)
License requirements: None. |
boolean |
shadedGeometry()
Returns the Shaded Geometry as Wireframe option.
|
CGMBuilder.SizeOption |
size()
Returns the size of the CGM.
|
PlotSourceBuilder |
sourceBuilder()
Returns the Source builder.
|
CGMBuilder.UnitsOption |
units()
Returns the units of the X and Y dimensions to be used when Dimension has been selected
from the Size option.
|
CGMBuilder.Vdc |
vdcCoordinates()
Returns the Virtual Display Coordinates.
|
CGMBuilder.Width |
widths()
Returns the width option.
|
double |
xdimension()
Returns the x dimension to be used when Dimension has been selected from the Size option.
|
double |
ydimension()
Returns the y dimension to be used when Dimension has been selected from the Size option.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
CGMBuilder.ActionOption action() throws NXException, RemoteException
NXException
RemoteException
void setAction(CGMBuilder.ActionOption action) throws NXException, RemoteException
action
- NXException
RemoteException
String[] getDatasetNames() throws NXException, RemoteException
NXException
RemoteException
void setDatasetNames(String[] datasetNames) throws NXException, RemoteException
datasetNames
- NXException
RemoteException
CGMBuilder.MultipleOption multiple() throws NXException, RemoteException
NXException
RemoteException
void setMultiple(CGMBuilder.MultipleOption multiple) throws NXException, RemoteException
multiple
- NXException
RemoteException
CGMBuilder.Color colors() throws NXException, RemoteException
NXException
RemoteException
void setColors(CGMBuilder.Color colors) throws NXException, RemoteException
colors
- NXException
RemoteException
CGMBuilder.Width widths() throws NXException, RemoteException
NXException
RemoteException
void setWidths(CGMBuilder.Width widths) throws NXException, RemoteException
widths
- NXException
RemoteException
CGMBuilder.SizeOption size() throws NXException, RemoteException
NXException
RemoteException
void setSize(CGMBuilder.SizeOption size) throws NXException, RemoteException
size
- NXException
RemoteException
double scale() throws NXException, RemoteException
NXException
RemoteException
void setScale(double scale) throws NXException, RemoteException
scale
- NXException
RemoteException
CGMBuilder.UnitsOption units() throws NXException, RemoteException
NXException
RemoteException
void setUnits(CGMBuilder.UnitsOption units) throws NXException, RemoteException
units
- NXException
RemoteException
double xdimension() throws NXException, RemoteException
NXException
RemoteException
void setXDimension(double xDimension) throws NXException, RemoteException
xDimension
- NXException
RemoteException
double ydimension() throws NXException, RemoteException
NXException
RemoteException
void setYDimension(double yDimension) throws NXException, RemoteException
yDimension
- NXException
RemoteException
CGMBuilder.OutputTextOption outputText() throws NXException, RemoteException
NXException
RemoteException
void setOutputText(CGMBuilder.OutputTextOption outputText) throws NXException, RemoteException
outputText
- NXException
RemoteException
CGMBuilder.Vdc vdcCoordinates() throws NXException, RemoteException
NXException
RemoteException
void setVdcCoordinates(CGMBuilder.Vdc vdc) throws NXException, RemoteException
vdc
- NXException
RemoteException
boolean rasterImages() throws NXException, RemoteException
NXException
RemoteException
void setRasterImages(boolean rasterImages) throws NXException, RemoteException
rasterImages
- NXException
RemoteException
boolean shadedGeometry() throws NXException, RemoteException
NXException
RemoteException
void setShadedGeometry(boolean shadedGeometry) throws NXException, RemoteException
shadedGeometry
- NXException
RemoteException
boolean customSymbolsInForeground() throws NXException, RemoteException
NXException
RemoteException
void setCustomSymbolsInForeground(boolean customSymbolsInForeground) throws NXException, RemoteException
customSymbolsInForeground
- NXException
RemoteException
CGMBuilder.ImageResolutionOption imageResolution() throws NXException, RemoteException
NXException
RemoteException
void setImageResolution(CGMBuilder.ImageResolutionOption imageResolution) throws NXException, RemoteException
imageResolution
- NXException
RemoteException
PlotSourceBuilder sourceBuilder() throws NXException, RemoteException
NXException
RemoteException
String[] getFilenames() throws NXException, RemoteException
NXException
RemoteException
void setFilenames(String[] filenames) throws NXException, RemoteException
filenames
- NXException
RemoteException
CDF createCdf() throws NXException, RemoteException
CDF
object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or
Colors By Width is selected from the Color option.
NXException
RemoteException
CDF getCdf() throws NXException, RemoteException
CDF
object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or
Colors By Width is selected from the Color option.
NXException
RemoteException
WidthDefinition createWidthDefinition() throws NXException, RemoteException
WidthDefinition
object representing
the Width Palette. This object contains all custom width information to be used
when Single Width, Custom Three Widths, or Custom Palette is selected from the
Width option.
NXException
RemoteException
WidthDefinition getWidthDefinition() throws NXException, RemoteException
WidthDefinition
object representing the Width Palette.
This object contains all custom width information to be used when Single Width, Custom
Three Widths, or Custom Palette is selected from the Width option.
NXException
RemoteException
CGMBuilder.RelationOption relation() throws NXException, RemoteException
NXException
RemoteException
void setRelation(CGMBuilder.RelationOption relation) throws NXException, RemoteException
relation
- NXException
RemoteException
String datasetType() throws NXException, RemoteException
NXException
RemoteException
void setDatasetType(String datasetType) throws NXException, RemoteException
datasetType
- NXException
RemoteException
String namedReferenceType() throws NXException, RemoteException
NXException
RemoteException
void setNamedReferenceType(String namedReferenceType) throws NXException, RemoteException
namedReferenceType
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.