AGX Dynamics 2.40.0.0
Loading...
Searching...
No Matches
agxPowerLine::detail Namespace Reference

Classes

class  AbstractDimensionState1Dof
 Base class for the two one dimensional dimension state classes. More...
 
class  AbstractDimensionState3Dof
 Base class for the two three dimensional dimension state classes. More...
 
class  ConnectionIteratorOperations
 
class  ConnectionIteratorTypes
 
class  ConnectionIteratorTypes< Connector * >
 
class  ConnectionIteratorTypes< const Connector * >
 
class  ConnectionIteratorTypes< const PhysicalDimension * >
 
class  ConnectionIteratorTypes< PhysicalDimension * >
 
class  ConnectionOperations
 
class  DimensionState
 A DimensionState is the data carrier of a PhysicalDimension. More...
 
class  DimensionState1Dof
 Templated one dimensional dimension state. More...
 
class  DimensionState3Dof
 Templated three dimensional dimension state. More...
 
class  ElementaryWireWinchConnectorConstraint
 Elementary constraint that connects a RotationalDimension in a PowerLine to the two PhysicalDimensions of a RigidBodyUnit. More...
 
class  PackingInfo
 Information about which DimensionState1Dof is using which slot in a RigidBody. More...
 
class  PhysicalDimensionIteratorTypes
 
class  PhysicalDimensionIteratorTypes< const Unit * >
 
class  PhysicalDimensionIteratorTypes< Unit * >
 
class  RigidBodyRotationalAttachmentSentry
 RigidBodyTranslationalAttachment has been deprecated and removed. More...
 
class  RigidBodyTranslationalAttachmentSentry
 RigidBodyTranslationalAttachment has been deprecated and removed. More...
 
struct  Rotational
 RigidBody accessor helper that knows how to extract rotational data from a RigidBody. More...
 
class  SlotMapperUnitTestEntryPoint
 The UnitTestEntryPoint is a backdoor into the SlotMapper's internal state used by the unit tests to ensure that the SlotMapper implementation is correct. More...
 
struct  Translational
 RigidBody accessor helper that knows how to extract translational data from a RigidBody. More...
 
class  WireWinchConnector
 
class  WireWinchConnectorConstraintImplementation
 

Typedefs

typedef agx::observer_ptr< const DimensionStateDimensionStateConstObserver
 
typedef agx::ref_ptr< const DimensionStateDimensionStateConstRef
 
typedef agx::observer_ptr< DimensionStateDimensionStateObserver
 
typedef agx::ref_ptr< DimensionStateDimensionStateRef
 
using PackingInfos = agx::Vector< agxPowerLine::detail::PackingInfo >
 
using PhysicalDimensionStateRef = agx::ref_ptr< DimensionState >
 
typedef void(agxStream::Serializable::* RestoreMemFn) (agxStream::StorageStream &)
 Member function signature for methods that read data from a StorageStream.
 
using Rotational1DofState = DimensionState1Dof< Rotational >
 
using Rotational3DofState = DimensionState3Dof< Rotational >
 
using Translational1DofState = DimensionState1Dof< Translational >
 
using Translational3DofState = DimensionState3Dof< Translational >
 
typedef agx::observer_ptr< const WireWinchConnectorWireWinchConnectorConstObserver
 
typedef agx::ref_ptr< const WireWinchConnectorWireWinchConnectorConstRef
 
typedef agx::observer_ptr< WireWinchConnectorWireWinchConnectorObserver
 
typedef agx::ref_ptr< WireWinchConnectorWireWinchConnectorRef
 

Functions

void addTo (agxSDK::Simulation *simulation, agx::RigidBody *body)
 
template<typename Container >
size_t countStoreRestorable (const Container &components)
 
PackingInfos::iterator findPackingInfo (const agx::RigidBody *body, PackingInfos &packingInfos)
 
PackingInfos::iterator findPackingInfo (const Rotational1DofState *dimension, PackingInfos &packingInfos)
 
std::tuple< PackingInfos::iterator, PackingInfos::iteratorfindPackingInfos (agx::RigidBody *body, PackingInfos &fullPackings, PackingInfos &nonfullPackings)
 
std::tuple< PackingInfos::iterator, PackingInfos::iteratorfindPackingInfos (Rotational1DofState *dimension, PackingInfos &fullPackings, PackingInfos &nonfullPackings)
 
bool hasMarkers (agxStream::StorageStream &in)
 
template<typename T >
bool optionallyRestore (agxStream::StorageStream &stream, T *object, const char *const parentName, const char *const dataName)
 Restores data for the given object if the object is not nullptr and the stream contains data for it.
 
bool optionallyRestore_helper (agxStream::StorageStream &stream, agxStream::Serializable *object, RestoreMemFn restore, const char *const parentName, const char *const dataName)
 Main worker helper for optinally restore.
 
bool optionallyRestoreLightData (agxStream::StorageStream &in, agxStream::Serializable *object, const char *const parentName, const char *const dataName)
 Restores light data for the given object if the object is not nullptr and the stream contains data for it.
 
void optionallyStoreLightData (agxStream::StorageStream &out, agxStream::Serializable *object)
 
void removeFrom (agxSDK::Simulation *simulation, agx::RigidBody *body)
 
void removeFromFull (PackingInfos &fullPackings, PackingInfos::iterator fullIt, Rotational1DofState *dimension, PackingInfos &nonfullPackings)
 
void removeFromNonfull (PackingInfos &nonfullPackings, PackingInfos::iterator nonfullIt, Rotational1DofState *dimension, agx::RigidBody *oldBody, agxSDK::Simulation *simulation)
 
bool restoreConnectorEndMarker (agxStream::StorageStream &in)
 
bool restoreLightDataBeginMarker (agxStream::StorageStream &in)
 
bool restoreLightDataEndMarker (agxStream::StorageStream &in)
 
bool restoreMarker (agxStream::StorageStream &in, agx::UInt16 marker, const char *name)
 
bool restorePowerLineBeginMarker (agxStream::StorageStream &in)
 
bool restorePowerLineEndMarker (agxStream::StorageStream &in)
 
template<typename Container >
bool restoreRestorablesCount (const Container &components, agxStream::StorageStream &in)
 
bool restoreUnitEndMarker (agxStream::StorageStream &in)
 
std::tuple< PackingInfos::iterator, PackingInfos::iteratorsearchPackingInfos (agx::RigidBody *body, PackingInfos &fullPackings, PackingInfos &nonfullPackings)
 
std::tuple< PackingInfos::iterator, PackingInfos::iteratorsearchPackingInfos (Rotational1DofState *dimension, PackingInfos &fullPackings, PackingInfos &nonfullPackings)
 
bool shouldReadRotationalActuatorConnectorData (size_t archiveAgxVersion, agx::UInt16 archiveSerializationVersion)
 
bool shouldReadRotationalDimensionDirectionReference (size_t archiveAgxVersion, agx::UInt16 archiveSerializationVersion)
 
bool shouldReadWireWinchConnectorData (size_t archiveAgxVersion, agx::UInt16 archiveSerializationVersion)
 
template<typename Component >
bool shouldStore (const Component &c)
 
void storeConnectorEndMarker (agxStream::StorageStream &out)
 
void storeLightDataBeginMarker (agxStream::StorageStream &out)
 
void storeLightDataEndMarker (agxStream::StorageStream &out)
 
void storePowerLineBeginMarker (agxStream::StorageStream &out)
 
void storePowerLineEndMarker (agxStream::StorageStream &out)
 
template<typename Container >
void storeStorablesCount (const Container &components, agxStream::StorageStream &out)
 
void storeUnitEndMarker (agxStream::StorageStream &out)
 

Variables

const agx::UInt16 CONNECTOR_END_MARKER = 0x0543
 
const agx::UInt16 LIGHT_DATA_BEGIN_MARKER = 0x51b7
 
const agx::UInt16 LIGHT_DATA_END_MARKER = 0xfc4b
 
const agx::UInt16 MARKER_SERIALIZATION_VERSION = 92
 
const agx::UInt16 POWERLINE_BEGIN_MARKER = 0x5b04
 
const agx::UInt16 POWERLINE_END_MARKER = 0x7245
 
const agx::UInt16 UNIT_END_MARKER = 0x4a73
 

Typedef Documentation

◆ DimensionStateConstObserver

◆ DimensionStateConstRef

◆ DimensionStateObserver

◆ DimensionStateRef

◆ PackingInfos

◆ PhysicalDimensionStateRef

◆ RestoreMemFn

typedef void(agxStream::Serializable::* agxPowerLine::detail::RestoreMemFn) (agxStream::StorageStream &)

Member function signature for methods that read data from a StorageStream.

Was intended to be restore and restoreLightData, but restore isn't part of Serializable so all of this is kind of moot. Maybe it will be added later. Also, the signatures are different.

Definition at line 246 of file powerLineSerialization.h.

◆ Rotational1DofState

◆ Rotational3DofState

◆ Translational1DofState

◆ Translational3DofState

◆ WireWinchConnectorConstObserver

◆ WireWinchConnectorConstRef

◆ WireWinchConnectorObserver

◆ WireWinchConnectorRef

Function Documentation

◆ addTo()

void agxPowerLine::detail::addTo ( agxSDK::Simulation simulation,
agx::RigidBody body 
)

◆ countStoreRestorable()

template<typename Container >
size_t agxPowerLine::detail::countStoreRestorable ( const Container &  components)

Definition at line 108 of file powerLineSerialization.h.

Referenced by restoreRestorablesCount(), and storeStorablesCount().

◆ findPackingInfo() [1/2]

PackingInfos::iterator agxPowerLine::detail::findPackingInfo ( const agx::RigidBody body,
PackingInfos packingInfos 
)

◆ findPackingInfo() [2/2]

PackingInfos::iterator agxPowerLine::detail::findPackingInfo ( const Rotational1DofState dimension,
PackingInfos packingInfos 
)

◆ findPackingInfos() [1/2]

std::tuple< PackingInfos::iterator, PackingInfos::iterator > agxPowerLine::detail::findPackingInfos ( agx::RigidBody body,
PackingInfos fullPackings,
PackingInfos nonfullPackings 
)

◆ findPackingInfos() [2/2]

std::tuple< PackingInfos::iterator, PackingInfos::iterator > agxPowerLine::detail::findPackingInfos ( Rotational1DofState dimension,
PackingInfos fullPackings,
PackingInfos nonfullPackings 
)

◆ hasMarkers()

bool agxPowerLine::detail::hasMarkers ( agxStream::StorageStream in)
inline

Definition at line 94 of file powerLineSerialization.h.

References MARKER_SERIALIZATION_VERSION.

Referenced by restoreMarker(), and restoreRestorablesCount().

◆ optionallyRestore()

template<typename T >
bool agxPowerLine::detail::optionallyRestore ( agxStream::StorageStream stream,
T *  object,
const char *const  parentName,
const char *const  dataName 
)

Restores data for the given object if the object is not nullptr and the stream contains data for it.

Does not restore data if object is nullptr and the stream contains no data. Returns true in both of these cases, unless a read is attempted and failed.

Prints a warning and returns false if the object pointer and the stream contents is inconsistent.

Parameters
stream- The stream to read from.
object- The object to read into. May be nullptr.
parentName- Becomes part of error message if the parent and stream disagree.
dataName- Becomes part of the error message if the parent and stream disagree.
Returns
True if the object and stream agree whether to read or not. False otherwise.

Definition at line 367 of file powerLineSerialization.h.

References agxAbort1, LOGGER_ENDL, and LOGGER_WARNING.

◆ optionallyRestore_helper()

bool agxPowerLine::detail::optionallyRestore_helper ( agxStream::StorageStream stream,
agxStream::Serializable object,
RestoreMemFn  restore,
const char *const  parentName,
const char *const  dataName 
)
inline

Main worker helper for optinally restore.

Checks the object pointer and the stream flag and calls the passed in restore member function is both the pointer and the stream flag says that reading is ok.

Definition at line 254 of file powerLineSerialization.h.

References agxAbort1, LOGGER_ENDL, and LOGGER_WARNING.

Referenced by optionallyRestoreLightData().

◆ optionallyRestoreLightData()

bool agxPowerLine::detail::optionallyRestoreLightData ( agxStream::StorageStream in,
agxStream::Serializable object,
const char *const  parentName,
const char *const  dataName 
)
inline

Restores light data for the given object if the object is not nullptr and the stream contains data for it.

Does not restore light data if object is nullptr and the stream contains no data. Returns true in both of these cases.

Prints a warning and returns false if the object pointer and the stream contents is inconsistent.

Parameters
in- The stream to read from.
object- The object to read into. May be nullptr.
parentName- Becomes part of error message if the parent and stream disagree.
dataName- Becomes part of the error message if the parent and stream disagree.
Returns
True if the object and stream agree whether to read or not. False otherwise.

Definition at line 331 of file powerLineSerialization.h.

References optionallyRestore_helper(), restoreLightDataBeginMarker(), and restoreLightDataEndMarker().

◆ optionallyStoreLightData()

void agxPowerLine::detail::optionallyStoreLightData ( agxStream::StorageStream out,
agxStream::Serializable object 
)
inline

◆ removeFrom()

void agxPowerLine::detail::removeFrom ( agxSDK::Simulation simulation,
agx::RigidBody body 
)

◆ removeFromFull()

void agxPowerLine::detail::removeFromFull ( PackingInfos fullPackings,
PackingInfos::iterator  fullIt,
Rotational1DofState dimension,
PackingInfos nonfullPackings 
)

◆ removeFromNonfull()

void agxPowerLine::detail::removeFromNonfull ( PackingInfos nonfullPackings,
PackingInfos::iterator  nonfullIt,
Rotational1DofState dimension,
agx::RigidBody oldBody,
agxSDK::Simulation simulation 
)

◆ restoreConnectorEndMarker()

bool agxPowerLine::detail::restoreConnectorEndMarker ( agxStream::StorageStream in)
inline

Definition at line 214 of file powerLineSerialization.h.

References CONNECTOR_END_MARKER, and restoreMarker().

◆ restoreLightDataBeginMarker()

bool agxPowerLine::detail::restoreLightDataBeginMarker ( agxStream::StorageStream in)
inline

Definition at line 226 of file powerLineSerialization.h.

References LIGHT_DATA_BEGIN_MARKER, and restoreMarker().

Referenced by optionallyRestoreLightData().

◆ restoreLightDataEndMarker()

bool agxPowerLine::detail::restoreLightDataEndMarker ( agxStream::StorageStream in)
inline

Definition at line 232 of file powerLineSerialization.h.

References LIGHT_DATA_END_MARKER, and restoreMarker().

Referenced by optionallyRestoreLightData().

◆ restoreMarker()

bool agxPowerLine::detail::restoreMarker ( agxStream::StorageStream in,
agx::UInt16  marker,
const char *  name 
)
inline

◆ restorePowerLineBeginMarker()

bool agxPowerLine::detail::restorePowerLineBeginMarker ( agxStream::StorageStream in)
inline

Definition at line 202 of file powerLineSerialization.h.

References POWERLINE_BEGIN_MARKER, and restoreMarker().

◆ restorePowerLineEndMarker()

bool agxPowerLine::detail::restorePowerLineEndMarker ( agxStream::StorageStream in)
inline

Definition at line 208 of file powerLineSerialization.h.

References POWERLINE_END_MARKER, and restoreMarker().

◆ restoreRestorablesCount()

template<typename Container >
bool agxPowerLine::detail::restoreRestorablesCount ( const Container &  components,
agxStream::StorageStream in 
)

◆ restoreUnitEndMarker()

bool agxPowerLine::detail::restoreUnitEndMarker ( agxStream::StorageStream in)
inline

Definition at line 220 of file powerLineSerialization.h.

References restoreMarker(), and UNIT_END_MARKER.

◆ searchPackingInfos() [1/2]

std::tuple< PackingInfos::iterator, PackingInfos::iterator > agxPowerLine::detail::searchPackingInfos ( agx::RigidBody body,
PackingInfos fullPackings,
PackingInfos nonfullPackings 
)

◆ searchPackingInfos() [2/2]

std::tuple< PackingInfos::iterator, PackingInfos::iterator > agxPowerLine::detail::searchPackingInfos ( Rotational1DofState dimension,
PackingInfos fullPackings,
PackingInfos nonfullPackings 
)

◆ shouldReadRotationalActuatorConnectorData()

bool agxPowerLine::detail::shouldReadRotationalActuatorConnectorData ( size_t  archiveAgxVersion,
agx::UInt16  archiveSerializationVersion 
)
inline
Returns
true if the inspected serialization contains data for the RotationalActuatorConnector and related classes. False otherwise.

Definition at line 33 of file powerLineSerialization.h.

References AGX_CALC_VERSION().

◆ shouldReadRotationalDimensionDirectionReference()

bool agxPowerLine::detail::shouldReadRotationalDimensionDirectionReference ( size_t  archiveAgxVersion,
agx::UInt16  archiveSerializationVersion 
)
inline
Returns
true if the inspected serialization contain data for the Rotational- Dimension reference direction. False otherwise.

Definition at line 60 of file powerLineSerialization.h.

References AGX_CALC_VERSION(), and AGXSTREAM_SERIALIZATION_VERSION_POWER_LINE_ROTAT_LOCAL_OR_WORLD_DIRECTION.

◆ shouldReadWireWinchConnectorData()

bool agxPowerLine::detail::shouldReadWireWinchConnectorData ( size_t  archiveAgxVersion,
agx::UInt16  archiveSerializationVersion 
)
inline

Definition at line 29 of file WireWinchSerialization.h.

References AGX_CALC_VERSION().

◆ shouldStore()

template<typename Component >
bool agxPowerLine::detail::shouldStore ( const Component &  c)

Definition at line 101 of file powerLineSerialization.h.

◆ storeConnectorEndMarker()

void agxPowerLine::detail::storeConnectorEndMarker ( agxStream::StorageStream out)
inline

Definition at line 161 of file powerLineSerialization.h.

References CONNECTOR_END_MARKER.

◆ storeLightDataBeginMarker()

void agxPowerLine::detail::storeLightDataBeginMarker ( agxStream::StorageStream out)
inline

Definition at line 173 of file powerLineSerialization.h.

References LIGHT_DATA_BEGIN_MARKER.

Referenced by optionallyStoreLightData().

◆ storeLightDataEndMarker()

void agxPowerLine::detail::storeLightDataEndMarker ( agxStream::StorageStream out)
inline

Definition at line 179 of file powerLineSerialization.h.

References LIGHT_DATA_END_MARKER.

Referenced by optionallyStoreLightData().

◆ storePowerLineBeginMarker()

void agxPowerLine::detail::storePowerLineBeginMarker ( agxStream::StorageStream out)
inline

Definition at line 149 of file powerLineSerialization.h.

References POWERLINE_BEGIN_MARKER.

◆ storePowerLineEndMarker()

void agxPowerLine::detail::storePowerLineEndMarker ( agxStream::StorageStream out)
inline

Definition at line 155 of file powerLineSerialization.h.

References POWERLINE_END_MARKER.

◆ storeStorablesCount()

template<typename Container >
void agxPowerLine::detail::storeStorablesCount ( const Container &  components,
agxStream::StorageStream out 
)

Definition at line 119 of file powerLineSerialization.h.

References countStoreRestorable().

◆ storeUnitEndMarker()

void agxPowerLine::detail::storeUnitEndMarker ( agxStream::StorageStream out)
inline

Definition at line 167 of file powerLineSerialization.h.

References UNIT_END_MARKER.

Variable Documentation

◆ CONNECTOR_END_MARKER

const agx::UInt16 agxPowerLine::detail::CONNECTOR_END_MARKER = 0x0543

Definition at line 87 of file powerLineSerialization.h.

Referenced by restoreConnectorEndMarker(), and storeConnectorEndMarker().

◆ LIGHT_DATA_BEGIN_MARKER

const agx::UInt16 agxPowerLine::detail::LIGHT_DATA_BEGIN_MARKER = 0x51b7

◆ LIGHT_DATA_END_MARKER

const agx::UInt16 agxPowerLine::detail::LIGHT_DATA_END_MARKER = 0xfc4b

Definition at line 90 of file powerLineSerialization.h.

Referenced by restoreLightDataEndMarker(), and storeLightDataEndMarker().

◆ MARKER_SERIALIZATION_VERSION

const agx::UInt16 agxPowerLine::detail::MARKER_SERIALIZATION_VERSION = 92

Definition at line 82 of file powerLineSerialization.h.

Referenced by hasMarkers().

◆ POWERLINE_BEGIN_MARKER

const agx::UInt16 agxPowerLine::detail::POWERLINE_BEGIN_MARKER = 0x5b04

◆ POWERLINE_END_MARKER

const agx::UInt16 agxPowerLine::detail::POWERLINE_END_MARKER = 0x7245

Definition at line 86 of file powerLineSerialization.h.

Referenced by restorePowerLineEndMarker(), and storePowerLineEndMarker().

◆ UNIT_END_MARKER

const agx::UInt16 agxPowerLine::detail::UNIT_END_MARKER = 0x4a73

Definition at line 88 of file powerLineSerialization.h.

Referenced by restoreUnitEndMarker(), and storeUnitEndMarker().