|
| Torus () |
| Default constructor. More...
|
|
| Torus (const double ringRadius, const double crossSectionRadius) |
| Constructor that takes in two radii. More...
|
|
virtual | ~Torus () |
|
|
const double & | get_cross_section () const |
| Get the value of the cross_section property. More...
|
|
double & | upd_cross_section () |
| Get a writable reference to the cross_section property. More...
|
|
void | set_cross_section (const double &value) |
| Set the value of the cross_section property. More...
|
|
const double & | get_ring_radius () const |
| Get the value of the ring_radius property. More...
|
|
double & | upd_ring_radius () |
| Get a writable reference to the ring_radius property. More...
|
|
void | set_ring_radius (const double &value) |
| Set the value of the ring_radius property. More...
|
|
| AnalyticGeometry () |
|
virtual | ~AnalyticGeometry () |
|
| Geometry () |
| Default constructor. More...
|
|
| Geometry (const Frame &frame) |
| Convenience constructor that takes a Frame. More...
|
|
virtual | ~Geometry () |
| Default destructor. More...
|
|
void | setFrame (const Frame &frame) |
| Interface methods to handle the Frame which the Geometry is attached to. More...
|
|
const Frame & | getFrame () const |
| Return a reference to the name of the Frame to which this Geometry is attached (using a Socket). More...
|
|
void | setColor (const SimTK::Vec3 &color) |
| Convenient access to set Appearance/Color color is RGB, each components is in the range [0, 1]. More...
|
|
const SimTK::Vec3 & | getColor () const |
| Convenient access to get Appearance/Color returns RGB , each components is in the range [0, 1]. More...
|
|
void | setOpacity (const double opacity) |
| Convenient access to set Appearance/Opacity. More...
|
|
double | getOpacity () |
| Convenient access to get Appearance/Opacity. More...
|
|
void | setRepresentation (OpenSim::VisualRepresentation rep) |
| Convenient access to set Appearance/representation. More...
|
|
OpenSim::VisualRepresentation | getRepresentation () |
| Convenient access to get Appearance/representation. More...
|
|
void | generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const override |
| Implement method from Component interface. More...
|
|
const SimTK::Vec3 & | get_scale_factors () const |
| Get the value of the scale_factors property. More...
|
|
SimTK::Vec3 & | upd_scale_factors () |
| Get a writable reference to the scale_factors property. More...
|
|
void | set_scale_factors (const SimTK::Vec3 &value) |
| Set the value of the scale_factors property. More...
|
|
const Appearance & | get_Appearance () const |
| Get the value of the Appearance property. More...
|
|
Appearance & | upd_Appearance () |
| Get a writable reference to the Appearance property. More...
|
|
void | set_Appearance (const Appearance &value) |
| Set the value of the Appearance property. More...
|
|
void | connectSocket_frame (const Object &object) |
| Connect the 'frame' Socket to an object of type Frame. More...
|
|
void | connectInput_transform (const AbstractOutput &output, const std::string &alias="") |
| Connect this Input to a single-valued (single-channel) Output. More...
|
|
void | connectInput_transform (const AbstractChannel &channel, const std::string &alias="") |
| Connect this Input to an output channel of type SimTK::Transform. More...
|
|
| Component () |
| Default constructor. More...
|
|
| Component (const std::string &aFileName, bool aUpdateFromXMLNode=true) |
| Construct Component from an XML file. More...
|
|
| Component (SimTK::Xml::Element &aNode) |
| Construct Component from a specific node in an XML document. More...
|
|
| Component (const Component &)=default |
| Use default copy constructor and assignment operator. More...
|
|
Component & | operator= (const Component &)=default |
|
virtual | ~Component ()=default |
| Destructor is virtual to allow concrete Component to cleanup. More...
|
|
const SimTK::MultibodySystem & | getSystem () const |
| Get the underlying MultibodySystem that this component is connected to. More...
|
|
bool | hasSystem () const |
| Check if this component has an underlying MultibodySystem. More...
|
|
bool | isComponentInOwnershipTree (const Component *component) const |
| Does the provided component already exist anywhere in the ownership tree (not just subcomponents of this component)? More...
|
|
void | addComponent (Component *subcomponent) |
|
Add a Component (as a subcomponent) of this component. More...
|
|
template<typename T = Component> |
ComponentList< const T > | getComponentList () const |
| Get an iterator through the underlying subcomponents that this component is composed of. More...
|
|
template<typename T = Component> |
ComponentList< T > | updComponentList () |
| Similar to getComponentList(), except the resulting list allows one to modify the components. More...
|
|
template<typename T = Component> |
unsigned | countNumComponents () const |
| Uses getComponentList<T>() to count the number of underlying subcomponents of the specified type. More...
|
|
std::string | getAbsolutePathString () const |
| Get the complete (absolute) pathname for this Component to its ancestral Component, which is the root of the tree to which this Component belongs. More...
|
|
ComponentPath | getAbsolutePath () const |
| Return a ComponentPath of the absolute path of this Component. More...
|
|
std::string | getRelativePathString (const Component &wrt) const |
| Get the relative path of this Component with respect to another Component, as a string. More...
|
|
ComponentPath | getRelativePath (const Component &wrt) const |
| Get the relative path of this Component with respect to another Component. More...
|
|
bool | hasComponent (const std::string &pathname) const |
| Query if there is a component (of any type) at the specified path name. More...
|
|
template<class C = Component> |
bool | hasComponent (const std::string &pathname) const |
| Query if there is a component of a given type at the specified path name. More...
|
|
template<class C = Component> |
const C & | getComponent (const std::string &pathname) const |
| Get a unique subcomponent of this Component by its path name and type 'C'. More...
|
|
template<class C = Component> |
const C & | getComponent (const ComponentPath &pathname) const |
|
const Component & | getComponent (const std::string &pathname) const |
| Similar to the templatized getComponent(), except this returns the component as the generic Component type. More...
|
|
template<class C = Component> |
C & | updComponent (const std::string &name) |
| Get a writable reference to a subcomponent. More...
|
|
template<class C = Component> |
C & | updComponent (const ComponentPath &name) |
|
Component & | updComponent (const std::string &pathname) |
| Similar to the templatized updComponent(), except this returns the component as the generic Component type. More...
|
|
unsigned | printComponentsMatching (const std::string &substring) const |
| Print a list to the console of all components whose absolute path name contains the given string. More...
|
|
int | getNumStateVariables () const |
| Get the number of "continuous" state variables maintained by the Component and its subcomponents. More...
|
|
Array< std::string > | getStateVariableNames () const |
| Get the names of "continuous" state variables maintained by the Component and its subcomponents. More...
|
|
template<class C = Component> |
const C * | findComponent (const ComponentPath &pathToFind) const |
| Find a Component to which this Component is an ancestor—in other words, a Component that is directly owned by this Component or is owned by one of its sub-components, sub-sub-components, etc. More...
|
|
template<class C = Component> |
const C * | findComponent (const std::string &pathToFind) const |
| Same as findComponent(const ComponentPath&), but accepting a string (a path or just a name) as input. More...
|
|
const StateVariable * | traverseToStateVariable (const std::string &pathName) const |
| Get a StateVariable anywhere in the Component tree, given a StateVariable path. More...
|
|
void | finalizeFromProperties () |
| Define a Component's internal data members and structure according to its properties. More...
|
|
void | finalizeConnections (Component &root) |
| Satisfy the Component's connections specified by its Sockets and Inputs. More...
|
|
void | clearConnections () |
| Disconnect/clear this Component from its aggregate component. More...
|
|
void | addToSystem (SimTK::MultibodySystem &system) const |
| Have the Component add itself to the underlying computational System. More...
|
|
void | initStateFromProperties (SimTK::State &state) const |
| Initialize Component's state variable values from its properties. More...
|
|
void | setPropertiesFromState (const SimTK::State &state) |
| Set Component's properties given a state. More...
|
|
int | getNumSockets () const |
| Get the number of Sockets in this Component. More...
|
|
std::vector< std::string > | getSocketNames () |
| Collect and return the names of the sockets in this component. More...
|
|
template<typename T > |
const T & | getConnectee (const std::string &name) const |
| Get the "connectee" object that the Component's Socket is bound to. More...
|
|
const Object & | getConnectee (const std::string &name) const |
| Get the connectee as an Object. More...
|
|
const AbstractSocket & | getSocket (const std::string &name) const |
| Get an AbstractSocket for the given socket name. More...
|
|
AbstractSocket & | updSocket (const std::string &name) |
| Get a writable reference to the AbstractSocket for the given socket name. More...
|
|
template<typename T > |
const Socket< T > & | getSocket (const std::string &name) const |
| Get a const reference to the concrete Socket provided by this Component by name. More...
|
|
template<typename T > |
Socket< T > & | updSocket (const std::string &name) |
| Get a writable reference to the concrete Socket provided by this Component by name. More...
|
|
void | printSubcomponentInfo () const |
| List all subcomponents by name and recurse into these components to list their subcomponents, and so on. More...
|
|
void | printSocketInfo () const |
| List all the Sockets of this component and whether or not they are connected. More...
|
|
void | printInputInfo () const |
| List all the inputs of this component and whether or not they are connected. More...
|
|
template<typename C > |
void | printSubcomponentInfo () const |
|
void | printOutputInfo (const bool includeDescendants=true) const |
| Print outputs of this component and optionally, those of all subcomponents. More...
|
|
int | getNumInputs () const |
| Access the number of Inputs that this component has. More...
|
|
int | getNumOutputs () const |
| Access the number of Outputs that this component has. More...
|
|
std::vector< std::string > | getInputNames () const |
| Collect and return the names of Inputs in this component as an std::vector. More...
|
|
std::vector< std::string > | getOutputNames () const |
| Collect and return the names of Outputs in this component as an std::vector. More...
|
|
const AbstractInput & | getInput (const std::string &name) const |
| Get an Input provided by this Component by name. More...
|
|
AbstractInput & | updInput (const std::string &name) |
| Get a writable reference to an Input provided by this Component by name. More...
|
|
template<typename T > |
const Input< T > & | getInput (const std::string &name) const |
| Get a concrete Input that you can directly ask for its values. More...
|
|
const AbstractOutput & | getOutput (const std::string &name) const |
| Get the Output provided by this Component by name. More...
|
|
AbstractOutput & | updOutput (const std::string &name) |
| Get a writable reference to an Output provided by this Component by name. More...
|
|
SimTK::IteratorRange< OutputConstIterator > | getOutputs () const |
| Iterate through all Outputs of this component. More...
|
|
int | getModelingOption (const SimTK::State &state, const std::string &name) const |
| Get a ModelingOption flag for this Component by name. More...
|
|
void | setModelingOption (SimTK::State &state, const std::string &name, int flag) const |
| Set the value of a ModelingOption flag for this Component. More...
|
|
template<typename T > |
const T & | getInputValue (const SimTK::State &state, const std::string &name) const |
| Get the Input value that this component is dependent on. More...
|
|
template<typename T > |
const T & | getOutputValue (const SimTK::State &state, const std::string &name) const |
| Get the Output value provided by this Component by name. More...
|
|
double | getStateVariableValue (const SimTK::State &state, const std::string &name) const |
| Get the value of a state variable allocated by this Component. More...
|
|
void | setStateVariableValue (SimTK::State &state, const std::string &name, double value) const |
| Set the value of a state variable allocated by this Component by name. More...
|
|
SimTK::Vector | getStateVariableValues (const SimTK::State &state) const |
| Get all values of the state variables allocated by this Component. More...
|
|
void | setStateVariableValues (SimTK::State &state, const SimTK::Vector &values) const |
| Set all values of the state variables allocated by this Component. More...
|
|
double | getStateVariableDerivativeValue (const SimTK::State &state, const std::string &name) const |
| Get the value of a state variable derivative computed by this Component. More...
|
|
double | getDiscreteVariableValue (const SimTK::State &state, const std::string &name) const |
| Get the value of a discrete variable allocated by this Component by name. More...
|
|
void | setDiscreteVariableValue (SimTK::State &state, const std::string &name, double value) const |
| Set the value of a discrete variable allocated by this Component by name. More...
|
|
template<class T > |
SimTK::CacheEntryIndex | getCacheVariableIndex (const CacheVariable< T > &cv) const |
| Get the index of a Component's cache variable in the Subsystem for allocations. More...
|
|
SimTK::CacheEntryIndex | getCacheVariableIndex (const std::string &name) const |
| Get the index of a Component's cache variable in the Subsystem for allocations. More...
|
|
template<class T > |
const T & | getCacheVariableValue (const SimTK::State &state, const std::string &name) const |
| Get the value of a cache variable allocated by this Component by name. More...
|
|
template<class T > |
const T & | getCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const |
| Get the value of a cache variable allocated by this Component. More...
|
|
template<typename T > |
void | setCacheVariableValue (const SimTK::State &state, const std::string &k, T value) const |
| Set the value of a cache variable, identified by name , to a new value and mark the cache variable as valid. More...
|
|
template<typename T > |
void | setCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv, T value) const |
| Set the value of a cache variable to a new value and mark the cache variable as valid. More...
|
|
template<typename T > |
T & | updCacheVariableValue (const SimTK::State &state, const std::string &name) const |
| Returns a mutable reference to the value of a cache variable identified by name . More...
|
|
template<typename T > |
T & | updCacheVariableValue (const SimTK::State &state, const CacheVariable< T > &cv) const |
| Returns a mutable reference to the value of a cache variable. More...
|
|
bool | isCacheVariableValid (const SimTK::State &state, const std::string &name) const |
| Returns true if the cache variable, identified by name , is valid. More...
|
|
template<class T > |
bool | isCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const |
| Returns true if the cache variable is valid. More...
|
|
void | markCacheVariableValid (const SimTK::State &state, const std::string &name) const |
| Marks the value of a cache variable, identified by name , as valid. More...
|
|
template<typename T > |
void | markCacheVariableValid (const SimTK::State &state, const CacheVariable< T > &cv) const |
| Marks the value of a cache variable as valid. More...
|
|
void | markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const |
| Marks the value of a cache variable, identified by name , as invalid. More...
|
|
template<class T > |
void | markCacheVariableInvalid (const SimTK::State &state, const CacheVariable< T > &cv) const |
| Marks the value of a cache variable as invalid. More...
|
|
const Component & | getOwner () const |
| Access the owner of this Component. More...
|
|
bool | hasOwner () const |
| (For advanced users) Check if this Component has an owner. More...
|
|
const Component & | getRoot () const |
| Obtain the root Component, which is this component if it is orphaned. More...
|
|
virtual | ~Object () |
| Virtual destructor for cleanup. More...
|
|
bool | isEqualTo (const Object &aObject) const |
| Equality operator wrapper for use from languages not supporting operator overloading. More...
|
|
Object & | operator= (const Object &aObject) |
| Copy assignment copies he base class fields, including the properties. More...
|
|
virtual bool | operator== (const Object &aObject) const |
| Determine if two objects are equal. More...
|
|
virtual bool | operator< (const Object &aObject) const |
| Provide an ordering for objects so they can be put in sorted containers. More...
|
|
void | setName (const std::string &name) |
| Set the name of the Object. More...
|
|
const std::string & | getName () const |
| Get the name of this Object. More...
|
|
void | setDescription (const std::string &description) |
| Set description, a one-liner summary. More...
|
|
const std::string & | getDescription () const |
| Get description, a one-liner summary. More...
|
|
const std::string & | getAuthors () const |
| Get Authors of this Object. More...
|
|
void | setAuthors (const std::string &authors) |
| Set Authors of this object. More...
|
|
const std::string & | getReferences () const |
| Get references or publications to cite if using this object. More...
|
|
void | setReferences (const std::string &references) |
| Set references or publications to cite if using this object. More...
|
|
int | getNumProperties () const |
| Determine how many properties are stored with this Object. More...
|
|
const AbstractProperty & | getPropertyByIndex (int propertyIndex) const |
| Get a const reference to a property by its index number, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByIndex (int propertyIndex) |
| Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
|
|
bool | hasProperty (const std::string &name) const |
| Return true if this Object has a property of any type with the given name, which must not be empty. More...
|
|
const AbstractProperty & | getPropertyByName (const std::string &name) const |
| Get a const reference to a property by its name, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByName (const std::string &name) |
| Get a writable reference to a property by its name, returned as an AbstractProperty. More...
|
|
template<class T > |
bool | hasProperty () const |
| Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...
|
|
template<class T > |
const Property< T > & | getProperty (const PropertyIndex &index) const |
| Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...
|
|
template<class T > |
Property< T > & | updProperty (const PropertyIndex &index) |
| Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...
|
|
bool | isObjectUpToDateWithProperties () const |
| Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
|
|
void | readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber) |
| We're given an XML element from which we are to populate this Object. More...
|
|
void | updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const |
| Serialize this object into the XML node that represents it. More...
|
|
bool | getInlined () const |
| Inlined means an in-memory Object that is not associated with an XMLDocument. More...
|
|
void | setInlined (bool aInlined, const std::string &aFileName="") |
| Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...
|
|
std::string | getDocumentFileName () const |
| If there is a document associated with this object then return the file name maintained by the document. More...
|
|
int | getDocumentFileVersion () const |
| If there is a document associated with this object then return its version number. More...
|
|
void | setAllPropertiesUseDefault (bool aUseDefault) |
|
bool | print (const std::string &fileName) const |
| Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
|
|
std::string | dump () const |
| dump the XML representation of this Object into an std::string and return it. More...
|
|
virtual bool | isA (const char *type) const |
| The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...
|
|
const std::string & | toString () const |
| Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
|
|
PropertySet & | getPropertySet () |
| OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
|
|
const PropertySet & | getPropertySet () const |
|