nxopen.sim

Interface SinumerikCaExportBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface SinumerikCaExportBuilder
extends Builder

This class is used for export a spf file. A call to exportSpf(java.lang.String) is used to export a spf file. Calling Builder.commit() on this builder will only return null.
Use the Part class to create a SinumerikCaExportBuilder object.

Created in NX9.0.0

Method Summary

Modifier and Type	Method and Description
int	chainElementIndex() Returns the index used by chain elements when exporting the SPF file License requirements: None.
int	collisionPairIndex() Returns the index used when exporting collision pairs to the SPF file License requirements: None.
boolean	deleteChainsAtStart() Returns the flag which determines if chains are deleted at the beginning of the export License requirements: None.
void	exportSpf(String targetNode) Export to Sinumerik Spf file License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
String	fileName() Returns the output filename of the SPF file License requirements: None.
boolean	listOutput() Returns the flag which determines if the output is printed to a listing window License requirements: None.
int	protectionAreaElementIndex() Returns the index used when exporting protection area elements to the SPF file License requirements: None.
int	protectionAreaIndex() Returns the index used when exporting protection areas to the SPF file License requirements: None.
void	setChainElementIndex(int index) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setCollisionPairIndex(int index) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setDeleteChainsAtStart(boolean deleteChainsAtStart) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setFileName(String name) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setListOutput(boolean output) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setProtectionAreaElementIndex(int index) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .
void	setProtectionAreaIndex(int index) License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance") .

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

chainElementIndex

int chainElementIndex()
               throws NXException,
                      RemoteException

Returns the index used by chain elements when exporting the SPF file
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setChainElementIndex

void setChainElementIndex(int index)
                   throws NXException,
                          RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

index -

Throws:

NXException

RemoteException

collisionPairIndex

int collisionPairIndex()
                throws NXException,
                       RemoteException

Returns the index used when exporting collision pairs to the SPF file
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setCollisionPairIndex

void setCollisionPairIndex(int index)
                    throws NXException,
                           RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

index -

Throws:

NXException

RemoteException

protectionAreaElementIndex

int protectionAreaElementIndex()
                        throws NXException,
                               RemoteException

Returns the index used when exporting protection area elements to the SPF file
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setProtectionAreaElementIndex

void setProtectionAreaElementIndex(int index)
                            throws NXException,
                                   RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

index -

Throws:

NXException

RemoteException

protectionAreaIndex

int protectionAreaIndex()
                 throws NXException,
                        RemoteException

Returns the index used when exporting protection areas to the SPF file
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setProtectionAreaIndex

void setProtectionAreaIndex(int index)
                     throws NXException,
                            RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

index -

Throws:

NXException

RemoteException

fileName

String fileName()
         throws NXException,
                RemoteException

Returns the output filename of the SPF file
License requirements: None.

Created in NX9.0.0

Returns:

The output name

Throws:

NXException

RemoteException

setFileName

void setFileName(String name)
          throws NXException,
                 RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

name - the output new name

Throws:

NXException

RemoteException

listOutput

boolean listOutput()
            throws NXException,
                   RemoteException

Returns the flag which determines if the output is printed to a listing window
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setListOutput

void setListOutput(boolean output)
            throws NXException,
                   RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

output -

Throws:

NXException

RemoteException

deleteChainsAtStart

boolean deleteChainsAtStart()
                     throws NXException,
                            RemoteException

Returns the flag which determines if chains are deleted at the beginning of the export
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setDeleteChainsAtStart

void setDeleteChainsAtStart(boolean deleteChainsAtStart)
                     throws NXException,
                            RemoteException

License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

deleteChainsAtStart -

Throws:

NXException

RemoteException

exportSpf

void exportSpf(String targetNode)
        throws NXException,
               RemoteException

Export to Sinumerik Spf file
License requirements: nx_sinumerik_ca ("Sinumerik Collision Avoidance")
.
Created in NX9.0.0

Parameters:

targetNode - The name of the node to export to

Throws:

NXException

RemoteException