API
4.5
For C++ developers
|
A class for holding a set of pointers to objects. More...
Public Member Functions | |
virtual | ~Set () |
Destructor. More... | |
Set () | |
Default constructor. More... | |
Set (const std::string &aFileName, bool aUpdateFromXMLNode=true) | |
Construct from file. More... | |
Set (const Set< T, C > &aSet) | |
Copy constructor. More... | |
void | setupGroups () |
Setup groups (match group member names to set members). More... | |
Set< T, C > & | operator= (const Set< T, C > &set) |
Assign this set to another set. More... | |
T & | 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 T *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 (T *aObject) |
Append to the array, and adopt passed in pointer. More... | |
virtual bool | cloneAndAppend (const T &aObject) |
cloneAndAppend creates a clone of the passed in object and appends the clone to the array. More... | |
virtual bool | insert (int aIndex, T *aObject) |
Insert an object into the array at a specified index. More... | |
virtual bool | insert (int aIndex, const T &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 T *aObject) |
Remove an object from the array by specifying its address. More... | |
virtual void | clearAndDestroy () |
virtual bool | set (int aIndex, T *aObject, bool preserveGroups=false) |
Set the object at a specified index. More... | |
virtual bool | set (int aIndex, const T &aObject, bool preserveGroups=false) |
Set the object at a specified index. More... | |
virtual T & | get (int aIndex) const |
Get the value at a specified array index. More... | |
T & | get (const std::string &aName) |
Get the first object that has a specified name. More... | |
const T & | 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 T * | getLast () const |
Get the last value in the array. More... | |
int | searchBinary (const T &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... | |
Public Types | |
typedef Set | Self |
This typedef might be useful within the member functions of this class. More... | |
typedef C | Super |
Use this typedef to refer to the superclass of this class. More... | |
Protected Attributes | |
PropertyObjArray< T > | _propObjects |
Array of pointers to objects. More... | |
PropertyObjArray< ObjectGroup > | _propObjectGroups |
Array of pointers to object groups. More... | |
ArrayPtrs< T > & | _objects |
ArrayPtrs< ObjectGroup > & | _objectGroups |
Friends | |
std::ostream & | operator<< (std::ostream &aOut, const Set< T, C > &aSet) |
Implementation of the output operator. More... | |
Auto-generated functions | |
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... | |
void | assign (Object &aObject) override |
This allows copy assignment in the Java GUI. More... | |
Set * | clone () const override |
const std::string & | getConcreteClassName () const override |
A class for holding a set of pointers to objects.
It is derived from base class C and is implemented as a wrapper around template class ArrayPtrs<T>.
typedef Set OpenSim::Set< T, C >::Self |
This typedef might be useful within the member functions of this class.
This is generated by the OpenSim_DECLARE_*_OBJECT
macros.
typedef C OpenSim::Set< T, C >::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.
|
inlinevirtual |
Destructor.
|
inline |
Default constructor.
|
inline |
Construct from file.
aFileName | Name of the file. |
aUpdateFromXMLNode | Whether to update from XML. |
|
inline |
Copy constructor.
aSet | Set to be copied. |
|
inline |
Add an empty group to the set.
|
inline |
Add an object to a group.
|
inlinevirtual |
Append to the array, and adopt passed in pointer.
A copy is NOT made of the specified object. If getMemoryOwner() is true, this Set takes over ownership of the object and deletes it when the Set itself is deleted.
aObject | Object to be appended. |
Referenced by OpenSim::ModelScaler::addMeasurement(), OpenSim::ModelScaler::addScale(), and OpenSim::Set< Force, ModelComponent >::cloneAndAppend().
|
inlineoverride |
|
inlinevirtual |
|
inlineoverride |
Reimplemented in OpenSim::ModelComponentSet< ExternalForce >, OpenSim::ModelComponentSet< ContactGeometry >, OpenSim::ModelComponentSet< WrapObject >, OpenSim::ModelComponentSet< Force >, OpenSim::ModelComponentSet< Joint >, OpenSim::ModelComponentSet< Probe >, OpenSim::ModelComponentSet< Controller >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::ModelComponentSet< Marker >, OpenSim::ModelComponentSet< Body >, and OpenSim::ModelComponentSet< Constraint >.
|
inlinevirtual |
cloneAndAppend creates a clone of the passed in object and appends the clone to the array.
The original object is unaffected and is not associated with the Set. The clone is created using the method clone() available to OpenSim::Object
aObject | Object whose clone is to be appended. |
Referenced by OpenSim::IKTaskSet::createMarkerWeightSet().
|
inline |
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.
If the capacity increment is negative, the current capacity is doubled until the computed capacity is greater than or equal to the specified minimum capacity. If the capacity increment is positive, the current capacity increments by this amount until the computed capacity is greater than or equal to the specified minimum capacity. If the capacity increment is zero, the computed capacity is set to the current capacity and false is returned.
rNewCapacity | New computed capacity. |
aMinCapacity | Minimum new computed capacity. The computed capacity is incremented until it is at least as large as aMinCapacity, assuming the capacity increment is not zero. |
|
inline |
Get whether this Set contains any object with the specified name.
aName | Name of the desired object. |
Referenced by OpenSim::Set< Force, ModelComponent >::getGroupNamesContaining().
|
inline |
Ensure that the capacity of this array is at least the specified amount.
The newly allocated array elements are initialized to NULL.
aCapacity | Desired capacity. |
|
inlinevirtual |
Get the value at a specified array index.
If the index is negative or passed the end of the array, an exception is thrown.
For faster execution, the array elements can be accessed through the overloaded operator[], which does no bounds checking.
aIndex | Index of the desired array element. |
Exception | if (aIndex<0)||(aIndex>=_size) or if the pointer at aIndex is NULL. |
|
inline |
Get the first object that has a specified name.
If the array doesn't contain an object of the specified name, an exception is thrown.
aName | Name of the desired object. |
Exception | if no such object exists. |
|
inline |
|
inline |
Get the capacity of this storage instance.
|
inline |
Get the amount by which the capacity is increased.
|
inlinestatic |
This returns "Set_<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.
|
inlineoverride |
Reimplemented in OpenSim::ModelComponentSet< ExternalForce >, OpenSim::ModelComponentSet< ContactGeometry >, OpenSim::ModelComponentSet< WrapObject >, OpenSim::ModelComponentSet< Force >, OpenSim::ModelComponentSet< Joint >, OpenSim::ModelComponentSet< Probe >, OpenSim::ModelComponentSet< Controller >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::ModelComponentSet< Marker >, OpenSim::ModelComponentSet< Body >, and OpenSim::ModelComponentSet< Constraint >.
|
inline |
Get a group by name.
|
inline |
Get a group by index.
|
inline |
Get names of all groups.
|
inline |
Get names of groups containing a given object.
|
inlinevirtual |
Get the index of an object.
aObject | Address of the object whose index is sought. |
aStartIndex | Index at which to start searching. If the object is not found at or following aStartIndex, the array is searched from its beginning. |
|
inlinevirtual |
Get the index of an object by specifying its name.
aName | Name of the object whose index is sought. |
aStartIndex | Index at which to start searching. If the object is not found at or following aStartIndex, the array is searched from its beginning. |
|
inlinevirtual |
Get the last value in the array.
Exception | if the array is empty. |
|
inline |
Get whether or not this array owns the memory pointed to by the pointers in its array.
If the array is set to own the memory pointed to by its pointers, this array issues deletes for all these pointers upon the array's destruction. If not, this array does not issue deletes.
|
inlinevirtual |
Get names of objects in the set.
rNames | Array of names. The names are appended to rNames, so it is permissible to send in an non-empty array; the names in the set will simply be appended to the array sent in. |
|
inline |
Get the number of groups.
|
inline |
Get the size of the array.
Referenced by OpenSim::ProbeReporter::disableIntegrationOnlyProbes(), OpenSim::Measurement::getNumMarkerPairs(), and OpenSim::StateTrackingTask::getTaskErrorGradient().
|
inlinevirtual |
Insert an object into the array at a specified index.
A copy of the specified object is NOT made. If getMemoryOwner() is true, this Set takes over ownership of the object and deletes it when the Set itself is deleted.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aObject | Object to be inserted. |
aIndex | Index at which to insert the new object. All current elements from aIndex to the end of the array are shifted one place in the direction of the end of the array. The specified index must be less than or equal to the size of the array. Note that if aIndex is equal to the size of the array, the insertion is equivalent to an append. |
Reimplemented in OpenSim::ForceSet.
Referenced by OpenSim::Set< Force, ModelComponent >::insert().
|
inlinevirtual |
Insert an object into the array at a specified index.
A copy is made of the object and added to the Set. The original object is unaffected.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aObject | Object to be inserted. |
aIndex | Index at which to insert the new object. All current elements from aIndex to the end of the array are shifted one place in the direction of the end of the array. The specified index must be less than or equal to the size of the array. Note that if aIndex is equal to the size of the array, the insertion is equivalent to an append. |
|
inline |
Assign this set to another set.
This operator makes a complete copy of the specified set; all member variables and objects in the set are copied. Because all objects are copied, this set takes ownership of the newly allocated objects (i.e., _memoryOwner is set to true. So, the result is two independent, identical sets, with the possible exception of the _memoryOwner flag.
set | The Set to be copied. |
Referenced by OpenSim::IKTaskSet::operator=().
|
inline |
Get a pointer to the set object at a specified index.
This operator is intended for accessing set objects with as little overhead as possible, so no error checking is performed. The caller must make sure the specified index is within the bounds of the array. If error checking is desired, use ArrayPtrs::get().
aIndex | Index of the desired element (0 <= aIndex < _size). |
Exception | if a NULL pointer is encountered. |
|
inlinevirtual |
Remove an object from the array at a specified index.
If this set is set as the memory owner, the object is deleted when it is removed.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aIndex | Index of the value to remove. All elements from aIndex to the end of the array are shifted one place toward the beginning of the array. If aIndex is less than 0 or greater than or equal to the current size of the array, no element is removed. |
Reimplemented in OpenSim::ForceSet.
|
inlinevirtual |
Remove an object from the array by specifying its address.
The object is deleted when it is removed.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aObject | Pointer to the object to be removed. If an object with the specified address is not found, no action is taken. |
|
inline |
Remove a group from the set.
Elements are not removed.
|
inline |
Rename a group.
|
inlinestatic |
For use in MATLAB and Python to access the concrete class.
Example: cObj = Set.safeDownCast(obj)
. This is equivalent to dynamic_cast<Set*>(obj)
in C++.
|
inline |
Search for the largest value in the array that is less than or equal to a specified value.
If there is more than one element with this largest value, the index of the first of these elements can optionally be found, but this can be up to twice as costly.
This method assumes that the array element values monotonically increase as the array index increases. Note that monotonically increase means never decrease, so it is permissible for adjacent elements to have the same value.
A binary search is performed (i.e., the array is repeatedly subdivided into two bins one of which must contain the specified until the appropriate element is identified), so the performance of this method is approximately ln(n), where n is the size of the array.
aObject | Value to which the array elements are compared. |
aFindFirst | If true, find the first element that satisfies the search. If false, the index of any element that satisfies the search can be returned- which index will be returned depends on the length of the array and is therefore somewhat arbitrary. By default, this flag is false. |
aLo | Lowest array index to consider in the search. |
aHi | Highest array index to consider in the search. |
|
inlinevirtual |
Set the object at a specified index.
A copy of the object is NOT made. If getMemoryOwner() is true, this Set takes over ownership of the object and deletes it when the Set itself is deleted.
aIndex | Index of the array element to be set. aIndex must be greater than zero and less than or equal to the size of the array. Note that if aIndex is equal to the size of the array, the set is equivalent to an append. |
aObject | Object to be set. |
preserveGroups | If true, the new object will be added to the groups that the object it replaces belonged to |
Reimplemented in OpenSim::ForceSet.
|
inlinevirtual |
Set the object at a specified index.
A copy is made of the object and added to the Set. The original object is unaffected.
aIndex | Index of the array element to be set. aIndex must be greater than zero and less than or equal to the size of the array. Note that if aIndex is equal to the size of the array, the set is equivalent to an append. |
aObject | Object to be set. |
preserveGroups | If true, the new object will be added to the groups that the object it replaces belonged to |
|
inline |
Set the amount by which the capacity is increased when the capacity of of the array in exceeded.
If the specified increment is negative or this method is called with no argument, the capacity is set to double whenever the capacity is exceeded.
aIncrement | Desired capacity increment. |
|
inline |
Set whether or not this Set owns the memory pointed to by the pointers it holds.
aTrueFalse | If true, all the memory associated with each of the pointers in this array are deleted upon the array's destruction. If false, deletes are not issued for each of the pointers. |
|
inlinevirtual |
Set the size of the array.
This method can be used only to decrease the size of the array. If the size of an array is decreased, all objects in the array that become invalid as a result of the decrease are deleted.
Note that the size of an array is different than its capacity. The size indicates how many valid elements are stored in an array. The capacity indicates how much the size of the array can be increased without allocated more memory. At all times size <= capacity.
aSize | Desired size of the array. The size must be greater than or equal to zero and less than or equal to the current size of the array. |
|
inline |
Setup groups (match group member names to set members).
|
inline |
Trim the capacity of this array so that it is one larger than the size of this array.
This is useful for reducing the amount of memory used by this array. This capacity is kept at one larger than the size so that, for example, an array of characters can be treated as a NULL terminated string.
|
friend |
|
protected |
Referenced by OpenSim::Set< Force, ModelComponent >::addGroup(), OpenSim::Set< Force, ModelComponent >::addObjectToGroup(), OpenSim::Set< Force, ModelComponent >::clearAndDestroy(), OpenSim::Set< Force, ModelComponent >::getGroup(), OpenSim::Set< Force, ModelComponent >::getGroupNames(), OpenSim::Set< Force, ModelComponent >::getGroupNamesContaining(), OpenSim::Set< Force, ModelComponent >::getNumGroups(), OpenSim::Set< Force, ModelComponent >::operator=(), OpenSim::Set< Force, ModelComponent >::remove(), OpenSim::Set< Force, ModelComponent >::removeGroup(), OpenSim::Set< Force, ModelComponent >::renameGroup(), OpenSim::Set< Force, ModelComponent >::Set(), OpenSim::Set< Force, ModelComponent >::set(), and OpenSim::Set< Force, ModelComponent >::setupGroups().
|
protected |
Referenced by OpenSim::Set< Force, ModelComponent >::addObjectToGroup(), OpenSim::Set< Force, ModelComponent >::adoptAndAppend(), OpenSim::Set< Force, ModelComponent >::clearAndDestroy(), OpenSim::Set< Force, ModelComponent >::computeNewCapacity(), OpenSim::Set< Force, ModelComponent >::contains(), OpenSim::Set< Force, ModelComponent >::ensureCapacity(), OpenSim::Set< Force, ModelComponent >::get(), OpenSim::Set< Force, ModelComponent >::getCapacity(), OpenSim::Set< Force, ModelComponent >::getCapacityIncrement(), OpenSim::Set< Force, ModelComponent >::getIndex(), OpenSim::Set< Force, ModelComponent >::getLast(), OpenSim::Set< Force, ModelComponent >::getMemoryOwner(), OpenSim::Set< Force, ModelComponent >::getNames(), OpenSim::Set< Force, ModelComponent >::getSize(), OpenSim::Set< Force, ModelComponent >::insert(), OpenSim::Set< Force, ModelComponent >::operator=(), OpenSim::Set< Force, ModelComponent >::operator[](), OpenSim::Set< Force, ModelComponent >::remove(), OpenSim::Set< Force, ModelComponent >::searchBinary(), OpenSim::Set< Force, ModelComponent >::Set(), OpenSim::Set< Force, ModelComponent >::set(), OpenSim::Set< Force, ModelComponent >::setCapacityIncrement(), OpenSim::Set< Force, ModelComponent >::setMemoryOwner(), OpenSim::Set< Force, ModelComponent >::setSize(), OpenSim::Set< Force, ModelComponent >::setupGroups(), and OpenSim::Set< Force, ModelComponent >::trim().
|
protected |
Array of pointers to object groups.
|
protected |
Array of pointers to objects.