pycatia.fitting_interfaces.sampled

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.fitting_interfaces.sampled.Sampled(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
Sampled

The interface to access a CATIASampled based object.
The Sampled class defines characteristics for simulatable tasks within DMU
Fitting. CATIASampled is the parent class for tracks. Key samples are recorded
(as shots or CATIAShots) for an object and then during simulation the object is
interpolated with these shots over time.
append(i_tracks: tuple) → Sampled

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Append(CATSafeArrayVariant iTracks) As Sampled

Returns or sets the Sampled object.
Parameters:

i_tracks (tuple) –

Return type:

Sampled

bind_analysis(i_object: AnyObject, i_analysis_mode: int, i_monitor_mode: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub BindAnalysis(CATBaseDispatch iObject,
CatSampledAnalysisMode iAnalysisMode,
boolean iMonitorMode)

Add (bind) an analysis object to a Track.

Parameters:

iObject
The analysis to add (bind) to the Track
iAnalysisMode
Indicates the analysis status for iAnalysis CatSampledAnalysisOff
CatSampledAnalysisOn, CatSampledAnalysisStop CatSampledAnalysisVerbose

iMonitorMode
Indicates the monitor status for iAnalysis - Off (0) or On
(1)
Parameters:

  • i_object (AnyObject) –

  • i_analysis_mode (int) – enum cat_sampled_analysis_mode

  • i_monitor_mode (bool) –

Return type:

None

break_inheritance() → None

Note

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

Returns or sets the Sampled object.
Return type:

None

get_known_interpolaters(o_interpolaters: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetKnownInterpolaters(CATSafeArrayVariant
oInterpolaters)

Returns or sets the Sampled object.
Parameters:

o_interpolaters (tuple) –

Return type:

None

get_total_duration() → float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetTotalDuration() As double

Returns the total duration
Return type:

float

property interpolater: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Interpolater() As CATBSTR

Retrieves/sets the sampled’s interpolater. Role: Retrieves/sets the
interpolator used by the sampled during simulation. Note that the name of the
interpolater is used (which is a string).
Return type:

str

property object: AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Object() As CATBaseDispatch

Returns or sets the Sampled object. Role:/b> Retrieves/stores the object
that will be used in the sampled based simulation. Please note that the object
will move to the shots defined in the sampled.
Return type:

AnyObject

remove_analyses() → None

Note

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

Returns or sets the Sampled object.
Return type:

None

reverse_time() → None

Note

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

Returns or sets the Sampled object.
Return type:

None

property scaling: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Scaling() As double

Returns or sets the Sampled object.
Return type:

float

set_object_keeping_position(i_object: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetObjectKeepingPosition(CATBaseDispatch iObject)

Sets the object in the sampled. Role: Stores the object that will be used
in the sampled based simulation. The object will not move and the sample’s
shots will be repositioned relative to the object position.
Parameters:

i_object (AnyObject) –

Return type:

None

property shots: Shots

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Shots() As Shots (Read Only)

Returns or sets the Sampled object.
Return type:

Shots

split(i_type: int, i_indice: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Split(CatSampledSplitType iType,
short iIndice)

Returns or sets the Sampled object.
Parameters:

  • i_type (int) – enum cat_sampled_split_type

  • i_indice (int) –

Return type:

None

property time: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Time() As double

Retrieves/sets the sampled’s time. Role: Retrieves/sets the internal time
associated to the current sampled object. Note that the time is handled as a
double.
Return type:

float