OpenSim::IKTool Class Reference
An investigation class for the IK solver. More...
#include <IKTool.h>
Public Member Functions | |
| virtual | ~IKTool () |
| Destructor. | |
| IKTool () | |
| Default constructor. | |
| IKTool (const std::string &aFileName, bool aLoadModel=true) SWIG_DECLARE_EXCEPTION | |
| IKTool (const IKTool &aObject) | |
| Copy constructor. | |
| virtual OpenSim::Object * | copy () const |
| Virtual copy constructor. | |
| IKTool & | operator= (const IKTool &aIKTool) |
| Assignment operator. | |
| IKTrialSet & | getIKTrialSet () |
| IKTaskSet & | getIKTaskSet () |
| bool | initializeTrial (const SimTK::State &s, int i) |
| bool | solveTrial (SimTK::State &s, int i) |
| virtual bool | run () SWIG_DECLARE_EXCEPTION |
| Run the investigation. | |
| bool | run (SimTK::State &state) |
| void | setPrintResultFiles (bool aToWrite) |
Static Public Member Functions | |
| static void | registerTypes () |
| Register IKTrial type. | |
Detailed Description
An investigation class for the IK solver.
- Version:
- 1.0
Constructor & Destructor Documentation
| IKTool::~IKTool | ( | ) | [virtual] |
Destructor.
| IKTool::IKTool | ( | ) |
Default constructor.
| OpenSim::IKTool::IKTool | ( | const std::string & | aFileName, | |
| bool | aLoadModel = true | |||
| ) |
| IKTool::IKTool | ( | const IKTool & | aTool | ) |
Copy constructor.
Copy constructors for all Tools only copy the non-XML variable members of the object; that is, the object's DOMnode and XMLDocument are not copied but set to NULL. The reason for this is that for the object and all its derived classes to establish the correct connection to the XML document nodes, the the object would need to reconstruct based on the XML document not the values of the object's member variables.
There are three proper ways to generate an XML document for a Tool:
1) Construction based on XML file (
- See also:
- Tool(const char *aFileName)). In this case, the XML document is created by parsing the XML file.
2) Construction by Tool(const XMLDocument *aDocument). This constructor explictly requests construction based on an XML document. In this way the proper connection between an object's node and the corresponding node within the XML document is established. This constructor is a copy constructor of sorts because all essential Tool member variables should be held within the XML document. The advantage of this style of construction is that nodes within the XML document, such as comments that may not have any associated Tool member variable, are preserved.
3) A call to generateXMLDocument(). This method generates an XML document for the Tool from scratch. Only the essential document nodes are created (that is, nodes that correspond directly to member variables.).
- Parameters:
-
aTool Object to be copied.
- See also:
- Tool(const XMLDocument *aDocument)
- Tool(const char *aFileName)
- generateXMLDocument()
Member Function Documentation
| Object * IKTool::copy | ( | ) | const [virtual] |
Virtual copy constructor.
Reimplemented from OpenSim::Object.
| IKTaskSet& OpenSim::IKTool::getIKTaskSet | ( | ) | [inline] |
| IKTrialSet& OpenSim::IKTool::getIKTrialSet | ( | ) | [inline] |
| bool IKTool::initializeTrial | ( | const SimTK::State & | s, | |
| int | i | |||
| ) |
| void IKTool::registerTypes | ( | ) | [static] |
Register IKTrial type.
| bool IKTool::run | ( | SimTK::State & | state | ) |
| bool IKTool::run | ( | ) | [virtual] |
Run the investigation.
Implements OpenSim::AbstractTool.
| void OpenSim::IKTool::setPrintResultFiles | ( | bool | aToWrite | ) | [inline] |
| bool IKTool::solveTrial | ( | SimTK::State & | s, | |
| int | i | |||
| ) |
The documentation for this class was generated from the following files:
- OpenSim/Tools/IKTool.h
- OpenSim/Tools/IKTool.cpp
