![]() |
API
4.5
For C++ developers
|
A class for holding a set of path points. More...
Public Types | |
typedef PathPointSet | Self |
This typedef might be useful within the member functions of this class. More... | |
typedef Set< AbstractPathPoint > | Super |
Use this typedef to refer to the superclass of this class. More... | |
![]() | |
typedef Set | 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... | |
Auto-generated functions | |
static PathPointSet * | safeDownCast (OpenSim::Object *obj) |
For use in MATLAB and Python to access the concrete class. More... | |
static const std::string & | getClassName () |
This returns "PathPointSet". More... | |
void | assign (Object &aObject) override |
This allows copy assignment in the Java GUI. More... | |
PathPointSet * | 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 | |
![]() | |
virtual | ~Set () |
Destructor. More... | |
Set () | |
Default constructor. More... | |
Set (const std::string &aFileName, bool aUpdateFromXMLNode=true) | |
Construct from file. More... | |
Set (const Set< AbstractPathPoint, Object > &aSet) | |
Copy constructor. More... | |
void | setupGroups () |
Setup groups (match group member names to set members). More... | |
Set< AbstractPathPoint, Object > & | operator= (const Set< AbstractPathPoint, Object > &set) |
Assign this set to another set. More... | |
AbstractPathPoint & | operator[] (int aIndex) const |
Get a pointer to the set object at a specified index. More... | |
void | setMemoryOwner (bool aTrueFalse) |
Set whether or not this Set owns the memory pointed to by the pointers it holds. More... | |
bool | getMemoryOwner () const |
Get whether or not this array owns the memory pointed to by the pointers in its array. More... | |
bool | computeNewCapacity (int aMinCapacity, int &rNewCapacity) |
Compute a new capacity that is at least as large as a specified minimum capacity; this method does not change the capacity, it simply computes a new recommended capacity. More... | |
bool | ensureCapacity (int aCapacity) |
Ensure that the capacity of this array is at least the specified amount. More... | |
void | trim () |
Trim the capacity of this array so that it is one larger than the size of this array. More... | |
int | getCapacity () const |
Get the capacity of this storage instance. More... | |
void | setCapacityIncrement (int aIncrement) |
Set the amount by which the capacity is increased when the capacity of of the array in exceeded. More... | |
int | getCapacityIncrement () const |
Get the amount by which the capacity is increased. More... | |
virtual bool | setSize (int aSize) |
Set the size of the array. More... | |
int | getSize () const |
Get the size of the array. More... | |
virtual int | getIndex (const AbstractPathPoint *aObject, int aStartIndex=0) const |
Get the index of an object. More... | |
virtual int | getIndex (const std::string &aName, int aStartIndex=0) const |
Get the index of an object by specifying its name. More... | |
void | getGroupNamesContaining (const std::string &aObjectName, Array< std::string > &rGroupNames) const |
Get names of groups containing a given object. More... | |
virtual bool | adoptAndAppend (AbstractPathPoint *aObject) |
Append to the array, and adopt passed in pointer. More... | |
virtual bool | cloneAndAppend (const AbstractPathPoint &aObject) |
cloneAndAppend creates a clone of the passed in object and appends the clone to the array. More... | |
virtual bool | insert (int aIndex, AbstractPathPoint *aObject) |
Insert an object into the array at a specified index. More... | |
virtual bool | insert (int aIndex, const AbstractPathPoint &aObject) |
Insert an object into the array at a specified index. More... | |
virtual bool | remove (int aIndex) |
Remove an object from the array at a specified index. More... | |
virtual bool | remove (const AbstractPathPoint *aObject) |
Remove an object from the array by specifying its address. More... | |
virtual void | clearAndDestroy () |
virtual bool | set (int aIndex, AbstractPathPoint *aObject, bool preserveGroups=false) |
Set the object at a specified index. More... | |
virtual bool | set (int aIndex, const AbstractPathPoint &aObject, bool preserveGroups=false) |
Set the object at a specified index. More... | |
virtual AbstractPathPoint & | get (int aIndex) const |
Get the value at a specified array index. More... | |
AbstractPathPoint & | get (const std::string &aName) |
Get the first object that has a specified name. More... | |
const AbstractPathPoint & | get (const std::string &aName) const |
bool | contains (const std::string &aName) const |
Get whether this Set contains any object with the specified name. More... | |
virtual void | getNames (OpenSim::Array< std::string > &rNames) const |
Get names of objects in the set. More... | |
virtual AbstractPathPoint * | getLast () const |
Get the last value in the array. More... | |
int | searchBinary (const AbstractPathPoint &aObject, bool aFindFirst=false, int aLo=-1, int aHi=-1) const |
Search for the largest value in the array that is less than or equal to a specified value. More... | |
int | getNumGroups () const |
Get the number of groups. More... | |
void | addGroup (const std::string &aGroupName) |
Add an empty group to the set. More... | |
void | removeGroup (const std::string &aGroupName) |
Remove a group from the set. More... | |
void | renameGroup (const std::string &oldGroupName, const std::string &newGroupName) |
Rename a group. More... | |
void | addObjectToGroup (const std::string &aGroupName, const std::string &aObjectName) |
Add an object to a group. More... | |
void | getGroupNames (Array< std::string > &rGroupNames) const |
Get names of all groups. More... | |
const ObjectGroup * | getGroup (const std::string &aGroupName) const |
Get a group by name. More... | |
const ObjectGroup * | getGroup (int aIndex) const |
Get a group by index. More... | |
void | assign (Object &aObject) override |
This allows copy assignment in the Java GUI. More... | |
Set * | clone () const override |
const std::string & | getConcreteClassName () const override |
![]() | |
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 > | |
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... | |
PropertySet & | getPropertySet () |
OBSOLETE: Get a reference to the PropertySet maintained by the Object. More... | |
const PropertySet & | getPropertySet () const |
![]() | |
static Set * | safeDownCast (OpenSim::Object *obj) |
For use in MATLAB and Python to access the concrete class. More... | |
static const std::string & | getClassName () |
This returns "Set_<T>_". More... | |
![]() | |
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 Object * | getDefaultInstanceOfType (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 Object * | newInstanceOfType (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 Object * | makeObjectFromFile (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 Object * | SafeCopy (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 const std::string | DEFAULT_NAME |
Name used for default objects when they are serialized. More... | |
![]() | |
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 *doc) |
Unconditionally set the XMLDocument associated with this object. More... | |
const XMLDocument * | getDocument () const |
Get a const pointer to the document (if any) associated with this object. More... | |
XMLDocument * | updDocument () |
Get a writable pointer to the document (if any) associated with this object. More... | |
![]() | |
PropertyObjArray< AbstractPathPoint > | _propObjects |
Array of pointers to objects. More... | |
PropertyObjArray< ObjectGroup > | _propObjectGroups |
Array of pointers to object groups. More... | |
ArrayPtrs< AbstractPathPoint > & | _objects |
ArrayPtrs< ObjectGroup > & | _objectGroups |
![]() | |
PropertySet | _propertySet |
OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More... | |
![]() | |
#define | OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass) |
Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object. More... | |
#define | OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass) |
Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object. More... | |
#define | OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass) |
Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>. More... | |
#define | OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass) |
Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object. More... | |
A class for holding a set of path points.
This typedef might be useful within the member functions of this class.
This is generated by the OpenSim_DECLARE_*_OBJECT
macros.
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.
|
inlineoverride |
This allows copy assignment in the Java GUI.
Exception | if the argument is not of type PathPointSet. |
|
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::Object.
|
inlinestatic |
This returns "PathPointSet".
See getConcreteClassName() if you want the class name of the underlying concrete object instead.
This is generated by the OpenSim_DECLARE_*_OBJECT
macros.
|
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.
Implements OpenSim::Object.
|
inlinestatic |
For use in MATLAB and Python to access the concrete class.
Example: cObj = PathPointSet.safeDownCast(obj)
. This is equivalent to dynamic_cast<PathPointSet*>(obj)
in C++.