nxopen.formboard

Interface FaceAnnotationBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface FaceAnnotationBuilder
extends Builder

Builder for Face Annotation functionality used in formboard. It allows importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. As a result of this a group of dumb geometry is placed such that defined origin is located at the lower left hand of the bounding box containing the group of geometry.
To create a new instance of this class, use FormboardManager.createFaceAnnotationBuilder()
Default values.

Property	Value
DestEnum	DrawingSheet
TogBlank	0

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FaceAnnotationBuilder.DrwDestination Enum which defines where the geometry is to be placed.
static class	FaceAnnotationBuilder.Types Enum which defines the type to import CGM/Pattern file

Method Summary

Modifier and Type	Method and Description
String	cgmflBrsr() Returns the browser which enables selection of CGM file when Formboard.FaceAnnotationBuilder.Types is Formboard.FaceAnnotationBuilder.Types#CGM_FILE_SELECTION .
SelectNXObject	compSel() Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.
FaceAnnotationBuilder.DrwDestination	destEnum() Returns the FaceAnnotationBuilder.DrwDestination selected by user to place the geometry License requirements: routing_harness ("Routing Harness") Created in NX7.5.0
Point	pntOrigin() Returns the user selected point where geometry will be placed License requirements: routing_harness ("Routing Harness") .
void	setCgmflBrsr(String filename) License requirements: routing_harness ("Routing Harness") .
void	setDestEnum(FaceAnnotationBuilder.DrwDestination destEnum) License requirements: routing_harness ("Routing Harness") .
void	setPntOrigin(Point pntOrigin) License requirements: routing_harness ("Routing Harness") .
void	setStrAnnot(String strAnnot) License requirements: routing_harness ("Routing Harness") .
void	setStrAnnotFileName(String strAnnot) License requirements: routing_harness ("Routing Harness") .
void	setTogBlank(boolean togBlank) License requirements: routing_harness ("Routing Harness") .
void	setType(FaceAnnotationBuilder.Types type) License requirements: routing_harness ("Routing Harness") .
String	strAnnot() Returns the string to display the name of Pattern file name selected by user.
String	strAnnotFileName() Returns the string to display the name of CGM name selected by user.
boolean	togBlank() Returns the toggle which defines whether the selected component is to be blanked or not License requirements: routing_harness ("Routing Harness") .
FaceAnnotationBuilder.Types	type() Returns the FaceAnnotationBuilder.Types selected by user License requirements: routing_harness ("Routing Harness") Created in NX7.5.0

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

compSel

SelectNXObject compSel()
                throws NXException,
                       RemoteException

Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

cgmflBrsr

String cgmflBrsr()
          throws NXException,
                 RemoteException

Returns the browser which enables selection of CGM file when Formboard.FaceAnnotationBuilder.Types is Formboard.FaceAnnotationBuilder.Types#CGM_FILE_SELECTION .
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

setCgmflBrsr

void setCgmflBrsr(String filename)
           throws NXException,
                  RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

filename -

Throws:

NXException

RemoteException

strAnnot

String strAnnot()
         throws NXException,
                RemoteException

Returns the string to display the name of Pattern file name selected by user.
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

setStrAnnot

void setStrAnnot(String strAnnot)
          throws NXException,
                 RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

strAnnot -

Throws:

NXException

RemoteException

strAnnotFileName

String strAnnotFileName()
                 throws NXException,
                        RemoteException

Returns the string to display the name of CGM name selected by user.
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

setStrAnnotFileName

void setStrAnnotFileName(String strAnnot)
                  throws NXException,
                         RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

strAnnot -

Throws:

NXException

RemoteException

pntOrigin

Point pntOrigin()
         throws NXException,
                RemoteException

Returns the user selected point where geometry will be placed
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setPntOrigin

void setPntOrigin(Point pntOrigin)
           throws NXException,
                  RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

pntOrigin -

Throws:

NXException

RemoteException

destEnum

FaceAnnotationBuilder.DrwDestination destEnum()
                                       throws NXException,
                                              RemoteException

Returns the FaceAnnotationBuilder.DrwDestination selected by user to place the geometry
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

setDestEnum

void setDestEnum(FaceAnnotationBuilder.DrwDestination destEnum)
          throws NXException,
                 RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

destEnum -

Throws:

NXException

RemoteException

togBlank

boolean togBlank()
          throws NXException,
                 RemoteException

Returns the toggle which defines whether the selected component is to be blanked or not
License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

setTogBlank

void setTogBlank(boolean togBlank)
          throws NXException,
                 RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

togBlank -

Throws:

NXException

RemoteException

type

FaceAnnotationBuilder.Types type()
                          throws NXException,
                                 RemoteException

Returns the FaceAnnotationBuilder.Types selected by user
License requirements: routing_harness ("Routing Harness")

Created in NX7.5.0

Throws:

NXException

RemoteException

setType

void setType(FaceAnnotationBuilder.Types type)
      throws NXException,
             RemoteException

License requirements: routing_harness ("Routing Harness")
.
Created in NX7.5.0

Parameters:

type -

Throws:

NXException

RemoteException