API  4.5.1
For C++ developers
OpenSim::TableSource_< ET > Class Template Reference

Component representing a source of data from a TimeSeriesTable_. More...

+ Inheritance diagram for OpenSim::TableSource_< ET >:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (single-value)
std::string filename
 "Path to the file to populate the TableSource_ " "with. The path is relative to the working " "directory, not relative to the directory " "containing the model file." More...
 
std::string tablename
 "Name of the table in the file to populate the " "TableSource with. Ex. 'markers', 'forces'." More...
 
Outputs
Vector all_columns
 Provides the value of getRowAtTime() and is available at stage SimTK::Stage::Time . More...
 
Outputs (list)
ET column
 Provides the value of getColumnAtTime() and is available at stage SimTK::Stage::Time . More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::Component
Component components
 "List of components that this component owns and serializes." More...
 

Public Member Functions

 TableSource_ ()
 
 TableSource_ (const TableSource_ &)=default
 
 TableSource_ (TableSource_ &&)=default
 
TableSource_operator= (const TableSource_ &)=default
 
TableSource_operator= (TableSource_ &&)=default
 
 TableSource_ (const Table &table)
 Construct the TableSource_ by giving it a TimeSeriesTable_ to hold. More...
 
 TableSource_ (const std::string &filename)
 Construct the TableSource_ from a file. More...
 
 TableSource_ (const std::string &filename, const std::string &tablename)
 Construct the TableSource_ from a file. More...
 
Property-related functions
const std::string & get_filename () const
 Get the value of the filename property. More...
 
std::string & upd_filename ()
 Get a writable reference to the filename property. More...
 
void set_filename (const std::string &value)
 Set the value of the filename property. More...
 
const std::string & get_tablename () const
 Get the value of the tablename property. More...
 
std::string & upd_tablename ()
 Get a writable reference to the tablename property. More...
 
void set_tablename (const std::string &value)
 Set the value of the tablename property. More...
 
Get/Set underlying TimeSeriesTable_
const TablegetTable () const
 Get a read-only reference to the TimeSeriesTable_ this TableSource_ currently holds. More...
 
void setTable (const Table &table)
 Replace the existing TimeSeriesTable_ that this TableSource_ currently holds. More...
 
void setTable (const std::string &filename)
 Replace the TimeSeriesTable_ that this TableSource_ currently holds. More...
 
void setTable (const std::string &filename, const std::string &tablename)
 Replace the TimeSeriesTable_ that this TableSource_ currently holds. More...
 
- Public Member Functions inherited from OpenSim::Component
 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...
 
Componentoperator= (const Component &)=default
 
virtual ~Component ()=default
 Destructor is virtual to allow concrete Component to cleanup. More...
 
virtual void generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
 Optional method for generating arbitrary display geometry that reflects this Component at the specified state. 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 ComponentgetComponent (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)
 
ComponentupdComponent (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...
 
Array< std::string > getDiscreteVariableNames () const
 Get the names of discrete state variables maintained by the Component and its subcomponents. More...
 
Array< std::string > getModelingOptionNames () const
 Get the names of the modeling options maintained by the Component and its subcomponents. 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 () const
 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...
 
template<typename T >
const T & getConnectee (const std::string &name, int index) const
 Get the "connectee" object at the provided index that the Component's Socket is bound to. More...
 
const ObjectgetConnectee (const std::string &name) const
 Get the connectee as an Object. More...
 
const ObjectgetConnectee (const std::string &name, int index) const
 Get the connectee at the provided index as an Object. More...
 
const AbstractSockettryGetSocket (const std::string &name) const
 Returns a pointer to the AbstractSocket with a given socket name, or nullptr if the socket with the given name does not exist on the component. More...
 
const AbstractSocketgetSocket (const std::string &name) const
 Get an AbstractSocket for the given socket name. More...
 
const AbstractSockettryUpdSocket (const std::string &name)
 Returns a writable pointer to the AbstractSocket with a given socket name, or nullptr if the socket with the given name does not exist on the component. More...
 
AbstractSocketupdSocket (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...
 
int getModelingOption (const SimTK::State &state, const std::string &path) const
 Based on a specified path, get the value of a modeling option. More...
 
int getModelingOption (const SimTK::State &state, const ComponentPath &path) const
 
void setModelingOption (SimTK::State &state, const std::string &path, int flag) const
 Based on a specified path, set the value of a modeling option. More...
 
void setModelingOption (SimTK::State &state, const ComponentPath &path, int flag) const
 
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...
 
double getStateVariableValue (const SimTK::State &state, const ComponentPath &path) 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 getStateVariableDerivativeValue (const SimTK::State &state, const ComponentPath &path) const
 Get the value of a state variable derivative computed by this Component. More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. 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 AbstractInputgetInput (const std::string &name) const
 Get an Input provided by this Component by name. More...
 
AbstractInputupdInput (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 AbstractOutputtryGetOutput (const std::string &name) const
 If it exists on the component, returns a pointer to the named Output; otherwise, returns a nullptr. More...
 
const AbstractOutputgetOutput (const std::string &name) const
 Get the Output provided by this Component by name. More...
 
AbstractOutputtryUpdOutput (const std::string &name)
 If it exists on the component returns a writable pointer to the named Output; otherwise, returns a nullptr More...
 
AbstractOutputupdOutput (const std::string &name)
 Get a writable reference to an Output provided by this Component by name. More...
 
SimTK::IteratorRange< OutputConstIteratorgetOutputs () const
 Iterate through all Outputs of this component. More...
 
- Public Member Functions inherited from OpenSim::Object
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...
 
Objectoperator= (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 AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (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 AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (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 >
const Property< T > & getPropertyByName (const std::string &name) 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...
 
template<class T >
Property< T > & updPropertyByName (const std::string &name)
 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...
 
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element. 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...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Public Types

typedef TableSource_ Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Component Super
 Use this typedef to refer to the superclass of this class. More...
 
typedef TimeSeriesTable_< ET > Table
 Type of the TimeSeriesTable_ this Component will hold. More...
 
typedef SimTK::Vector_< ET > Vector
 Type of the 'row' Output of this Component. More...
 
- Public Types inherited from OpenSim::Component
typedef Component Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Object Super
 Use this typedef to refer to the superclass of this class. More...
 
typedef std::map< std::string, SimTK::ClonePtr< AbstractOutput > >::const_iterator OutputConstIterator
 Define OutputConstIterator for convenience. More...
 

Protected Member Functions

void setTable_impl (const Table &table)
 
ET getColumnAtTime (const SimTK::State &state, const std::string &columnLabel) const
 Retrieve value of a column at a given time(implicit in the State provided). More...
 
Vector getRowAtTime (const SimTK::State &state) const
 Retrieve a row of the TimeSeriesTable_ at a given time (specified by the state). More...
 
- Protected Member Functions inherited from OpenSim::Component
const Componentget_components (int i) const
 Get the value of the i-th element of the components property. More...
 
Componentupd_components (int i)
 Get a writable reference to the i-th element of the components property. More...
 
void set_components (int i, const Component &value)
 Set the value of the i-th element of components property. More...
 
int append_components (const Component &value)
 Append an element to the components property. More...
 
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 Define a new single-value property of known type T, with the given name, associated comment, and initial value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value. More...
 
template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
template<class T >
PropertyIndex getPropertyIndex () const
 Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found. More...
 
template<class T >
void checkPropertyValueIsPositive (const Property< T > &p) const
 Throw an exception if any of the property's values are not positive. More...
 
template<class T >
void checkPropertyValueIsInSet (const Property< T > &p, const std::set< T > &set) const
 Throw an exception if any of the property's values are not in the provided set. More...
 
template<class T >
void checkPropertyValueIsInRangeOrSet (const Property< T > &p, const T &lower, const T &upper, const std::set< T > &set) const
 Throw an exception if any of the property's values are neither in the provided range nor in the provided set. More...
 
void setObjectIsUpToDateWithProperties ()
 When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
void makeObjectNamesConsistentWithProperties ()
 Make sure the name of an object is consistent with its property type. More...
 
void updateFromXMLDocument ()
 Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input. More...
 
void setDocument (XMLDocument *)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 

Auto-generated functions

static TableSource_safeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "TableSource__<T>_". More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
TableSource_clone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Component
static ComponentsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Component". More...
 
- Static Public Member Functions inherited from OpenSim::Object
static void registerType (const Object &defaultObject)
 Register an instance of a class; if the class is already registered it will be replaced. More...
 
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name. More...
 
static const ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...
 
template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
static ObjectmakeObjectFromFile (const std::string &fileName)
 Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
static bool isKindOf (const char *type)
 Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...
 
static void setDebugLevel (int newLevel)
 Set the amount of logging output. More...
 
static int getDebugLevel ()
 Get the current setting of debug level. More...
 
static ObjectSafeCopy (const Object *aObject)
 Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...
 

Detailed Description

template<typename ET>
class OpenSim::TableSource_< ET >

Component representing a source of data from a TimeSeriesTable_.

This Component has two outputs:

Construct this Component by giving it a TimeSeriesTable_. Then use it by connecting its output to the Input of another Component that accepts compatible type of Input. Make sure to populate the column-labels of the TimeSeriesTable_ before connecting this Component to the input of another Component.

Template Parameters
ETType of each element of the TimeSeriesTable_ this Component represents.

Member Typedef Documentation

◆ Self

template<typename ET >
typedef TableSource_ OpenSim::TableSource_< ET >::Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

template<typename ET >
typedef Component OpenSim::TableSource_< ET >::Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Table

template<typename ET >
typedef TimeSeriesTable_<ET> OpenSim::TableSource_< ET >::Table

Type of the TimeSeriesTable_ this Component will hold.

◆ Vector

template<typename ET >
typedef SimTK::Vector_<ET> OpenSim::TableSource_< ET >::Vector

Type of the 'row' Output of this Component.

Constructor & Destructor Documentation

◆ TableSource_() [1/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( )
inline

◆ TableSource_() [2/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( const TableSource_< ET > &  )
default

◆ TableSource_() [3/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( TableSource_< ET > &&  )
default

◆ TableSource_() [4/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( const Table table)
inline

Construct the TableSource_ by giving it a TimeSeriesTable_ to hold.

◆ TableSource_() [5/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( const std::string &  filename)
inline

Construct the TableSource_ from a file.

Parameters
filenameName of the file.
Exceptions
KeyNotFoundIf table provided does not have column-labels.

References OpenSim::TableSource_< ET >::filename.

◆ TableSource_() [6/6]

template<typename ET >
OpenSim::TableSource_< ET >::TableSource_ ( const std::string &  filename,
const std::string &  tablename 
)
inline

Construct the TableSource_ from a file.

Parameters
filenameName of the file.
tablenameName of the table in the file to populate the TableSource with. Ex. 'markers', 'forces'.
Exceptions
KeyNotFoundIf table provided does not have column-labels.

References OpenSim::TableSource_< ET >::filename, OpenSim::TableSource_< ET >::setTable(), and OpenSim::TableSource_< ET >::tablename.

Member Function Documentation

◆ assign()

template<typename ET >
void OpenSim::TableSource_< ET >::assign ( Object aObject)
inlineoverride

This allows copy assignment in the Java GUI.

Exceptions
Exceptionif the argument is not of type TableSource_.

◆ clone()

template<typename ET >
TableSource_* OpenSim::TableSource_< ET >::clone ( ) const
inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Component.

◆ get_filename()

template<typename ET >
const std::string& OpenSim::TableSource_< ET >::get_filename ( ) const
inline

Get the value of the filename property.

◆ get_tablename()

template<typename ET >
const std::string& OpenSim::TableSource_< ET >::get_tablename ( ) const
inline

Get the value of the tablename property.

◆ getClassName()

template<typename ET >
static const std::string& OpenSim::TableSource_< ET >::getClassName ( )
inlinestatic

This returns "TableSource__<T>_".

T is the template argument for this class. See getConcreteClassName() if you want the class name of the underlying concrete object instead.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getColumnAtTime()

template<typename ET >
ET OpenSim::TableSource_< ET >::getColumnAtTime ( const SimTK::State &  state,
const std::string &  columnLabel 
) const
inlineprotected

Retrieve value of a column at a given time(implicit in the State provided).

Linear interpolation is performed if the TimeSeriesTable_ does not contain an entry for the time mentioned by the state.

Exceptions
EmptyTableIf the TimeSeriesTable_ this TableSource_ holds is currently empty.
TimeOutOfRangeIf the time specified by the State is either less than the smallest timestamp or greater than the largest timestamp in the TimeSeriesTable_.
KeyNotFoundIf TimeSeriesTable_ does not have column-labels.

References OpenSim::AbstractDataTable::getColumnIndex(), OpenSim::DataTable_< ETX, ETY >::getIndependentColumn(), OpenSim::DataTable_< ETX, ETY >::getMatrix(), and OpenSim::AbstractDataTable::getNumRows().

◆ getConcreteClassName()

template<typename ET >
const std::string& OpenSim::TableSource_< ET >::getConcreteClassName ( ) const
inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also
getClassName()

Implements OpenSim::Component.

◆ getRowAtTime()

template<typename ET >
Vector OpenSim::TableSource_< ET >::getRowAtTime ( const SimTK::State &  state) const
inlineprotected

Retrieve a row of the TimeSeriesTable_ at a given time (specified by the state).

Linear interpolation is performed if the TimeSeriesTable_ does not have an entry for the time mentioned by the state.

Exceptions
EmptyTableIf the TimeSeriesTable_ this TableSource_ holds is currently empty.
TimeOutOfRangeIf the time specified by the State is either less than the smallest timestamp or greater than the largest timestamp in the TimeSeriesTable_.

References OpenSim::DataTable_< ETX, ETY >::getIndependentColumn(), OpenSim::AbstractDataTable::getNumRows(), and OpenSim::DataTable_< ETX, ETY >::getRowAtIndex().

◆ getTable()

template<typename ET >
const Table& OpenSim::TableSource_< ET >::getTable ( ) const
inline

Get a read-only reference to the TimeSeriesTable_ this TableSource_ currently holds.

◆ operator=() [1/2]

template<typename ET >
TableSource_& OpenSim::TableSource_< ET >::operator= ( const TableSource_< ET > &  )
default

◆ operator=() [2/2]

template<typename ET >
TableSource_& OpenSim::TableSource_< ET >::operator= ( TableSource_< ET > &&  )
default

◆ safeDownCast()

template<typename ET >
static TableSource_* OpenSim::TableSource_< ET >::safeDownCast ( OpenSim::Object obj)
inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = TableSource_.safeDownCast(obj). This is equivalent to dynamic_cast<TableSource_*>(obj) in C++.

◆ set_filename()

template<typename ET >
void OpenSim::TableSource_< ET >::set_filename ( const std::string &  value)
inline

Set the value of the filename property.

Referenced by OpenSim::TableSource_< ET >::setTable().

◆ set_tablename()

template<typename ET >
void OpenSim::TableSource_< ET >::set_tablename ( const std::string &  value)
inline

Set the value of the tablename property.

Referenced by OpenSim::TableSource_< ET >::setTable().

◆ setTable() [1/3]

template<typename ET >
void OpenSim::TableSource_< ET >::setTable ( const Table table)
inline

Replace the existing TimeSeriesTable_ that this TableSource_ currently holds.

The properties 'filename' and 'tablename' are reset to empty strings as a result of this operation.

Exceptions
KeyNotFoundIf table provided does not have column labels.

References OpenSim::TableSource_< ET >::set_filename(), OpenSim::TableSource_< ET >::set_tablename(), and OpenSim::TableSource_< ET >::setTable_impl().

Referenced by OpenSim::TableSource_< ET >::TableSource_().

◆ setTable() [2/3]

template<typename ET >
void OpenSim::TableSource_< ET >::setTable ( const std::string &  filename)
inline

Replace the TimeSeriesTable_ that this TableSource_ currently holds.

Property 'filename' is reset to the value provided. Property 'tablename' is reset to the empty string as a result of this operation.

Exceptions
InvalidCallIf property filename is set. This call is not allowed if filename property is set.
KeyNotFoundIf table provided does not have column labels.

References OpenSim::TableSource_< ET >::filename, OpenSim::TableSource_< ET >::set_filename(), OpenSim::TableSource_< ET >::set_tablename(), and OpenSim::TableSource_< ET >::setTable_impl().

◆ setTable() [3/3]

template<typename ET >
void OpenSim::TableSource_< ET >::setTable ( const std::string &  filename,
const std::string &  tablename 
)
inline

Replace the TimeSeriesTable_ that this TableSource_ currently holds.

Properties 'filename' and 'tablename' are reset to the values provided.

Parameters
filenameName of the file.
tablenameName of the table in the file to construct the TimeSeriesTable_ from. For example, a c3d file contains tables named 'markers' and 'forces'.
Exceptions
InvalidCallIf property filename is set. This call is not allowed if filename property is set.
KeyNotFoundIf table provided does not have column labels.

References OpenSim::TableSource_< ET >::filename, OpenSim::TableSource_< ET >::set_filename(), OpenSim::TableSource_< ET >::set_tablename(), OpenSim::TableSource_< ET >::setTable_impl(), and OpenSim::TableSource_< ET >::tablename.

◆ setTable_impl()

template<typename ET >
void OpenSim::TableSource_< ET >::setTable_impl ( const Table table)
inlineprotected

◆ upd_filename()

template<typename ET >
std::string& OpenSim::TableSource_< ET >::upd_filename ( )
inline

Get a writable reference to the filename property.

◆ upd_tablename()

template<typename ET >
std::string& OpenSim::TableSource_< ET >::upd_tablename ( )
inline

Get a writable reference to the tablename property.

OpenSim Property, Socket, Output, Input Documentation

◆ all_columns

template<typename ET >
Vector OpenSim::TableSource_< ET >::all_columns

Provides the value of getRowAtTime() and is available at stage SimTK::Stage::Time .

This output was generated with the OpenSim_DECLARE_OUTPUT macro.

◆ column

template<typename ET >
ET OpenSim::TableSource_< ET >::column

Provides the value of getColumnAtTime() and is available at stage SimTK::Stage::Time .

This output can have multiple channels. TODO This output was generated with the OpenSim_DECLARE_LIST_OUTPUT macro.

◆ filename

template<typename ET >
std::string OpenSim::TableSource_< ET >::filename

"Path to the file to populate the TableSource_ " "with. The path is relative to the working " "directory, not relative to the directory " "containing the model file."

This property appears in XML files under the tag <filename>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_filename(), upd_filename(), set_filename()

Referenced by OpenSim::TableSource_< ET >::setTable(), and OpenSim::TableSource_< ET >::TableSource_().

◆ tablename

template<typename ET >
std::string OpenSim::TableSource_< ET >::tablename

"Name of the table in the file to populate the " "TableSource with. Ex. 'markers', 'forces'."

This property appears in XML files under the tag <tablename>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_tablename(), upd_tablename(), set_tablename()

Referenced by OpenSim::TableSource_< ET >::setTable(), and OpenSim::TableSource_< ET >::TableSource_().


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