SignalChartBuilder Class

class NXOpen.Motion.SignalChartBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.SignalChartBuilder

To create a new instance of this class, use NXOpen.Motion.SignalChartCollection.CreateSignalChartBuilder()

New in version NX6.0.0.

Properties

Property Description
ClosedSignalList Returns the closed siganl list
DisplayScale Returns or sets the icon display scale
GroupName Returns or sets the group name
GroupType Returns or sets the group type
InitialSignal Returns or sets the initial Signal
InitialSignalExpression Returns the initial Signal Expression
Name Returns or sets the name
OpenSignalFunction Returns or sets the open signal function
SignalChartType Returns or sets the SignalChart type
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
NewListItem Creates a new list item @return
NewListItemExpression Creates a new list item including expression @return
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SignalChartBuilderType Enumeration SignalChart type

Property Detail

ClosedSignalList

SignalChartBuilder.ClosedSignalList

Returns the closed siganl list

-------------------------------------

Getter Method

Signature ClosedSignalList()

Returns:
Return type:NXOpen.Motion.SignalChartListItemList

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

InitialSignal

SignalChartBuilder.InitialSignal

Returns or sets the initial Signal

-------------------------------------

Getter Method

Signature InitialSignal()

Returns:
Return type:float

New in version NX6.0.0.

Deprecated since version NX8.5.0: Obtain the expression using NXOpen.Motion.SignalChartBuilder.InitialSignalExpression() to query or edit it.

License requirements: nx_motion_motor (“NX Motion Motor”)

-------------------------------------

Setter Method

Signature InitialSignal(initialSignal)

Parameters:initialSignal (float) –

New in version NX6.0.0.

Deprecated since version NX8.5.0: Obtain the expression using NXOpen.Motion.SignalChartBuilder.InitialSignalExpression() to query or edit it.

License requirements: nx_motion_motor (“NX Motion Motor”)

InitialSignalExpression

SignalChartBuilder.InitialSignalExpression

Returns the initial Signal Expression

-------------------------------------

Getter Method

Signature InitialSignalExpression()

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

Name

SignalChartBuilder.Name

Returns or sets the name

-------------------------------------

Getter Method

Signature Name()

Returns:
Return type:str

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

-------------------------------------

Setter Method

Signature Name(name)

Parameters:name (str) –

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

OpenSignalFunction

SignalChartBuilder.OpenSignalFunction

Returns or sets the open signal function

-------------------------------------

Getter Method

Signature OpenSignalFunction()

Returns:
Return type:NXOpen.CAE.Function

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

-------------------------------------

Setter Method

Signature OpenSignalFunction(openSignalFunction)

Parameters:openSignalFunction (NXOpen.CAE.Function) –

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

SignalChartType

SignalChartBuilder.SignalChartType

Returns or sets the SignalChart type

-------------------------------------

Getter Method

Signature SignalChartType()

Returns:
Return type:NXOpen.Motion.SignalChartBuilderType

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

-------------------------------------

Setter Method

Signature SignalChartType(signalchartType)

Parameters:signalchartType (NXOpen.Motion.SignalChartBuilderType) –

New in version NX6.0.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

Method Detail

NewListItem

SignalChartBuilder.NewListItem

Creates a new list item

Signature NewListItem(sensor, alwaysEvaluated, timeSensor, condition, threshold, delayTime, signal)

Parameters:
  • sensor (NXOpen.Motion.MotionSensor) – sensor
  • alwaysEvaluated (bool) – always evaluted
  • timeSensor (int) – time sensor
  • condition (int) – condition
  • threshold (float) – threshold
  • delayTime (float) – delay time
  • signal (float) – signal
Returns:
Return type:

NXOpen.Motion.SignalChartListItem

New in version NX6.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Motion.SignalChartBuilder.NewListItemExpression() instead.

License requirements: nx_motion_motor (“NX Motion Motor”)

NewListItemExpression

SignalChartBuilder.NewListItemExpression

Creates a new list item including expression

Signature NewListItemExpression(sensor, alwaysEvaluated, timeSensor, condition, threshold, delayTime, signal)

Parameters:
Returns:
Return type:

NXOpen.Motion.SignalChartListItem

New in version NX8.5.0.

License requirements: nx_motion_motor (“NX Motion Motor”)

Validate

SignalChartBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.