This class is used for export a spf file. More...

Inheritance diagram for NXOpen::SIM::SinumerikCaExportBuilder:

Public Member Functions
int	ChainElementIndex ()
	Returns the index used by chain elements when exporting the SPF file Created in NX9.0.0.

int	CollisionPairIndex ()
	Returns the index used when exporting collision pairs to the SPF file Created in NX9.0.0.

bool	DeleteChainsAtStart ()
	Returns the flag which determines if chains are deleted at the beginning of the export Created in NX9.0.0.

void	ExportSpf (const NXString &targetNode)
	Export to Sinumerik Spf file Created in NX9.0.0.

void	ExportSpf (const char *targetNode)
	Export to Sinumerik Spf file Created in NX9.0.0.

NXString	FileName ()
	Returns the output filename of the SPF file Created in NX9.0.0.

bool	ListOutput ()
	Returns the flag which determines if the output is printed to a listing window Created in NX9.0.0.

int	ProtectionAreaElementIndex ()
	Returns the index used when exporting protection area elements to the SPF file Created in NX9.0.0.

int	ProtectionAreaIndex ()
	Returns the index used when exporting protection areas to the SPF file Created in NX9.0.0.

void	SetChainElementIndex (int index)
	Sets the index used by chain elements when exporting the SPF file Created in NX9.0.0.

void	SetCollisionPairIndex (int index)
	Sets the index used when exporting collision pairs to the SPF file Created in NX9.0.0.

void	SetDeleteChainsAtStart (bool deleteChainsAtStart)
	Sets the flag which determines if chains are deleted at the beginning of the export Created in NX9.0.0.

void	SetFileName (const NXString &name)
	Sets the output filename of the SPF file Created in NX9.0.0.

void	SetFileName (const char *name)
	Sets the output filename of the SPF file Created in NX9.0.0.

void	SetListOutput (bool output)
	Sets the flag which determines if the output is printed to a listing window Created in NX9.0.0.

void	SetProtectionAreaElementIndex (int index)
	Sets the index used when exporting protection area elements to the SPF file Created in NX9.0.0.

void	SetProtectionAreaIndex (int index)
	Sets the index used when exporting protection areas to the SPF file Created in NX9.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class is used for export a spf file.

   A call to @link SinumerikCaExportBuilder::ExportSpf  SinumerikCaExportBuilder::ExportSpf @endlink  is used to export a spf file.
   Calling @link Builder::Commit Builder::Commit@endlink  on this builder will only return NULL.
<br> Use the @link Part Part@endlink  class to create a SinumerikCaExportBuilder object.  <br>

Created in NX9.0.0.

Member Function Documentation

int NXOpen::SIM::SinumerikCaExportBuilder::ChainElementIndex ( )

Returns the index used by chain elements when exporting the SPF file
Created in NX9.0.0.

License requirements : None

int NXOpen::SIM::SinumerikCaExportBuilder::CollisionPairIndex ( )

Returns the index used when exporting collision pairs to the SPF file
Created in NX9.0.0.

License requirements : None

bool NXOpen::SIM::SinumerikCaExportBuilder::DeleteChainsAtStart ( )

Returns the flag which determines if chains are deleted at the beginning of the export
Created in NX9.0.0.

License requirements : None

void NXOpen::SIM::SinumerikCaExportBuilder::ExportSpf ( const NXString & targetNode )

Export to Sinumerik Spf file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

targetNode The name of the node to export to
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::SIM::SinumerikCaExportBuilder::ExportSpf ( const char * targetNode )

Export to Sinumerik Spf file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

targetNode The name of the node to export to
NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::SIM::SinumerikCaExportBuilder::FileName ( )

Returns the output filename of the SPF file
Created in NX9.0.0.

License requirements : None

bool NXOpen::SIM::SinumerikCaExportBuilder::ListOutput ( )

Returns the flag which determines if the output is printed to a listing window
Created in NX9.0.0.

License requirements : None

int NXOpen::SIM::SinumerikCaExportBuilder::ProtectionAreaElementIndex ( )

Returns the index used when exporting protection area elements to the SPF file
Created in NX9.0.0.

License requirements : None

int NXOpen::SIM::SinumerikCaExportBuilder::ProtectionAreaIndex ( )

Returns the index used when exporting protection areas to the SPF file
Created in NX9.0.0.

License requirements : None

void NXOpen::SIM::SinumerikCaExportBuilder::SetChainElementIndex ( int index )

Sets the index used by chain elements when exporting the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

index index

void NXOpen::SIM::SinumerikCaExportBuilder::SetCollisionPairIndex ( int index )

Sets the index used when exporting collision pairs to the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

index index

void NXOpen::SIM::SinumerikCaExportBuilder::SetDeleteChainsAtStart ( bool deleteChainsAtStart )

Sets the flag which determines if chains are deleted at the beginning of the export
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

deleteChainsAtStart deletechainsatstart

void NXOpen::SIM::SinumerikCaExportBuilder::SetFileName ( const NXString & name )

Sets the output filename of the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

name	the output new name

void NXOpen::SIM::SinumerikCaExportBuilder::SetFileName ( const char * name )

Sets the output filename of the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

name	the output new name

void NXOpen::SIM::SinumerikCaExportBuilder::SetListOutput ( bool output )

Sets the flag which determines if the output is printed to a listing window
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

output output

void NXOpen::SIM::SinumerikCaExportBuilder::SetProtectionAreaElementIndex ( int index )

Sets the index used when exporting protection area elements to the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

index index

void NXOpen::SIM::SinumerikCaExportBuilder::SetProtectionAreaIndex ( int index )

Sets the index used when exporting protection areas to the SPF file
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

index index

The documentation for this class was generated from the following file:

SIM_SinumerikCaExportBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation