OpenSim  OpenSim 3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::Set< T > Class Template Reference

A class for holding a set of pointers to objects. More...

#include <Set.h>

Inheritance diagram for OpenSim::Set< T >:
OpenSim::Object OpenSim::ModelComponentSet< T >

Public Member Functions

virtual ~Set ()
 Destructor.
 Set ()
 Default constructor.
 Set (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct from file.
 Set (const Set< T > &aSet)
 Copy constructor.
void setupGroups ()
 Setup groups (match group member names to set members).
Set< T > & operator= (const Set< T > &aSet)
 Assign this set to another set.
T & operator[] (int aIndex) const
 Get a pointer to the set object at a specified index.
void setMemoryOwner (bool aTrueFalse)
 Set whether or not this set owns the memory pointed to by the pointers it holds.
bool getMemoryOwner () const
 Get whether or not this array owns the memory pointed to by the pointers in its array.
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.
bool ensureCapacity (int aCapacity)
 Ensure that the capacity of this array is at least the specified amount.
void trim ()
 Trim the capacity of this array so that it is one larger than the size of this array.
int getCapacity () const
 Get the capacity of this storage instance.
void setCapacityIncrement (int aIncrement)
 Set the amount by which the capacity is increased when the capacity of of the array in exceeded.
int getCapacityIncrement () const
 Get the amount by which the capacity is increased.
virtual bool setSize (int aSize)
 Set the size of the array.
int getSize () const
 Get the size of the array.
virtual int getIndex (const T *aObject, int aStartIndex=0) const
 Get the index of an object.
virtual int getIndex (const std::string &aName, int aStartIndex=0) const
 Get the index of an object by specifying its name.
void getGroupNamesContaining (const std::string &aObjectName, Array< std::string > &rGroupNames) const
 Get names of groups containing a given object.
virtual bool adoptAndAppend (T *aObject)
 Append to the array, and adopt passed in pointer.
virtual bool cloneAndAppend (const T &aObject)
 cloneAndAppend creates a clone of the passed in object and appends the clone to the array.
virtual bool insert (int aIndex, T *aObject)
 Insert an object into the array at a specified index.
virtual bool insert (int aIndex, const T &aObject)
 Insert an object into the array at a specified index.
virtual bool remove (int aIndex)
 Remove an object from the array at a specified index.
virtual bool remove (const T *aObject)
 Remove an object from the array by specifying its address.
virtual void clearAndDestroy ()
virtual bool set (int aIndex, T *aObject, bool preserveGroups=false)
 Set the object at a specified index.
virtual bool set (int aIndex, const T &aObject, bool preserveGroups=false)
 Set the object at a specified index.
virtual T & get (int aIndex) const
 Get the value at a specified array index.
T & get (const std::string &aName)
 Get the first object that has a specified name.
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.
virtual void getNames (OpenSim::Array< std::string > &rNames) const
 Get names of objects in the set.
virtual T * getLast () const
 Get the last value in the array.
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.
int getNumGroups () const
 Get the number of groups.
void addGroup (const std::string &aGroupName)
 Add an empty group to the set.
void removeGroup (const std::string &aGroupName)
 Remove a group from the set.
void renameGroup (const std::string &oldGroupName, const std::string &newGroupName)
 Rename a group.
void addObjectToGroup (const std::string &aGroupName, const std::string &aObjectName)
 Add an object to a group.
void getGroupNames (Array< std::string > &rGroupNames) const
 Get names of all groups.
const ObjectGroupgetGroup (const std::string &aGroupName) const
 Get a group by name.
const ObjectGroupgetGroup (int aIndex) const
 Get a group by index.
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup.
virtual Objectclone () const =0
 Create a new heap-allocated copy of the concrete object to which this Object refers.
virtual const std::string & getConcreteClassName () const =0
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.
virtual const VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading.
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties.
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal.
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers.
void setName (const std::string &name)
 Set the name of the Object.
const std::string & getName () const
 Get the name of this Object.
void setDescription (const std::string &description)
 Set description, a one-liner summary.
const std::string & getDescription () const
 Get description, a one-liner summary.
const std::string & getAuthors () const
 Get Authors of this Object.
void setAuthors (const std::string &authors)
 Set Authors of this object, call this method in your constructor if needed.
const std::string & getReferences () const
 Get references or publications to cite if using this object.
void setReferences (const std::string &references)
 Set references or publications to cite if using this object.
int getNumProperties () const
 Determine how many properties are stored with this Object.
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty.
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty.
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.
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty.
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty.
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.
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.
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.
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.
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called.
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object.
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element.
virtual void updateXMLNode (SimTK::Xml::Element &parent)
 Serialize this object into the XML node that represents it.
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument.
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.
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document.
void setAllPropertiesUseDefault (bool aUseDefault)
bool print (const std::string &fileName)
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim".
std::string dump (bool dumpName=false)
 dump the XML representation of this Object into an std::string and return it.
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag.
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.
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name.
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object.
const PropertySetgetPropertySet () const

Protected Attributes

PropertyObjArray< T > _propObjects
 Array of pointers to objects.
PropertyObjArray< ObjectGroup_propObjectGroups
 Array of pointers to object groups.
ArrayPtrs< T > & _objects
ArrayPtrs< ObjectGroup > & _objectGroups
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes.

Friends

std::ostream & operator<< (std::ostream &aOut, const Set< T > &aSet)
 Implementation of the output operator.

Additional Inherited Members

- 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.
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name.
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.
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*.
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName.
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far.
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.
static void PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects.
static void PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
 Same as the other signature but the class name and property name are provided as two separate strings.
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.
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object".
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.
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag.
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.
static void setDebugLevel (int newLevel)
 Set the debug level to get verbose output.
static int getDebugLevel ()
 Get current setting of debug level.
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.
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType().
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType().
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized.
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types.
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
 Constructor from a file, to be called from other constructors that take a file as input.
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly.
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object.
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.
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.
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.
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.
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.
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found.
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.
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.
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object.
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object.
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object.

Detailed Description

template<class T>
class OpenSim::Set< T >

A class for holding a set of pointers to objects.

It is derived from class Object and is implemented as a wrapper around template ArrayPtrs<T>. It is implemented around an array of pointers, rather than values, so that it can make use of any virtual methods associated with class T.

See Also
ArrayPtrs
Author
Frank C. Anderson

Constructor & Destructor Documentation

template<class T>
virtual OpenSim::Set< T >::~Set ( )
inlinevirtual

Destructor.

template<class T>
OpenSim::Set< T >::Set ( )
inline

Default constructor.

template<class T>
OpenSim::Set< T >::Set ( const std::string &  aFileName,
bool  aUpdateFromXMLNode = true 
)
inline

Construct from file.

Parameters
aFileNameName of the file.
aUpdateFromXMLNodeWhether to update from XML.
template<class T>
OpenSim::Set< T >::Set ( const Set< T > &  aSet)
inline

Copy constructor.

Parameters
aSetSet to be copied.

Member Function Documentation

template<class T>
void OpenSim::Set< T >::addGroup ( const std::string &  aGroupName)
inline

Add an empty group to the set.

template<class T>
void OpenSim::Set< T >::addObjectToGroup ( const std::string &  aGroupName,
const std::string &  aObjectName 
)
inline

Add an object to a group.

template<class T>
virtual bool OpenSim::Set< T >::adoptAndAppend ( T *  aObject)
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.

Parameters
aObjectObject to be appended.
Returns
True if the append was successful, false otherwise.
template<class T>
virtual void OpenSim::Set< T >::clearAndDestroy ( )
inlinevirtual
template<class T>
virtual bool OpenSim::Set< T >::cloneAndAppend ( const T &  aObject)
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

Parameters
aObjectObject whose clone is to be appended.
Returns
True if the append was successful, false otherwise.
template<class T>
bool OpenSim::Set< T >::computeNewCapacity ( int  aMinCapacity,
int &  rNewCapacity 
)
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.

Parameters
rNewCapacityNew computed capacity.
aMinCapacityMinimum new computed capacity. The computed capacity is incremented until it is at least as large as aMinCapacity, assuming the capacity increment is not zero.
Returns
True if the new capacity was increased, false otherwise (i.e., if the capacity increment is set to 0).
See Also
setCapacityIncrement()
template<class T>
bool OpenSim::Set< T >::contains ( const std::string &  aName) const
inline

Get whether this Set contains any object with the specified name.

Parameters
aNameName of the desired object.
Returns
true if the object exists
template<class T>
bool OpenSim::Set< T >::ensureCapacity ( int  aCapacity)
inline

Ensure that the capacity of this array is at least the specified amount.

The newly allocated array elements are initialized to NULL.

Parameters
aCapacityDesired capacity.
Returns
true if the capacity was successfully obtained, false otherwise.
template<class T>
virtual T& OpenSim::Set< T >::get ( int  aIndex) const
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.

Parameters
aIndexIndex of the desired array element.
Returns
Reference to the array element.
Exceptions
Exceptionif (aIndex<0)||(aIndex>=_size) or if the pointer at aIndex is NULL.
See Also
operator[].
template<class T>
T& OpenSim::Set< T >::get ( const std::string &  aName)
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.

Parameters
aNameName of the desired object.
Returns
Pointer to the object.
Exceptions
Exceptionif no such object exists.
See Also
getIndex()
template<class T>
const T& OpenSim::Set< T >::get ( const std::string &  aName) const
inline
template<class T>
int OpenSim::Set< T >::getCapacity ( ) const
inline

Get the capacity of this storage instance.

template<class T>
int OpenSim::Set< T >::getCapacityIncrement ( ) const
inline

Get the amount by which the capacity is increased.

template<class T>
const ObjectGroup* OpenSim::Set< T >::getGroup ( const std::string &  aGroupName) const
inline

Get a group by name.

template<class T>
const ObjectGroup* OpenSim::Set< T >::getGroup ( int  aIndex) const
inline

Get a group by index.

template<class T>
void OpenSim::Set< T >::getGroupNames ( Array< std::string > &  rGroupNames) const
inline

Get names of all groups.

template<class T>
void OpenSim::Set< T >::getGroupNamesContaining ( const std::string &  aObjectName,
Array< std::string > &  rGroupNames 
) const
inline

Get names of groups containing a given object.

template<class T>
virtual int OpenSim::Set< T >::getIndex ( const T *  aObject,
int  aStartIndex = 0 
) const
inlinevirtual

Get the index of an object.

Parameters
aObjectAddress of the object whose index is sought.
aStartIndexIndex at which to start searching. If the object is not found at or following aStartIndex, the array is searched from its beginning.
Returns
Index of the object with the address aObject. If no such object exists in the array, -1 is returned.
template<class T>
virtual int OpenSim::Set< T >::getIndex ( const std::string &  aName,
int  aStartIndex = 0 
) const
inlinevirtual

Get the index of an object by specifying its name.

Parameters
aNameName of the object whose index is sought.
aStartIndexIndex at which to start searching. If the object is not found at or following aStartIndex, the array is searched from its beginning.
Returns
Index of the object named aName. If no such object exists in the array, -1 is returned.
template<class T>
virtual T* OpenSim::Set< T >::getLast ( ) const
inlinevirtual

Get the last value in the array.

Returns
Last value in the array.
Exceptions
Exceptionif the array is empty.
template<class T>
bool OpenSim::Set< T >::getMemoryOwner ( ) const
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.

Returns
True if this array owns the memory; false otherwise.
template<class T>
virtual void OpenSim::Set< T >::getNames ( OpenSim::Array< std::string > &  rNames) const
inlinevirtual

Get names of objects in the set.

Parameters
rNamesArray 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.
template<class T>
int OpenSim::Set< T >::getNumGroups ( ) const
inline

Get the number of groups.

template<class T>
int OpenSim::Set< T >::getSize ( ) const
inline

Get the size of the array.

Returns
Size of the array.
template<class T>
virtual bool OpenSim::Set< T >::insert ( int  aIndex,
T *  aObject 
)
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.

Parameters
aObjectObject to be inserted.
aIndexIndex 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.
Returns
True if the insertion was successful, false otherwise.

Reimplemented in OpenSim::ModelComponentSet< T >, OpenSim::ModelComponentSet< ExternalForce >, OpenSim::ModelComponentSet< ContactGeometry >, OpenSim::ModelComponentSet< Coordinate >, OpenSim::ModelComponentSet< Force >, OpenSim::ModelComponentSet< Joint >, OpenSim::ModelComponentSet< Probe >, OpenSim::ModelComponentSet< Controller >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::ModelComponentSet< Body >, OpenSim::ModelComponentSet< Constraint >, and OpenSim::ForceSet.

template<class T>
virtual bool OpenSim::Set< T >::insert ( int  aIndex,
const T &  aObject 
)
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.

Parameters
aObjectObject to be inserted.
aIndexIndex 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.
Returns
True if the insertion was successful, false otherwise.
template<class T>
Set<T>& OpenSim::Set< T >::operator= ( const Set< T > &  aSet)
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.

Parameters
aSetSet to be copied.
Returns
Reference to this set.
template<class T>
T& OpenSim::Set< T >::operator[] ( int  aIndex) const
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().

Parameters
aIndexIndex of the desired element (0 <= aIndex < _size).
Returns
Reference to the array element.
Exceptions
Exceptionif a NULL pointer is encountered.
See Also
get().
template<class T>
virtual bool OpenSim::Set< T >::remove ( int  aIndex)
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.

Parameters
aIndexIndex 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.
Returns
True if the removal was successful, false otherwise.

Reimplemented in OpenSim::ForceSet.

template<class T>
virtual bool OpenSim::Set< T >::remove ( const T *  aObject)
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.

Parameters
aObjectPointer to the object to be removed. If an object with the specified address is not found, no action is taken.
Returns
True if the removal was successful, false otherwise.
template<class T>
void OpenSim::Set< T >::removeGroup ( const std::string &  aGroupName)
inline

Remove a group from the set.

Elements are not removed.

template<class T>
void OpenSim::Set< T >::renameGroup ( const std::string &  oldGroupName,
const std::string &  newGroupName 
)
inline

Rename a group.

template<class T>
int OpenSim::Set< T >::searchBinary ( const T &  aObject,
bool  aFindFirst = false,
int  aLo = -1,
int  aHi = -1 
) const
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 approprite element is identified), so the performance of this method is approximately ln(n), where n is the size of the array.

Parameters
aObjectValue to which the array elements are compared.
aFindFirstIf 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.
aLoLowest array index to consider in the search.
aHiHighest array index to consider in the search.
Returns
Index of the array element that has the largest value that is less than or equal to aValue. If there is more than one such elements with the same value and aFindFirst is set to true, the index of the first of these elements is returned. If an error is encountered (e.g., the array is empty), or the array contains no element that is less than or equal to aValue, -1 is returned.
template<class T>
virtual bool OpenSim::Set< T >::set ( int  aIndex,
T *  aObject,
bool  preserveGroups = false 
)
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.

Parameters
aIndexIndex 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.
aObjectObject to be set.
preserveGroupsIf true, the new object will be added to the groups that the object it replaces belonged to
Returns
True if the set was successful, false otherwise.

Reimplemented in OpenSim::ModelComponentSet< T >, OpenSim::ModelComponentSet< ExternalForce >, OpenSim::ModelComponentSet< ContactGeometry >, OpenSim::ModelComponentSet< Coordinate >, OpenSim::ModelComponentSet< Force >, OpenSim::ModelComponentSet< Joint >, OpenSim::ModelComponentSet< Probe >, OpenSim::ModelComponentSet< Controller >, OpenSim::ModelComponentSet< ModelComponent >, OpenSim::ModelComponentSet< Body >, and OpenSim::ModelComponentSet< Constraint >.

template<class T>
virtual bool OpenSim::Set< T >::set ( int  aIndex,
const T &  aObject,
bool  preserveGroups = false 
)
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.

Parameters
aIndexIndex 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.
aObjectObject to be set.
preserveGroupsIf true, the new object will be added to the groups that the object it replaces belonged to
Returns
True if the set was successful, false otherwise.
template<class T>
void OpenSim::Set< T >::setCapacityIncrement ( int  aIncrement)
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.

Parameters
aIncrementDesired capacity increment.
template<class T>
void OpenSim::Set< T >::setMemoryOwner ( bool  aTrueFalse)
inline

Set whether or not this set owns the memory pointed to by the pointers it holds.

Parameters
aTrueFalseIf 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.
template<class T>
virtual bool OpenSim::Set< T >::setSize ( int  aSize)
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.

Parameters
aSizeDesired 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.
Returns
True if the requested size change was carried out, false otherwise.
template<class T>
void OpenSim::Set< T >::setupGroups ( )
inline

Setup groups (match group member names to set members).

template<class T>
void OpenSim::Set< T >::trim ( )
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.

Friends And Related Function Documentation

template<class T>
std::ostream& operator<< ( std::ostream &  aOut,
const Set< T > &  aSet 
)
friend

Implementation of the output operator.

The output for a set looks like the following:

Set[size] = T[0] T[1] T[2] ... T[size-1].

Parameters
aOutOutput stream.
aSetSet to be output.
Returns
Reference to the output stream.

Member Data Documentation

template<class T>
ArrayPtrs<ObjectGroup>& OpenSim::Set< T >::_objectGroups
protected
template<class T>
ArrayPtrs<T>& OpenSim::Set< T >::_objects
protected
template<class T>
PropertyObjArray<ObjectGroup> OpenSim::Set< T >::_propObjectGroups
protected

Array of pointers to object groups.

template<class T>
PropertyObjArray<T> OpenSim::Set< T >::_propObjects
protected

Array of pointers to objects.


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