AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxDriveTrain::deprecated::HighLevelGearBox Class Reference

The gear box can have an arbitrary number of gears. More...

#include <HighLevelDriveTrain.h>

+ Inheritance diagram for agxDriveTrain::deprecated::HighLevelGearBox:

Public Member Functions

 HighLevelGearBox ()
 The only constructor.
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxDriveTrain::deprecated::HighLevelGearBox)
 
agx::Real getIncomingRPM () const
 
agx::Real getRPM () const
 
agx::Real getTorque () const
 Get current load torque.
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxDriveTrain::deprecated::GearBox
 GearBox ()
 Create a gear box.
 
 GearBox (const agx::RealVector &gears)
 Create a gear box.
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxDriveTrain::deprecated::GearBox)
 
bool gearDown ()
 
bool gearUp ()
 change gears
 
agx::Real getCurrentGearRatio () const
 
int getGear () const
 
const agxDriveTrain::GearBox * getGearBox () const
 
agx::Real getGearRatio (int gearIndex) const
 
virtual bool preUpdate (agx::Real timeStep) override
 Functions called by a static function.
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
bool setGear (int gearIndex)
 
void setGearRatios (const agx::RealVector &gear_ratios)
 Set the gear ratio for gear indexed like -2, -1, 0, 1, 2, 3, 4 (negative is reverse gears, 0 is neutral, positive if forward gears)
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxDriveTrain::deprecated::DriveTrainComponent
 DriveTrainComponent (agxPowerLine::Connector *internalConnector)
 
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxDriveTrain::deprecated::DriveTrainComponent)
 
virtual agxPowerLine::DimensionAndSide getConnectableDimension (agxPowerLine::PhysicalDimension::Type type, agxPowerLine::Side side) override
 
virtual void getConnectableDimensionTypes (agxPowerLine::PhysicalDimension::TypeVector &types, agxPowerLine::Side side) const override
 
virtual agxPowerLine::Connector * getConnector ()
 
virtual const agxPowerLine::Connector * getConnector () const
 
virtual void getConnectorsRecursive (agxPowerLine::ConnectorPtrVector &connectors) override
 Fill the given vector with the Connectors that are held by this SubGraph.
 
virtual agx::Real getInertia () const override
 
const agxDriveTrain::Shaft * getInputShaft () const
 
const agxDriveTrain::Shaft * getOutputShaft () const
 
agxPowerLine::RotationalDimension * getRotationalDimension (agxPowerLine::Side side)
 
const agxPowerLine::RotationalDimension * getRotationalDimension (agxPowerLine::Side side) const
 
virtual void getUnitsRecursive (agxPowerLine::UnitPtrVector &units) override
 Fill the given vector with the Units that are held by this SubGraph.
 
void restore (agxStream::InputArchive &in) override
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
virtual void setInertia (agx::Real inertia) override
 set the inertia for the rotational dimension of the rotational unit.
 
void store (agxStream::OutputArchive &out) const override
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxDriveTrain::Shaft
 Shaft ()
 Create a shaft.
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxDriveTrain::Shaft)
 
agx::Real getAccumulatedAngle () const
 
virtual bool postUpdate (agx::Real timeStep) override
 Post update will update the accumulated angle.
 
virtual bool preUpdate (agx::Real timeStep) override
 Functions called by a static function.
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
void setAccumulatedAngle (agx::Real angle)
 Set the accumulated shaft angle in radians.
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxPowerLine::RotationalUnit
 RotationalUnit ()
 Create a rotational unit.
 
 RotationalUnit (agx::RigidBody *body, agx::UInt8 slot)
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxPowerLine::RotationalUnit)
 
agx::Real getAngle () const
 
agx::Real getAngularVelocity () const
 returns the number of radians per second
 
virtual agx::Real getDeliveredTorque () const
 returns the amount of torque delivered from the rotational dimension
 
virtual agx::Vec3 getDirection () const
 returns a vector in world coordinates that defines the rotational axis of the rotational unit.
 
virtual agx::Real getInertia () const
 
agxPowerLine::RotationalDimension * getRotationalDimension () const
 returns a pointer to the rotational dimension
 
agx::Real getRPM () const
 returns the number of revolutions per minute
 
virtual bool postUpdate (agx::Real timeStep) override
 
virtual bool preUpdate (agx::Real timeStep) override
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
void setAngularVelocityDamping (agx::Real damping)
 set the angular velocity damping around the local axis (direction)
 
virtual void setInertia (agx::Real inertia)
 set the inertia for the rotational dimension of the rotational unit.
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
- Public Member Functions inherited from agxPowerLine::Unit
 Unit ()
 Constructor.
 
void addNotification (agxPowerLine::PowerLine *powerLine)
 
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxPowerLine::Unit)
 
void attach (agx::RigidBody *body)
 Define which body in the simulation this Unit is attached to.
 
agx::String buildDimensionsName () const
 
virtual bool connect (agxPowerLine::Connector *connector)
 Connect the unit to a connector.
 
virtual bool connect (agxPowerLine::Side mySide, agxPowerLine::Side connectorSide, agxPowerLine::Connector *connector)
 Connect the unit to a connector, specifying the side of each.
 
virtual bool connect (agxPowerLine::Side mySide, agxPowerLine::Side otherSide, agxPowerLine::Unit *other)
 
virtual bool connect (agxPowerLine::Unit *otherUnit)
 Connect the unit to another unit.
 
virtual bool disconnect (agxPowerLine::Unit *unit)
 
void disconnectAll ()
 
agxPowerLine::PhysicalDimension * getActiveDimension (size_t index)
 
const agxPowerLine::PhysicalDimension * getActiveDimension (size_t index) const
 
virtual agxPowerLine::DimensionAndSide getConnectableDimension (agxPowerLine::PhysicalDimension::Type type, agxPowerLine::Side side)
 
virtual void getConnectableDimensionTypes (agxPowerLine::PhysicalDimension::TypeVector &types, agxPowerLine::Side side) const
 
agxPowerLine::PhysicalDimension * getConnectableInputDimension (agxPowerLine::PhysicalDimension::Type type)
 
agxPowerLine::PhysicalDimension * getConnectableOutputDimension (agxPowerLine::PhysicalDimension::Type type)
 
void getConnectedUnits (UnitPtrSetVector &result, agxPowerLine::Side side)
 
size_t getConnectors (agxPowerLine::ConnectorPtrVector &result) const
 
size_t getConnectors (const agxPowerLine::Unit *unit, agxPowerLine::ConnectorPtrVector &result)
 Append all connectors connecting this Unit to the given Unit to the 'result' Vector.
 
agxPowerLine::PhysicalDimension * getDimension (agxPowerLine::PhysicalDimension::Type type)
 
const agxPowerLine::PhysicalDimension * getDimension (agxPowerLine::PhysicalDimension::Type type) const
 
agxPowerLine::PhysicalDimensionRefVector & getDimensions ()
 
const agxPowerLine::PhysicalDimensionRefVector & getDimensions () const
 
Connector * getFirstInputConnector (const agxPowerLine::Unit *unit) const
 
Connector * getFirstOutputConnector (const agxPowerLine::Unit *unit) const
 
bool getIgnoreForStoreRestoreStream () const
 
size_t getInputConnectors (agxPowerLine::ConnectorPtrVector &result) const
 
size_t getInputConnectors (const agxPowerLine::Unit *unit, agxPowerLine::ConnectorPtrVector &result)
 
size_t getNumActiveDimensions () const
 The number of non-null PhysicalDimension in this Unit, not including internal Units.
 
virtual size_t getNumConnectableDimensions (Side side) const
 
size_t getNumConnections () const
 
size_t getOutputConnectors (agxPowerLine::ConnectorPtrVector &result) const
 
size_t getOutputConnectors (const agxPowerLine::Unit *unit, agxPowerLine::ConnectorPtrVector &result)
 
void getOwnConnectedUnits (UnitPtrSetVector &unitSet, agxPowerLine::Side side, bool startFromCleanUnitSet=true) const
 
void getOwnConnectedUnits (UnitPtrSetVector &unitSet, bool startFromCleanUnitSet=true) const
 Constructs the set of Units connected to this Unit's own dimensions.
 
agxPowerLine::PowerLine * getPowerLine () const
 
agxPowerLine::Unit * getRoot () const
 
agxPowerLine::Side getSide (const Connector *connector) const
 
bool hasConnector (const Connector *connector) const
 
virtual bool isConnected (agxPowerLine::Unit *otherUnit) const
 
virtual bool isValid () const
 
virtual bool postRestore (agxStream::StorageStream &str)
 
virtual bool postStore (agxStream::StorageStream &str) const
 
void removeNotification (agxPowerLine::PowerLine *powerLine)
 
virtual void restore (agxStream::InputArchive &in) override
 
virtual bool restore (agxStream::StorageStream &str) override
 Restores internal data from stream.
 
void setRoot (agxPowerLine::Unit *root)
 
void spreadRootToGraph ()
 
virtual void store (agxStream::OutputArchive &out) const override
 
virtual bool store (agxStream::StorageStream &str) const override
 Stores internal data into stream.
 
virtual bool vetoConnect (agxPowerLine::Connector *connector) const
 
- Public Member Functions inherited from agxPowerLine::SubGraph
 SubGraph ()
 
virtual bool addNotification (agxSDK::Simulation *simulation)=0
 
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxPowerLine::SubGraph)
 
virtual void getConnectorsRecursive (ConnectorPtrVector &connectors)
 Fill the given vector with the Connectors that are held by this SubGraph.
 
Connector * getEnclosingConnector ()
 
const Connector * getEnclosingConnector () const
 
SubGraph * getEnclosingGraph ()
 
const SubGraph * getEnclosingGraph () const
 
Unit * getEnclosingUnit ()
 
const Unit * getEnclosingUnit () const
 
const agxPowerLine::ConnectorRefVector & getInternalConnectors () const
 
const agxPowerLine::UnitRefVector & getInternalUnits () const
 
const agx::Name & getName () const
 
SubGraph * getRootEnclosingGraph ()
 
const SubGraph * getRootEnclosingGraph () const
 
virtual void getUnitsRecursive (UnitPtrVector &units)
 Fill the given vector with the Units that are held by this SubGraph.
 
bool isEnclosedWithin (const SubGraph *component) const
 
virtual bool postUpdate (agx::Real timeStep)
 
virtual void prepareForRestore ()
 
virtual void prepareForStore ()
 
virtual bool preUpdate (agx::Real timeStep)
 
virtual bool removeNotification (agxUtil::ConstraintHolder *holder, agxSDK::Simulation *simulation)=0
 
virtual void restore (agxStream::InputArchive &in) override
 
virtual bool restore (agxStream::StorageStream &str)
 Restores internal data from stream.
 
void setName (const agx::Name &name)
 Set the name of this power line component.
 
void spreadPowerLineToGraph ()
 
virtual void store (agxStream::OutputArchive &out) const override
 
virtual bool store (agxStream::StorageStream &str) const
 Stores internal data into stream.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Static Public Member Functions

static agxStream::Serializable * create (agxStream::InputArchive &)
 
- Static Public Member Functions inherited from agxDriveTrain::deprecated::GearBox
static agxStream::Serializable * create (agxStream::InputArchive &)
 
- Static Public Member Functions inherited from agxDriveTrain::Shaft
static agxStream::Serializable * create (agxStream::InputArchive &)
 
- Static Public Member Functions inherited from agxPowerLine::RotationalUnit
static agx::Real convertAngularVelocityToRPM (const agx::Real angVel)
 Convert between m/s and rpm.
 
static agx::Real convertRPMtoAngularVelocity (const agx::Real rpm)
 
static agxStream::Serializable * create (agxStream::InputArchive &)
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 

Protected Member Functions

virtual ~HighLevelGearBox ()
 
- Protected Member Functions inherited from agxDriveTrain::deprecated::GearBox
virtual ~GearBox ()
 
void createBox (const agx::RealVector &gears)
 
- Protected Member Functions inherited from agxDriveTrain::deprecated::DriveTrainComponent
virtual ~DriveTrainComponent ()
 
void connectInternalConnector ()
 
bool replaceConnector (agxPowerLine::Connector *connector)
 
- Protected Member Functions inherited from agxDriveTrain::Shaft
virtual ~Shaft ()
 
- Protected Member Functions inherited from agxPowerLine::RotationalUnit
virtual ~RotationalUnit ()
 
- Protected Member Functions inherited from agxPowerLine::Unit
virtual ~Unit ()
 
bool activateDimension (PhysicalDimension *dimension)
 
virtual bool hasValidInputConnection () const
 returns if it is possible to connect to this unit
 
void restorePre46 (agxStream::InputArchive &in)
 
void setPowerLine (PowerLine *powerLine)
 Point to the power line the unit is a part of.
 
- Protected Member Functions inherited from agxPowerLine::SubGraph
virtual ~SubGraph ()
 
void addInternalConnector (agxPowerLine::Connector *connector)
 
void addInternalUnit (agxPowerLine::Unit *unit)
 
void removeInternalConnector (agxPowerLine::Connector *connector)
 
void removeInternalUnit (agxPowerLine::Unit *unit)
 
agx::Bool replaceInternalUnit (agxPowerLine::Unit *oldUnit, agxPowerLine::Unit *newUnit)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agxDriveTrain::deprecated::GearBox
agxDriveTrain::GearBoxRef m_gearBoxConnector
 
- Protected Attributes inherited from agxDriveTrain::deprecated::DriveTrainComponent
agxPowerLine::ConnectorRef m_connector
 
agxDriveTrain::ShaftRef m_inputShaft
 
- Protected Attributes inherited from agxDriveTrain::Shaft
agx::Real m_accumulatedAngle
 
- Protected Attributes inherited from agxPowerLine::RotationalUnit
RotationalDimensionRef m_rotationalDimension
 
- Protected Attributes inherited from agxPowerLine::Unit
agx::observer_ptr< agx::RigidBody > m_attachBody
 
PhysicalDimensionRefVector m_dimensions
 
bool m_ignoreMeForStoreRestoreStream
 
agxPowerLine::Unit * m_rootUnit
 
- Protected Attributes inherited from agxPowerLine::SubGraph
SubGraphObserver m_enclosingGraph
 
ConnectorRefVector m_internalConnectors
 
UnitRefVector m_internalUnits
 
agx::Name m_name
 
PowerLine * m_powerLine
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

The gear box can have an arbitrary number of gears.

A gear is added by adding a gear ratio to the gear box. The gear will be sorted among the already existing gears.

A negative gear ratio is considered to be a reverse gear. For example: by setting the gear index to no. -1 will give the reverse gear with the lowest gear ratio. If there is no reverse gear, the setGear function will return false.

The gear box will always have a neutral gear by default. (The neutral always have gear index 0 (zero) )

Definition at line 125 of file HighLevelDriveTrain.h.

Constructor & Destructor Documentation

◆ HighLevelGearBox()

agxDriveTrain::deprecated::HighLevelGearBox::HighLevelGearBox ( )

The only constructor.

◆ ~HighLevelGearBox()

virtual agxDriveTrain::deprecated::HighLevelGearBox::~HighLevelGearBox ( )
protectedvirtual

Member Function Documentation

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxDriveTrain::deprecated::HighLevelGearBox::AGXSTREAM_DECLARE_SERIALIZABLE_BASE ( agxDriveTrain::deprecated::HighLevelGearBox  )

◆ create()

static agxStream::Serializable * agxDriveTrain::deprecated::HighLevelGearBox::create ( agxStream::InputArchive &  )
inlinestatic

Definition at line 158 of file HighLevelDriveTrain.h.

◆ getIncomingRPM()

agx::Real agxDriveTrain::deprecated::HighLevelGearBox::getIncomingRPM ( ) const
Returns
current rpm for the incoming shaft.

◆ getRPM()

agx::Real agxDriveTrain::deprecated::HighLevelGearBox::getRPM ( ) const
Returns
current rpm of the output shaft.

◆ getTorque()

agx::Real agxDriveTrain::deprecated::HighLevelGearBox::getTorque ( ) const

Get current load torque.

◆ restore()

virtual bool agxDriveTrain::deprecated::HighLevelGearBox::restore ( agxStream::StorageStream &  str)
overridevirtual

Restores internal data from stream.

Reimplemented from agxDriveTrain::deprecated::GearBox.

◆ store()

virtual bool agxDriveTrain::deprecated::HighLevelGearBox::store ( agxStream::StorageStream &  str) const
overridevirtual

Stores internal data into stream.

Reimplemented from agxDriveTrain::deprecated::GearBox.


The documentation for this class was generated from the following file: