Represents a Mechatronics::RuntimeNCBuilder . More...

Inheritance diagram for NXOpen::Mechatronics::RuntimeNCBuilder:

Public Member Functions
void	ExportNCCode (const NXString &ncFile)
	This method is used to export current loaded NC Code to disk file.

void	ExportNCCode (const char *ncFile)
	This method is used to export current loaded NC Code to disk file.

bool	FlagOfUsingContainer ()
	Returns the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not.

bool	FlagOfUsingSpecifiedMCF ()
	Returns the flag which indicates whether use the specified MCF or not.

void	GetAxesAndMachineEvents (std::vector< NXString > &axisNames, std::vector< NXString > &machineEventNames)
	This method is used to get the axes that involved the motion of CSE output event, and the machine event (e.g.

NXOpen::TaggedObject *	GetMCDConnection (bool isAxis, const NXString &axisOrEventName)
	This method is used to get the MCD connected object to the specified axis or machine event.

NXOpen::TaggedObject *	GetMCDConnection (bool isAxis, const char *axisOrEventName)
	This method is used to get the MCD connected object to the specified axis or machine event.

void	LoadNCFile (const NXString &ncFile)
	This method is used to load NC file.

void	LoadNCFile (const char *ncFile)
	This method is used to load NC file.

NXString	Name ()
	Returns the name.

void	RunCSE (bool isRunningOK, NXString errMsg, int lineNum, NXString ncLine)
	This method is used to run NC Code via CSE in order to get output events Created in NX9.0.0.

void	SetFlagOfUsingContainer (bool flagOfUsingContainer)
	Sets the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not.

void	SetFlagOfUsingSpecifiedMCF (bool flagOfUsingSpecifiedMCF)
	Sets the flag which indicates whether use the specified MCF or not.

void	SetMCDConnection (bool isAxis, const NXString &axisOrEventName, NXOpen::TaggedObject *mcdConnectedTag)
	This method is used to set the MCD connected object to the specified axis or machine event Created in NX9.0.0.

void	SetMCDConnection (bool isAxis, const char axisOrEventName, NXOpen::TaggedObject mcdConnectedTag)
	This method is used to set the MCD connected object to the specified axis or machine event Created in NX9.0.0.

void	SetName (const NXString &name)
	Sets the name.

void	SetName (const char *name)
	Sets the name.

void	SetSpecifiedMCF (const NXString &specifiedMCF)
	Sets the user specified MCF File.

void	SetSpecifiedMCF (const char *specifiedMCF)
	Sets the user specified MCF File.

NXString	SpecifiedMCF ()
	Returns the user specified MCF File.

void	UpdateNCCode (std::vector< NXString > &ncCodeLines)
	This method is used to update NC code.

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

Represents a Mechatronics::RuntimeNCBuilder .

<br> To create a new instance of this class, use @link Mechatronics::RuntimeNCCollection::CreateRuntimeNcBuilder  Mechatronics::RuntimeNCCollection::CreateRuntimeNcBuilder @endlink  <br>

Created in NX9.0.0.

Member Function Documentation

void NXOpen::Mechatronics::RuntimeNCBuilder::ExportNCCode ( const NXString & ncFile )

This method is used to export current loaded NC Code to disk file.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ncFile ncfile

void NXOpen::Mechatronics::RuntimeNCBuilder::ExportNCCode ( const char * ncFile )

This method is used to export current loaded NC Code to disk file.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ncFile ncfile

bool NXOpen::Mechatronics::RuntimeNCBuilder::FlagOfUsingContainer ( )

Returns the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not.

       true means put the MCD connected objects to the specific container (creates the container if it is not exist);
       false means restore the MCD connected objects to the original default folder, and remove the 'Runtime NC' container.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Mechatronics::RuntimeNCBuilder::FlagOfUsingSpecifiedMCF ( )

Returns the flag which indicates whether use the specified MCF or not.

       True means use user specified MCF file for running CSE, or use the Standard MCF file in MCD kits.

Created in NX9.0.0.

License requirements : None

void NXOpen::Mechatronics::RuntimeNCBuilder::GetAxesAndMachineEvents	(	std::vector< NXString > &	axisNames,
		std::vector< NXString > &	machineEventNames
	)

This method is used to get the axes that involved the motion of CSE output event, and the machine event (e.g.

ToolChange) that fired by CSE. These axes and machine events are used to connect with MCD objects, so in the MCD simulation stage, the CSE will know which MCD runtime object will be driven.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

axisNames	The axis names which involved in CSE motion.
machineEventNames	The name of events fired by CSE.

NXOpen::TaggedObject* NXOpen::Mechatronics::RuntimeNCBuilder::GetMCDConnection	(	bool	isAxis,
		const NXString &	axisOrEventName
	)

This method is used to get the MCD connected object to the specified axis or machine event.

Returns: MCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isAxis	Flag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventName	Axis or machine event name.

NXOpen::TaggedObject* NXOpen::Mechatronics::RuntimeNCBuilder::GetMCDConnection	(	bool	isAxis,
		const char *	axisOrEventName
	)

This method is used to get the MCD connected object to the specified axis or machine event.

Returns: MCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isAxis	Flag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventName	Axis or machine event name.

void NXOpen::Mechatronics::RuntimeNCBuilder::LoadNCFile ( const NXString & ncFile )

This method is used to load NC file.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ncFile ncfile

void NXOpen::Mechatronics::RuntimeNCBuilder::LoadNCFile ( const char * ncFile )

This method is used to load NC file.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ncFile ncfile

NXString NXOpen::Mechatronics::RuntimeNCBuilder::Name ( )

Returns the name.

Created in NX9.0.0.

License requirements : None

void NXOpen::Mechatronics::RuntimeNCBuilder::RunCSE	(	bool *	isRunningOK,
		NXString *	errMsg,
		int *	lineNum,
		NXString *	ncLine
	)

This method is used to run NC Code via CSE in order to get output events
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isRunningOK	True means CSE returns succeed result, or failure.
errMsg	Error message if CSE return false.
lineNum	The NC line number at which CSE failed.
ncLine	The NC Code for which CSE failed.

void NXOpen::Mechatronics::RuntimeNCBuilder::SetFlagOfUsingContainer ( bool flagOfUsingContainer )

Sets the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not.

       true means put the MCD connected objects to the specific container (creates the container if it is not exist);
       false means restore the MCD connected objects to the original default folder, and remove the 'Runtime NC' container.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

flagOfUsingContainer flagofusingcontainer

void NXOpen::Mechatronics::RuntimeNCBuilder::SetFlagOfUsingSpecifiedMCF ( bool flagOfUsingSpecifiedMCF )

Sets the flag which indicates whether use the specified MCF or not.

       True means use user specified MCF file for running CSE, or use the Standard MCF file in MCD kits.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

flagOfUsingSpecifiedMCF flagofusingspecifiedmcf

void NXOpen::Mechatronics::RuntimeNCBuilder::SetMCDConnection	(	bool	isAxis,
		const NXString &	axisOrEventName,
		NXOpen::TaggedObject *	mcdConnectedTag
	)

This method is used to set the MCD connected object to the specified axis or machine event
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isAxis	Flag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventName	Axis or machine event name.
mcdConnectedTag	MCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.

void NXOpen::Mechatronics::RuntimeNCBuilder::SetMCDConnection	(	bool	isAxis,
		const char *	axisOrEventName,
		NXOpen::TaggedObject *	mcdConnectedTag
	)

This method is used to set the MCD connected object to the specified axis or machine event
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isAxis	Flag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventName	Axis or machine event name.
mcdConnectedTag	MCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.

void NXOpen::Mechatronics::RuntimeNCBuilder::SetName ( const NXString & name )

Sets the name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::RuntimeNCBuilder::SetName ( const char * name )

Sets the name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::RuntimeNCBuilder::SetSpecifiedMCF ( const NXString & specifiedMCF )

Sets the user specified MCF File.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

specifiedMCF specifiedmcf

void NXOpen::Mechatronics::RuntimeNCBuilder::SetSpecifiedMCF ( const char * specifiedMCF )

Sets the user specified MCF File.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

specifiedMCF specifiedmcf

NXString NXOpen::Mechatronics::RuntimeNCBuilder::SpecifiedMCF ( )

Returns the user specified MCF File.

Created in NX9.0.0.

License requirements : None

void NXOpen::Mechatronics::RuntimeNCBuilder::UpdateNCCode ( std::vector< NXString > & ncCodeLines )

This method is used to update NC code.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ncCodeLines nccodelines

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

Mechatronics_RuntimeNCBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation