SimTKcommon Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractValueAbstract base class representing an arbitrary value of self-describing type
AnalyticBrickThis is a rectangular solid
AnalyticCircleAn analytic circle has only a radius
AnalyticCurve
AnalyticCylinderThe coordinate frame of the central cross section is the same as for a circle; that is, x and z are radial and y points along the cylinder's axis
AnalyticGeometryThis abstract class represents a piece of high-quality geometry that can be used for valid physical simulation
AnalyticLineAn analytic line has only a length
AnalyticSphere
AnalyticSurface
AnalyticVolume
APIArgcheckFailed
ArrayContainer class like std::vector<T> but with hidden implementation
ArrayBase
ArrayHelperNon-templatized helper class for ArrayBase<T>
ArrayViewThis class is a duplicate of Array and can be cast to an Array with no harm
Assert
Base
CacheEntry
Cant
CNTSpecialized information about Composite Numerical Types which allows us to define appropriate templatized classes using them
CNT::Result
CNT::Substitute
CNT< complex< R > >Specializations of CNT for numeric types
CNT< conjugate< R > >
CNT< double >
CNT< float >
CNT< long double >
ConcretizeWrap a pointer to an abstract base class in a way that makes it behave like a concrete class (sometimes called a "ClonePtr")
conjugateSimTK::conjugate<R> should be instantiated only for float, double, long double
conjugate< double >
conjugate< float >
conjugate< long double >
CoordinateAxis
CoordinateAxis::XCoordinateAxis
CoordinateAxis::XTypeAxis
CoordinateAxis::YCoordinateAxis
CoordinateAxis::YTypeAxis
CoordinateAxis::ZCoordinateAxis
CoordinateAxis::ZTypeAxis
DecorativeBrickThis defines a rectangular solid centered at the origin and aligned with the local frame axes
DecorativeCircleThis defines a circle in the x-y plane, centered at the origin
DecorativeCylinderThis defines a cylinder centered on the origin and aligned in the y direction
DecorativeEllipsoidThis defines an ellipsoidal solid centered at the origin and aligned with the local frame axes
DecorativeFrameThis defines geometry to represent a coordinate frame
DecorativeGeometryThis is an abstract handle class using the PIMPL design pattern to hide the private implementation
DecorativeGeometryImplementationUse this abstract class to connect your implementation of decorative geometry to the implementation-independent classes above
DecorativeLineA line between two points
DecorativeSphereThis defines a sphere centered at the origin
DecorativeTextThis defines a text label with its base at the origin
DefaultSystemSubsystemThis is a concrete Subsystem that is part of every System
EnumerationThis class defines an enumerated type
Enumeration::iteratorThis class provides an interface for iterating over the set of all possible enumerated values
EnumerationSetThis class provides an efficient implementation of a set for storing values of an enumerated type defined with Enumeration
EnumerationSet::EnumerationSetRepThis class is the internal implementation of EnumerationSet
EnumerationSet::iteratorThis class provides an interface for iterating over the content of an EnumerationSet
EventHandlerAn EventHandler is an object that defines an event that can occur within a system
EventReporterAn EventReporter is an object that defines an event that can occur within a system
EventStatus
IncompatibleValues
IndexOutOfRange
InertiaThe physical meaning of an inertia is the distribution of a rigid body's mass about a *particular* point
InverseRotation----------------------------------------------------------------------------- This InverseRotation class is the inverse of a Rotation See the Rotation class for information
InverseTransformTransform from frame B to frame F, but with the internal representation inverted
Lapack
ListContainer class with hidden implementation
ListBase
ListBase< T * >
ListViewListView is a 'dummy' class which is completely interchangeable with List
MassPropertiesThis class contains the mass, center of mass, and inertia of a rigid body B
MatCS is total spacing between columns in memory (default M) RS is total spacing between rows in memory (default 1)
Mat::EltResult
Mat::Result
Mat::SubMat
Mat::Substitute
Matrix_This is the class intended to appear in user code
MatrixBaseVariable-size 2d matrix of Composite Numerical Type (ELT) elements
MatrixBase::EltResult
MatrixCondition
MatrixConditions
MatrixHelper
MatrixHelper::DeepCopy
MatrixHelper::DiagonalView
MatrixHelper::ShallowCopy
MatrixHelper::TransposeView
MatrixShape
MatrixShapes
MatrixSize
MatrixSparseFormats
MatrixSparsity
MatrixStorage
MatrixStorageFormats
MatrixStructure
MatrixStructuresClass of enums used to communicate various attributes of matrices that affect which alogrithms are used for factoring, solving etc
MatrixView_This class is identical to a Matrix_; it is used only to manage the C++ rules for when copy constructors are called by introducing a separate type to prevent certain allowed optimizations from occuring when we don't want them
negatorNegator<N>, where N is a number type (real, complex, conjugate), is represented in memory identically to N, but behaves as though multiplied by -1, though at zero cost
negator::Result
negator::Substitute
NTraits
NTraits< complex< R > >Partial specialization for complex numbers -- underlying real R is still a template parameter
NTraits< complex< R > >::Result
NTraits< complex< R > >::Substitute
NTraits< conjugate< R > >
NTraits< conjugate< R > >::Result
NTraits< conjugate< R > >::Substitute
OperationNotAllowedOnNonconstReadOnlyView
OperationNotAllowedOnOwner
OperationNotAllowedOnView
PeriodicEventHandlerPeriodicEventHandler is a subclass of ScheduledEventHandler which generates a series of uniformly spaced events at regular intervals
PeriodicEventReporterPeriodicEventReporter is a subclass of ScheduledEventReporter which generates a series of uniformly spaced events at regular intervals
PhiMatrix
PhiMatrixTranspose
PIMPLDerivedHandleThis class is the parent of derived handle classes
PIMPLHandleThis class provides some infrastructure useful in making SimTK Private Implementation (PIMPL) classes
PIMPLImplementationThis class provides some infrastructure useful in creating PIMPL Implementation classes (the ones referred to by Handles)
PolynomialRootFinderThis class provides static methods for finding the roots of polynomials
PolynomialRootFinder::ZeroLeadingCoefficientThis is an exception which is thrown by all of the PolynomialRootFinder::findRoots() methods
QuaternionA Quaternion is a Vec4 with the following behavior:
  • its length is always 1 (or else it is all NaN)
  • it is equivalent to an angle/axis rotation for angle a, axis unit vector v, as: q = [ cos(a/2) sin(a/2)*v ] A quaternion is in "canonical form" when its first element is nonnegative
RandomThis class defines the interface for pseudo-random number generators
Random::GaussianThis is a subclass of Random that generates numbers according to a Gaussian distribution with a specified mean and standard deviation
Random::UniformThis is a subclass of Random that generates numbers uniformly distributed within a specified range
RealizeCheckFailed
RealizeTopologyMustBeCalledFirst
RotationMat33 that guarantees that the matrix is a legitimate 3x3 array associated with the relative orientation of two right-handed, orthogonal, unit vector bases
RowGeneric Row
Row::EltResult
Row::Result
Row::Substitute
RowVector_
RowVectorBaseThis is a dataless rehash of the MatrixBase class to specialize it for RowVectors
RowVectorBase::EltResult
RowVectorView_
ScheduledEventHandlerScheduledEventHandler is a subclass of EventHandler for events that occur at a particular time that is known in advance
ScheduledEventReporterScheduledEventReporter is a subclass of EventReporter for events that occur at a particular time that is known in advance
SizeOutOfRange
SizeWasNegative
StableArrayStableArray<T> is like std::vector<T> but more stable in two ways:
  • the addresses of the inserted items never change, even if the array has to be resized, and
  • the index of an inserted item never changes either
StageThis class is basically a glorified enumerated type, type-safe and range checked but permitting convenient (if limited) arithmetic
StageIsWrong
StageOutOfRange
StageTooHigh
StageTooLow
StateThis is the handle class for the hidden State implementation
StringSimTK::String is just an std::string with some additional methods defined
StudyThe handle class which serves as the abstract parent of all Studies
Study::GutsThis is the declaration for the Study::Guts class, the abstract object to which a Study handle points
SubsystemThe abstract parent of all Subsystems
Subsystem::GutsThe abstract parent of all Subsystems
SymMatRS is total spacing between rows in memory (default 1)
SymMat::EltResult
SymMat::Result
SymMat::Substitute
System::EventTriggerInfoThis class is used to communicate between the System and an Integrator regarding the properties of a particular event trigger function
System::GutsThis is the declaration for the System::Guts class, the abstract object to which a System handle points
TmpMatrixView_XXX not ready for prime time
TmpRowVectorView_XXX not ready for prime time
TmpVectorViewTXXX not ready for prime time
TransformThis class represents the rotate-and-shift transform which gives the location and orientation of a new frame F in a base (reference) frame B
TriggeredEventHandlerTriggeredEventHandler is a subclass of EventHandler for events that occur when some condition is satisfied within the system
TriggeredEventReporterTriggeredEventReporter is a subclass of EventReporter for events that occur when some condition is satisfied within the system
UnimplementedVirtualMethod
UnitRowThis type is used for the transpose of UnitVec, and as the returned row type of a Rotation
UnitVecThis class is a Vec3 plus an ironclad guarantee either that:
  • the length is one (to within a very small tolerance), or
  • all components are NaN
UserFunction
ValueA particular kind of AbstractValue, with automatic converstion to the underlying type
ValueHelperTemplatized version of the abstract class, providing generic type-specific functionality that does not require specialization
ValueOutOfRange
ValueWasNegative
VecGeneric Vec
Vec::EltResult
Vec::Result
Vec::Substitute
Vector_
VectorBaseThis is a dataless rehash of the MatrixBase class to specialize it for Vectors
VectorBase::EltResult
VectorIteratorThis is an iterator for iterating over the elements of a matrix
VectorView_
Wider
Wider< double, double >
Wider< double, float >
Wider< double, long double >
Wider< float, double >
Wider< float, float >
Wider< float, long double >
Wider< long double, double >
Wider< long double, float >
Wider< long double, long double >
Widest
Widest< complex< R1 >, complex< R2 > >
Widest< complex< R1 >, R2 >
Widest< double, double >
Widest< double, float >
Widest< double, long double >
Widest< float, double >
Widest< float, float >
Widest< float, long double >
Widest< long double, double >
Widest< long double, float >
Widest< long double, long double >
Widest< R1, complex< R2 > >

Generated on Thu Feb 28 01:34:34 2008 for SimTKcommon by  doxygen 1.4.7