pycatia.dnb_human_modeling_interfaces.swkdof

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_human_modeling_interfaces.swkdof.SWKDOF(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

DNBHumanModelingInterfaces.SWKManikinPart

SWKDOF

This interface deals with a degree of freedom (DOF) of a

manikin.

property default_value: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property DefaultValue() As double (Read Only)

Returns the default value of a DOF. The value read is always in radians.

Return type:

float

property full_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property FullName() As CATBSTR (Read Only)

Returns the full name of the degree of freedom (e.g.

“flexion/extension”).

This property is different from the property Name of

AnyObject, which gives the short name or abbreviated name

of the DOF (e.g. “DOF1”).

Return type:

str

property limits_locked: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property LimitsLocked() As boolean

Sets a lock on the limits.

When the value of this property is TRUE, the DOF travel limits are locked,

therefore the min and max values cannot be changed.

When the value is FALSE, the DOF limits are unlocked and can be changed. By

default, the DOF limits are locked and the application must unlock these limits

before changing them.

Return type:

bool

property max_mean: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxMean() As double (Read Only)

Returns the mean value of the upper limit of the DOF (in

radians).

Return type:

float

property max_mean_inter_segment: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxMeanInterSegment() As double (Read Only)

Return type:

float

property max_score: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxScore() As double (Read Only)

Returns the highest score that this DOF can take.

Return type:

float

property max_std_dev: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxStdDev() As double (Read Only)

Returns the standard deviation value of the upper limit of the DOF (in

radians).

Return type:

float

property max_value: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxValue() As double

Returns or sets the highest value that a DOF can take.

When setting the value, the new value given

cannot be higher than the statistical value found

in the limits database. This statistical maximum

value can be obtained by a call to property

StatisticalMaxValue.

Return type:

float

property max_value_as_percentile: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaxValueAsPercentile() As double

Returns or sets the highest value that a DOF can take.

When reading the value, the number returned

will take a percentile format, that is, will

be between 0.0 and 100.0 inclusive.

When setting the value, the new value given

must also lie in the range [ 0.0 ; 100.0 ].

Return type:

float

property min_mean: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinMean() As double (Read Only)

Returns the mean value of the lower limit of the DOF (in

radians).

Return type:

float

property min_mean_inter_segment: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinMeanInterSegment() As double (Read Only)

Return type:

float

property min_std_dev: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinStdDev() As double (Read Only)

Returns the standard deviation value of the lower limit of

the DOF (in radians).

Return type:

float

property min_value: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinValue() As double

Returns or sets the lowest value that a DOF can take.

When setting the value, the new value given

cannot be lower than the statistical value found

in the limits database. This statistical minimum

value can be obtained by a call to property

StatisticalMinValue.

Return type:

float

property min_value_as_percentile: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinValueAsPercentile() As double

Returns or sets the lowest value that a DOF can take.

When reading the value, the number returned

will take a percentile format, that is, will

be between 0.0 and 100.0 exclusive.

When setting the value, the new value given

must also lie in the range [ 0.0 ; 100.0 ].

Return type:

float

property min_value_inter_segment: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinValueInterSegment() As double (Read Only)

Return type:

float

property number: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Number() As long (Read Only)

Returns the number of the DOF. This number is an integer between 0 and

2.

See also:

SWKSegment

Return type:

int

reset_value() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub ResetValue()

Sets the value of the DOF to its default value.

Return type:

None

property score: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Score() As double (Read Only)

Returns the score corresponding to the DOF’s current value.

Return type:

float

set_limits_to_match_best_pref_angle() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetLimitsToMatchBestPrefAngle()

Set the angular limitations to match with the best pref angle. The purpose

of this method is to set the angular limitations of this DOF so that these

limitations correspond to the best range of motion, that is, the range of

motion where the postural score is the highest.

This method travels the different preferred angles on the DOF, then chooses

the one with the highest score. If several preferred angles are found with the

highest score, then the last one with the highest score is

taken.

If no preferred angles have been defined on this DOF, then the angular

limitations are not modified.

Return type:

None

property value: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Value() As double

Returns or sets the value of a DOF.

The value read or set is always in radians.

Return type:

float

property value_as_string: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property ValueAsString() As CATBSTR

Returns or sets the value of a DOF, as a string.

Example:

myManikin.Body.GetSegment(“LSLeTh”).

ValueAsString = “10deg”

Return type:

str

property value_locked: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property ValueLocked() As boolean

Sets a lock on the value.

When the value of this property is TRUE, the DOF’s current value is locked

and cannot be changed.

When this property is set to FALSE, the DOF value is unlocked and can be

changed again. Locking a value on a DOF means that this DOF will ne take any

other value than the current one, and will not be changed by an inverse

kinematics resolution, for instance.

Return type:

bool