bsk 2.8.24__cp38-abi3-win_amd64.whl → 2.8.25__cp38-abi3-win_amd64.whl

Basilisk/simulation/linearTranslationNDOFStateEffector.py

@@ -212,6 +212,54 @@ def protectAllClasses(moduleType):
 
 
 
+import sys
+from Basilisk.utilities import deprecated
+
+class _DeprecatedWrapper:
+    def __init__(self, target, aliasName=None,
+                               targetName=None,
+                               deprecatedFields=None,
+                               typeConversion=None,
+                               removalDate=None):
+        self._target = target
+        self._aliasName = aliasName
+        self._targetName = targetName
+        self._deprecatedFields = deprecatedFields or {}
+        self._typeConversion = typeConversion
+        self._removalDate = removalDate
+
+    def __call__(self, *args, **kwargs):
+        if self._aliasName:
+            deprecated.deprecationWarn(self._aliasName, self._removalDate, f"Use '{self._targetName}' instead.")
+
+        instance = self._target(*args, **kwargs)
+
+        for old_attr, new_attr in self._deprecatedFields.items():
+            if hasattr(instance, new_attr):  # Ensure new attribute exists
+                _inject_deprecated_property(instance, old_attr, new_attr, self._removalDate, self._typeConversion)
+
+        return instance  # Always return the original instance
+
+def _inject_deprecated_property(instance, old_attr, new_attr, removal_date, typeConversion=None):
+    def getter(self):
+        deprecated.deprecationWarn(old_attr, removal_date, f"Use '{new_attr}' instead.")
+        return getattr(self, new_attr)
+
+    def setter(self, value):
+        deprecated.deprecationWarn(old_attr, removal_date, f"Use '{new_attr}' instead.")
+# Conduct type conversions if new variable type is changed
+        if typeConversion and typeConversion == "scalarTo3D":
+            setattr(self, new_attr, [value, value, value])
+        elif typeConversion and typeConversion == "useDefaultDouble":
+            setattr(self, new_attr, -1.0)
+        else:
+            setattr(self, new_attr, value)
+
+    setattr(instance.__class__, old_attr, property(getter, setter))
+
+
+SHARED_PTR_DISOWN = _linearTranslationNDOFStateEffector.SHARED_PTR_DISOWN
+
 from Basilisk.architecture.swig_common_model import *
 
 MAX_LOGGING_LENGTH = _linearTranslationNDOFStateEffector.MAX_LOGGING_LENGTH
@@ -615,106 +663,109 @@ class StateEffector(object):
 
 # Register StateEffector in _linearTranslationNDOFStateEffector:
 _linearTranslationNDOFStateEffector.StateEffector_swigregister(StateEffector)
-class translatingBody(object):
+class TranslatingBody(object):
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
     __repr__ = _swig_repr
 
     def setMass(self, mass):
-        return _linearTranslationNDOFStateEffector.translatingBody_setMass(self, mass)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setMass(self, mass)
 
     def setK(self, k):
-        return _linearTranslationNDOFStateEffector.translatingBody_setK(self, k)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setK(self, k)
 
     def setC(self, c):
-        return _linearTranslationNDOFStateEffector.translatingBody_setC(self, c)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setC(self, c)
 
     def setRhoInit(self, rhoInit):
-        return _linearTranslationNDOFStateEffector.translatingBody_setRhoInit(self, rhoInit)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setRhoInit(self, rhoInit)
 
     def setRhoDotInit(self, rhoDotInit):
-        return _linearTranslationNDOFStateEffector.translatingBody_setRhoDotInit(self, rhoDotInit)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setRhoDotInit(self, rhoDotInit)
 
     def setFHat_P(self, fHat_P):
-        return _linearTranslationNDOFStateEffector.translatingBody_setFHat_P(self, fHat_P)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setFHat_P(self, fHat_P)
 
     def setR_FcF_F(self, r_FcF_F):
-        return _linearTranslationNDOFStateEffector.translatingBody_setR_FcF_F(self, r_FcF_F)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setR_FcF_F(self, r_FcF_F)
 
     def setR_F0P_P(self, r_F0P_P):
-        return _linearTranslationNDOFStateEffector.translatingBody_setR_F0P_P(self, r_F0P_P)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setR_F0P_P(self, r_F0P_P)
 
     def setIPntFc_F(self, IPntFc_F):
-        return _linearTranslationNDOFStateEffector.translatingBody_setIPntFc_F(self, IPntFc_F)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setIPntFc_F(self, IPntFc_F)
 
     def setDCM_FP(self, dcm_FP):
-        return _linearTranslationNDOFStateEffector.translatingBody_setDCM_FP(self, dcm_FP)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_setDCM_FP(self, dcm_FP)
 
     def getMass(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getMass(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getMass(self)
 
     def getK(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getK(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getK(self)
 
     def getC(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getC(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getC(self)
 
     def getRhoInit(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getRhoInit(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getRhoInit(self)
 
     def getRhoDotInit(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getRhoDotInit(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getRhoDotInit(self)
 
     def getFHat_P(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getFHat_P(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getFHat_P(self)
 
     def getR_FcF_F(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getR_FcF_F(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getR_FcF_F(self)
 
     def getR_F0P_P(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getR_F0P_P(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getR_F0P_P(self)
 
     def getIPntFc_F(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getIPntFc_F(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getIPntFc_F(self)
 
     def getDCM_FP(self):
-        return _linearTranslationNDOFStateEffector.translatingBody_getDCM_FP(self)
+        return _linearTranslationNDOFStateEffector.TranslatingBody_getDCM_FP(self)
 
     def __init__(self):
-        _linearTranslationNDOFStateEffector.translatingBody_swiginit(self, _linearTranslationNDOFStateEffector.new_translatingBody())
-    __swig_destroy__ = _linearTranslationNDOFStateEffector.delete_translatingBody
+        _linearTranslationNDOFStateEffector.TranslatingBody_swiginit(self, _linearTranslationNDOFStateEffector.new_TranslatingBody())
+    __swig_destroy__ = _linearTranslationNDOFStateEffector.delete_TranslatingBody
 
-# Register translatingBody in _linearTranslationNDOFStateEffector:
-_linearTranslationNDOFStateEffector.translatingBody_swigregister(translatingBody)
-class linearTranslationNDOFStateEffector(StateEffector, SysModel):
+# Register TranslatingBody in _linearTranslationNDOFStateEffector:
+_linearTranslationNDOFStateEffector.TranslatingBody_swigregister(TranslatingBody)
+class LinearTranslationNDOFStateEffector(StateEffector, SysModel):
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
     __repr__ = _swig_repr
 
     def __init__(self):
-        _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_swiginit(self, _linearTranslationNDOFStateEffector.new_linearTranslationNDOFStateEffector())
-    __swig_destroy__ = _linearTranslationNDOFStateEffector.delete_linearTranslationNDOFStateEffector
-    translatingBodyOutMsgs = property(_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyOutMsgs_get, _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyOutMsgs_set)
-    translatingBodyConfigLogOutMsgs = property(_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyConfigLogOutMsgs_get, _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyConfigLogOutMsgs_set)
-    translatingBodyRefInMsgs = property(_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyRefInMsgs_get, _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_translatingBodyRefInMsgs_set)
-    motorForceInMsg = property(_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_motorForceInMsg_get, _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_motorForceInMsg_set)
-    motorLockInMsg = property(_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_motorLockInMsg_get, _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_motorLockInMsg_set)
+        _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_swiginit(self, _linearTranslationNDOFStateEffector.new_LinearTranslationNDOFStateEffector())
+    __swig_destroy__ = _linearTranslationNDOFStateEffector.delete_LinearTranslationNDOFStateEffector
+    translatingBodyOutMsgs = property(_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyOutMsgs_get, _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyOutMsgs_set)
+    translatingBodyConfigLogOutMsgs = property(_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyConfigLogOutMsgs_get, _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyConfigLogOutMsgs_set)
+    translatingBodyRefInMsgs = property(_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyRefInMsgs_get, _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_translatingBodyRefInMsgs_set)
+    motorForceInMsg = property(_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_motorForceInMsg_get, _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_motorForceInMsg_set)
+    motorLockInMsg = property(_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_motorLockInMsg_get, _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_motorLockInMsg_set)
 
     def addTranslatingBody(self, newBody):
-        return _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_addTranslatingBody(self, newBody)
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_addTranslatingBody(self, newBody)
+
+    def getTranslatingBody(self, index):
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_getTranslatingBody(self, index)
 
     def setNameOfRhoState(self, nameOfRhoState):
-        return _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_setNameOfRhoState(self, nameOfRhoState)
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_setNameOfRhoState(self, nameOfRhoState)
 
     def setNameOfRhoDotState(self, nameOfRhoDotState):
-        return _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_setNameOfRhoDotState(self, nameOfRhoDotState)
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_setNameOfRhoDotState(self, nameOfRhoDotState)
 
     def getNameOfRhoState(self):
-        return _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_getNameOfRhoState(self)
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_getNameOfRhoState(self)
 
     def getNameOfRhoDotState(self):
-        return _linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_getNameOfRhoDotState(self)
+        return _linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_getNameOfRhoDotState(self)
 
-# Register linearTranslationNDOFStateEffector in _linearTranslationNDOFStateEffector:
-_linearTranslationNDOFStateEffector.linearTranslationNDOFStateEffector_swigregister(linearTranslationNDOFStateEffector)
+# Register LinearTranslationNDOFStateEffector in _linearTranslationNDOFStateEffector:
+_linearTranslationNDOFStateEffector.LinearTranslationNDOFStateEffector_swigregister(LinearTranslationNDOFStateEffector)
 class SCStatesMsgPayload(object):
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
     __repr__ = _swig_repr
@@ -773,6 +824,23 @@ class LinearTranslationRigidBodyMsgPayload(object):
 _linearTranslationNDOFStateEffector.LinearTranslationRigidBodyMsgPayload_swigregister(LinearTranslationRigidBodyMsgPayload)
 
 import sys
+
+mod = sys.modules[__name__]
+
+mod.linearTranslationNDOFStateEffector = _DeprecatedWrapper(
+        mod.LinearTranslationNDOFStateEffector,
+        aliasName="linearTranslationNDOFStateEffector",
+        targetName="LinearTranslationNDOFStateEffector",
+        removalDate="2026/10/15"
+)
+
+mod.translatingBody = _DeprecatedWrapper(
+        mod.TranslatingBody,
+        aliasName="translatingBody",
+        targetName="TranslatingBody",
+        removalDate="2026/10/15"
+)
+
 protectAllClasses(sys.modules[__name__])