57.6 ConnectorFailure object

The ConnectorFailure object defines failure criteria for one or more components of a connector's relative motion.

The ConnectorFailure object is derived from the ConnectorBehaviorOption object.

Access

sectionApi.sections()[name].behaviorOptions(i)

57.6.1 ConnectorFailure(...)

This method creates a connector failure behavior option for a ConnectorSection object.

Path

sectionApi.sections()[name].ConnectorFailure

Prototype

odb_ConnectorFailure&
ConnectorFailure(odb_Union releaseComponent,
                 odb_Union minMotion,
                 odb_Union maxMotion,
                 odb_Union minForce,
                 odb_Union maxForce,
                 const odb_SequenceInt& components);

Required arguments

None.

Optional arguments

releaseComponent

The string "ALL" or an Int specifying the motion components that fail. If an Int is specified, only that motion component fails when the failure criteria are satisfied. If releaseComponent="ALL", all motion components fail. The default value is "ALL".

minMotion

The string "NONE" or a Double specifying the lower bound for the connector's relative position for all specified components, or no lower bound. The default value is "NONE".

maxMotion

The string "NONE" or a Double specifying the upper bound for the connector's relative position for all specified components, or no upper bound. The default value is "NONE".

minForce

The string "NONE" or a Double specifying the lower bound of the force or moment in the directions of the specified components at which locking occurs, or no lower bound. The default value is "NONE".

maxForce

The string "NONE" or a Double specifying the upper bound of the force or moment in the directions of the specified components at which locking occurs, or no upper bound. The default value is "NONE".

components

An odb_SequenceInt specifying the components of relative motion for which the behavior is defined. Possible values are 1 components 6. Only available components can be specified. The default value is an empty sequence.

Return value

A ConnectorFailure object.

Exceptions

ValueError and TextError.

57.6.2 setValues(...)

This method modifies the ConnectorFailure object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the ConnectorFailure method.

Return value

None

Exceptions

ValueError.

57.6.3 Members

The ConnectorFailure object has members with the same names and descriptions as the arguments to the ConnectorFailure method.

57.6.4 Corresponding analysis keywords

*CONNECTOR FAILURE