|
AGX Dynamics 2.42.3.0
|
Pure virtual class. More...
#include <Unit.h>
Inheritance diagram for agxPowerLine::Unit:Public Member Functions | |
| 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. | |
Protected Member Functions | |
| 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 () |
Protected Attributes | |
| 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 |
Additional Inherited Members | |
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. | |
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. | |
| agxPowerLine::Unit::Unit | ( | ) |
Constructor.
|
protectedvirtual |
|
protected |
| void agxPowerLine::Unit::addNotification | ( | agxPowerLine::PowerLine * | powerLine | ) |
| agxPowerLine::Unit::AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE | ( | agxPowerLine::Unit | ) |
| void agxPowerLine::Unit::attach | ( | agx::RigidBody * | body | ) |
| agx::String agxPowerLine::Unit::buildDimensionsName | ( | ) | const |
|
virtual |
Connect the unit to a connector.
| connector | - a connector |
|
virtual |
Connect the unit to a connector, specifying the side of each.
| mySide | - The side on this unit to connect. |
| connectorSide | - The side on the connector to connect. |
| connector | - The connector to connect. |
|
virtual |
|
virtual |
Connect the unit to another unit.
| otherUnit | - another unit. |
|
virtual |
| void agxPowerLine::Unit::disconnectAll | ( | ) |
| agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getActiveDimension | ( | size_t | index | ) |
| const agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getActiveDimension | ( | size_t | index | ) | const |
|
virtual |
Reimplemented in agxDriveTrain::deprecated::DriveTrainComponent, agxHydraulics::Accumulator, agxHydraulics::deprecated::MotorUnit, agxHydraulics::deprecated::PumpUnit, agxHydraulics::PistonActuator, agxPowerLine::Actuator, agxPowerLine::Actuator1DOF, and agxPowerLine::TranslationalActuator.
|
virtual |
| agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getConnectableInputDimension | ( | agxPowerLine::PhysicalDimension::Type | type | ) |
| agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getConnectableOutputDimension | ( | agxPowerLine::PhysicalDimension::Type | type | ) |
| void agxPowerLine::Unit::getConnectedUnits | ( | UnitPtrSetVector & | result, |
| agxPowerLine::Side | side | ||
| ) |
| size_t agxPowerLine::Unit::getConnectors | ( | agxPowerLine::ConnectorPtrVector & | result | ) | const |
| size_t agxPowerLine::Unit::getConnectors | ( | const agxPowerLine::Unit * | unit, |
| agxPowerLine::ConnectorPtrVector & | result | ||
| ) |
| agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getDimension | ( | agxPowerLine::PhysicalDimension::Type | type | ) |
| const agxPowerLine::PhysicalDimension * agxPowerLine::Unit::getDimension | ( | agxPowerLine::PhysicalDimension::Type | type | ) | const |
| agxPowerLine::PhysicalDimensionRefVector & agxPowerLine::Unit::getDimensions | ( | ) |
| const agxPowerLine::PhysicalDimensionRefVector & agxPowerLine::Unit::getDimensions | ( | ) | const |
| Connector * agxPowerLine::Unit::getFirstInputConnector | ( | const agxPowerLine::Unit * | unit | ) | const |
| Connector * agxPowerLine::Unit::getFirstOutputConnector | ( | const agxPowerLine::Unit * | unit | ) | const |
| bool agxPowerLine::Unit::getIgnoreForStoreRestoreStream | ( | ) | const |
| size_t agxPowerLine::Unit::getInputConnectors | ( | agxPowerLine::ConnectorPtrVector & | result | ) | const |
| size_t agxPowerLine::Unit::getInputConnectors | ( | const agxPowerLine::Unit * | unit, |
| agxPowerLine::ConnectorPtrVector & | result | ||
| ) |
| size_t agxPowerLine::Unit::getNumActiveDimensions | ( | ) | const |
The number of non-null PhysicalDimension in this Unit, not including internal Units.
|
virtual |
| size_t agxPowerLine::Unit::getNumConnections | ( | ) | const |
| size_t agxPowerLine::Unit::getOutputConnectors | ( | agxPowerLine::ConnectorPtrVector & | result | ) | const |
| size_t agxPowerLine::Unit::getOutputConnectors | ( | const agxPowerLine::Unit * | unit, |
| agxPowerLine::ConnectorPtrVector & | result | ||
| ) |
| void agxPowerLine::Unit::getOwnConnectedUnits | ( | UnitPtrSetVector & | unitSet, |
| agxPowerLine::Side | side, | ||
| bool | startFromCleanUnitSet = true |
||
| ) | const |
| void agxPowerLine::Unit::getOwnConnectedUnits | ( | UnitPtrSetVector & | unitSet, |
| bool | startFromCleanUnitSet = true |
||
| ) | const |
Constructs the set of Units connected to this Unit's own dimensions.
Does not consider internal units.
| agxPowerLine::PowerLine * agxPowerLine::Unit::getPowerLine | ( | ) | const |
| agxPowerLine::Unit * agxPowerLine::Unit::getRoot | ( | ) | const |
| agxPowerLine::Side agxPowerLine::Unit::getSide | ( | const Connector * | connector | ) | const |
| bool agxPowerLine::Unit::hasConnector | ( | const Connector * | connector | ) | const |
|
protectedvirtual |
returns if it is possible to connect to this unit
|
virtual |
|
virtual |
|
virtual |
Reimplemented in agxDriveTrain::ElectricMotor.
|
virtual |
Reimplemented in agxDriveTrain::ElectricMotor.
| void agxPowerLine::Unit::removeNotification | ( | agxPowerLine::PowerLine * | powerLine | ) |
|
overridevirtual |
Reimplemented from agxPowerLine::SubGraph.
Reimplemented in agxDriveTrain::deprecated::DriveTrainComponent, agxPowerLine::Actuator, and agxPowerLine::Actuator1DOF.
|
overridevirtual |
Restores internal data from stream.
Reimplemented from agxPowerLine::SubGraph.
Reimplemented in agxPowerLine::RotationalActuator, agxDriveTrain::deprecated::DriveTrainComponent, agxDriveTrain::deprecated::TorqueConverterTable, agxDriveTrain::deprecated::FixedGear, agxDriveTrain::deprecated::GearBox, agxDriveTrain::deprecated::Clutch, agxDriveTrain::deprecated::HighLevelTorqueConverter, agxDriveTrain::deprecated::HighLevelGearBox, agxDriveTrain::ElectricMotor, agxDriveTrain::Engine, agxDriveTrain::PidControlledEngine, agxDriveTrain::Shaft, agxHydraulics::HydraulicMotorActuator, agxHydraulics::HydraulicPumpActuator, agxHydraulics::PistonActuator, agxPowerLine::Actuator, agxPowerLine::Actuator1DOF, agxPowerLine::TranslationalActuator, agxPowerLine::ActuatorBodyUnit, agxPowerLine::RotationalUnit, agxPowerLine::TranslationalUnit, and agxPowerLine::WireWinchActuator.
|
protected |
|
protected |
Point to the power line the unit is a part of.
| void agxPowerLine::Unit::setRoot | ( | agxPowerLine::Unit * | root | ) |
| void agxPowerLine::Unit::spreadRootToGraph | ( | ) |
|
overridevirtual |
Reimplemented from agxPowerLine::SubGraph.
Reimplemented in agxDriveTrain::deprecated::DriveTrainComponent, agxPowerLine::Actuator, and agxPowerLine::Actuator1DOF.
|
overridevirtual |
Stores internal data into stream.
Reimplemented from agxPowerLine::SubGraph.
Reimplemented in agxPowerLine::RotationalActuator, agxDriveTrain::deprecated::DriveTrainComponent, agxDriveTrain::deprecated::TorqueConverterTable, agxDriveTrain::deprecated::FixedGear, agxDriveTrain::deprecated::GearBox, agxDriveTrain::deprecated::Clutch, agxDriveTrain::deprecated::HighLevelTorqueConverter, agxDriveTrain::deprecated::HighLevelGearBox, agxDriveTrain::ElectricMotor, agxDriveTrain::Engine, agxDriveTrain::PidControlledEngine, agxDriveTrain::Shaft, agxHydraulics::HydraulicMotorActuator, agxHydraulics::HydraulicPumpActuator, agxHydraulics::PistonActuator, agxPowerLine::Actuator, agxPowerLine::Actuator1DOF, agxPowerLine::TranslationalActuator, agxPowerLine::ActuatorBodyUnit, agxPowerLine::RotationalUnit, agxPowerLine::TranslationalUnit, and agxPowerLine::WireWinchActuator.
|
virtual |
|
protected |
|
protected |
|
protected |
|
protected |