This class is used for edit sinumerik collision avoidance properties. More...

Inheritance diagram for NXOpen::SIM::KinematicSinumerikCaBuilder:

Public Types
enum	PlcInitStateTypes { PlcInitStateTypesActive, PlcInitStateTypesInactive, PlcInitStateTypesPreselect }
	The init state types. More...

enum	PlcUsageTypes { PlcUsageTypesCollisionCheck, PlcUsageTypesVisualize, PlcUsageTypesAll }
	The usage types. More...

Public Member Functions
int	DetailLevel ()
	Returns the detail level for this protection area Created in NX9.0.0.

int	PlcBit ()
	Returns the PLC bit for this protection area Created in NX9.0.0.

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes	PlcInitState ()
	Returns the initial PLC state for this protection area Created in NX9.0.0.

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes	PlcUsage ()
	Returns the PLC usage for this protection area Created in NX9.0.0.

void	SetDetailLevel (int level)
	Sets the detail level for this protection area Created in NX9.0.0.

void	SetPlcBit (int bit)
	Sets the PLC bit for this protection area Created in NX9.0.0.

void	SetPlcInitState (NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes state)
	Sets the initial PLC state for this protection area Created in NX9.0.0.

void	SetPlcUsage (NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes usage)
	Sets the PLC usage for this protection area 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 edit sinumerik collision avoidance properties.

   Calling @link Builder::Commit Builder::Commit@endlink  on this builder will only return NULL.
<br> Use the @link KinematicConfigurator KinematicConfigurator@endlink  class to create a KinematicSinumerikCaBuilder object.  <br>

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes

The init state types.

Enumerator:

PlcInitStateTypesActive	Active.
PlcInitStateTypesInactive	Inactive.
PlcInitStateTypesPreselect	Preselect.

enum NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes

The usage types.

Enumerator:

PlcUsageTypesCollisionCheck	Collision Check.
PlcUsageTypesVisualize	Visualize.
PlcUsageTypesAll	All.

Member Function Documentation

int NXOpen::SIM::KinematicSinumerikCaBuilder::DetailLevel ( )

Returns the detail level for this protection area
Created in NX9.0.0.

License requirements : None

int NXOpen::SIM::KinematicSinumerikCaBuilder::PlcBit ( )

Returns the PLC bit for this protection area
Created in NX9.0.0.

License requirements : None

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitState ( )

Returns the initial PLC state for this protection area
Created in NX9.0.0.

License requirements : None

NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsage ( )

Returns the PLC usage for this protection area
Created in NX9.0.0.

License requirements : None

void NXOpen::SIM::KinematicSinumerikCaBuilder::SetDetailLevel ( int level )

Sets the detail level for this protection area
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

level the detail value value 0-3

void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcBit ( int bit )

Sets the PLC bit for this protection area
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

bit	the plc bit value 0-63

void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcInitState ( NXOpen::SIM::KinematicSinumerikCaBuilder::PlcInitStateTypes state )

Sets the initial PLC state for this protection area
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

state the init state

void NXOpen::SIM::KinematicSinumerikCaBuilder::SetPlcUsage ( NXOpen::SIM::KinematicSinumerikCaBuilder::PlcUsageTypes usage )

Sets the PLC usage for this protection area
Created in NX9.0.0.

License requirements : nx_sinumerik_ca ("Sinumerik Collision Avoidance")

Parameters

usage the usage

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

SIM_KinematicSinumerikCaBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation