API  4.5
For C++ developers
OpenSim::Output< T >::Channel Class Reference
+ Inheritance diagram for OpenSim::Output< T >::Channel:

Public Member Functions

 Channel ()=default
 
 Channel (const Output< T > *output, const std::string &channelName)
 
const T & getValue (const SimTK::State &state) const
 
const Output< T > & getOutput () const
 
const std::string & getChannelName () const override
 The name of this channel, or the name of the output that contains this Channel if it's in a single-value Output. More...
 
std::string getTypeName () const override
 The name of the value type (e.g., double) produced by this channel. More...
 
std::string getName () const override
 The name of this channel appended to the name of the output that contains this channel. More...
 
std::string getPathName () const override
 This returns the absolute path name of the component to which this channel belongs prepended to the channel's name. More...
 
- Public Member Functions inherited from OpenSim::AbstractChannel
virtual ~AbstractChannel ()=default
 

Friends

Output< T > & Output (const Output &)
 

Constructor & Destructor Documentation

◆ Channel() [1/2]

template<class T>
OpenSim::Output< T >::Channel::Channel ( )
default

◆ Channel() [2/2]

template<class T>
OpenSim::Output< T >::Channel::Channel ( const Output< T > *  output,
const std::string &  channelName 
)
inline

Member Function Documentation

◆ getChannelName()

template<class T>
const std::string& OpenSim::Output< T >::Channel::getChannelName ( ) const
inlineoverridevirtual

The name of this channel, or the name of the output that contains this Channel if it's in a single-value Output.

Implements OpenSim::AbstractChannel.

◆ getName()

template<class T>
std::string OpenSim::Output< T >::Channel::getName ( ) const
inlineoverridevirtual

The name of this channel appended to the name of the output that contains this channel.

The output name and channel name are separated by a colon (e.g., "markers:medial_knee"). If the output that contains this channel is a single-value Output, then this is just the Output's name.

Implements OpenSim::AbstractChannel.

◆ getOutput()

template<class T>
const Output<T>& OpenSim::Output< T >::Channel::getOutput ( ) const
inline

◆ getPathName()

template<class T>
std::string OpenSim::Output< T >::Channel::getPathName ( ) const
inlineoverridevirtual

This returns the absolute path name of the component to which this channel belongs prepended to the channel's name.

For example, this method might return something like "/model/metabolics|heat_rate:soleus_r".

Implements OpenSim::AbstractChannel.

References OpenSim::AbstractOutput::getName().

Referenced by OpenSim::Input< T >::getLabel().

◆ getTypeName()

template<class T>
std::string OpenSim::Output< T >::Channel::getTypeName ( ) const
inlineoverridevirtual

The name of the value type (e.g., double) produced by this channel.

Implements OpenSim::AbstractChannel.

◆ getValue()

template<class T>
const T& OpenSim::Output< T >::Channel::getValue ( const SimTK::State &  state) const
inline

Friends And Related Function Documentation

◆ Output

template<class T>
Output<T>& Output ( const Output )
friend

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