NXOpen::Preferences::SessionMeasureRequirements Class Reference

Represents the two options available on the Measure Requirements toolbar and applicable to the entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX5.0.0. More...

Public Types
enum	ActionOnViolation { ActionOnViolationHightlightMeasure, ActionOnViolationStopPlayback }
	Values for the action to take when a requirement error is generated for a measure with a displayed annotation in Assembly Sequencing. More...

Public Member Functions
void	SetUpdateFrameRate (int frameRate)
	Sets the frame rate. More...
void	SetViolationAction (NXOpen::Preferences::SessionMeasureRequirements::ActionOnViolation violationAction)
	Sets the violation action. More...
tag_t	Tag () const
	Returns the tag of this object. More...
int	UpdateFrameRate ()
	Returns the frame rate. More...
NXOpen::Preferences::SessionMeasureRequirements::ActionOnViolation	ViolationAction ()
	Returns the violation action. More...

Detailed Description

Represents the two options available on the Measure Requirements toolbar and applicable to the entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::SessionMeasureRequirements::ActionOnViolation

Values for the action to take when a requirement error is generated for a measure with a displayed annotation in Assembly Sequencing.

Enumerator
ActionOnViolationHightlightMeasure	Highlight (color) measure for requirements violations.
ActionOnViolationStopPlayback	Suspend playback and wait for acknowledgement for requirements violations.

Member Function Documentation

void NXOpen::Preferences::SessionMeasureRequirements::SetUpdateFrameRate

(

int

frameRate

)

Sets the frame rate.

The frame rate specifies how frequently a displayed measure annotation is updated in Assembly Sequencing. So a rate of 1 specifies that the annotation will update every frame during playback. A rate of 5 specifies that the annotation will update every fifth frame during playback.
Created in NX5.0.0.

License requirements : None

Parameters

frameRate

an integer > 0

void NXOpen::Preferences::SessionMeasureRequirements::SetViolationAction

(

NXOpen::Preferences::SessionMeasureRequirements::ActionOnViolation

violationAction

)

Sets the violation action.

The violation action is one of the enumerated type values.
Created in NX5.0.0.

License requirements : None

Parameters

violationAction

violation action

tag_t NXOpen::Preferences::SessionMeasureRequirements::Tag

(

)

const

Returns the tag of this object.

int NXOpen::Preferences::SessionMeasureRequirements::UpdateFrameRate

(

)

Returns the frame rate.

The frame rate specifies how frequently a displayed measure annotation is updated in Assembly Sequencing. So a rate of 1 specifies that the annotation will update every frame during playback. A rate of 5 specifies that the annotation will update every fifth frame during playback.
Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::SessionMeasureRequirements::ActionOnViolation NXOpen::Preferences::SessionMeasureRequirements::ViolationAction

(

)

Returns the violation action.

The violation action is one of the enumerated type values.
Created in NX5.0.0.

License requirements : None

---

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

• Preferences_SessionMeasureRequirements.hxx