public interface ImageCaptureBuilder extends Builder
ImageCaptureBuilder
builder ImageCaptureManager.createImageCaptureBuilder()
Property | Value |
---|---|
CaptureMethod | GraphicsArea |
Format | Bmp |
Size | Pixels64 |
Modifier and Type | Interface and Description |
---|---|
static class |
ImageCaptureBuilder.CaptureMethodType
the selection method
|
static class |
ImageCaptureBuilder.ImageFormat
the image format
|
static class |
ImageCaptureBuilder.ImageSize
the image size
|
static class |
ImageCaptureBuilder.RegionData
This class holds the data returned from
getRegion() |
Modifier and Type | Method and Description |
---|---|
ImageCaptureBuilder.CaptureMethodType |
captureMethod()
Returns the capture method
License requirements: None. |
String |
file()
Returns the file
License requirements: None. |
ImageCaptureBuilder.ImageFormat |
format()
Returns the format
License requirements: None. |
ImageCaptureBuilder.RegionData |
getRegion()
Returns the region
License requirements: None. |
String |
imageFile()
Returns the image file
License requirements: None. |
void |
setCaptureMethod(ImageCaptureBuilder.CaptureMethodType captureMethod)
License requirements: drafting ("DRAFTING") . |
void |
setFile(String filename)
License requirements: drafting ("DRAFTING") . |
void |
setFormat(ImageCaptureBuilder.ImageFormat format)
License requirements: drafting ("DRAFTING") . |
void |
setImageFile(String imageFilename)
License requirements: drafting ("DRAFTING") . |
void |
setRegion(int[] topLeftCorner,
int[] bottomRightCorner)
Sets the region
License requirements: drafting ("DRAFTING") . |
void |
setSize(ImageCaptureBuilder.ImageSize size)
License requirements: drafting ("DRAFTING") . |
ImageCaptureBuilder.ImageSize |
size()
Returns the size
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
ImageCaptureBuilder.CaptureMethodType captureMethod() throws NXException, RemoteException
NXException
RemoteException
void setCaptureMethod(ImageCaptureBuilder.CaptureMethodType captureMethod) throws NXException, RemoteException
captureMethod
- NXException
RemoteException
ImageCaptureBuilder.RegionData getRegion() throws NXException, RemoteException
NXException
RemoteException
void setRegion(int[] topLeftCorner, int[] bottomRightCorner) throws NXException, RemoteException
topLeftCorner
- Array of 2 integers for Top Left Corner of RegionbottomRightCorner
- Array of 2 integers for Bottom Right Corner of RegionNXException
RemoteException
String file() throws NXException, RemoteException
NXException
RemoteException
void setFile(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
ImageCaptureBuilder.ImageFormat format() throws NXException, RemoteException
NXException
RemoteException
void setFormat(ImageCaptureBuilder.ImageFormat format) throws NXException, RemoteException
format
- NXException
RemoteException
ImageCaptureBuilder.ImageSize size() throws NXException, RemoteException
NXException
RemoteException
void setSize(ImageCaptureBuilder.ImageSize size) throws NXException, RemoteException
size
- NXException
RemoteException
String imageFile() throws NXException, RemoteException
NXException
RemoteException
void setImageFile(String imageFilename) throws NXException, RemoteException
imageFilename
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.