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

Inheritance diagram for OpenSim::Set< T, C >:

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 Member Functions inherited from OpenSim::Object
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 >
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...

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 Public Member Functions
Auto-generated functions
static Set *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

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. 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...

Auto-generated functions <br>
static const std::string &	getClassName ()
	This returns "Set_<T>_". More...

Set *	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...

Detailed Description

template<class T, class C = Object>
class OpenSim::Set< T, C >

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>.

See also: ArrayPtrs

Author: Frank C. Anderson

Constructor & Destructor Documentation

◆ ~Set()

template<class T , class C = Object>

virtual OpenSim::Set< T, C >::~Set ( )

inlinevirtual

Destructor.

◆ Set() [1/3]

template<class T , class C = Object>

OpenSim::Set< T, C >::Set ( )

inline

Default constructor.

◆ Set() [2/3]

template<class T , class C = Object>

OpenSim::Set< T, C >::Set	(	const std::string &	aFileName,
		bool	aUpdateFromXMLNode = `true`
	)

inline

Construct from file.

Parameters

aFileName	Name of the file.
aUpdateFromXMLNode	Whether to update from XML.

References OpenSim::Object::updateFromXMLDocument().

◆ Set() [3/3]

template<class T , class C = Object>

OpenSim::Set< T, C >::Set ( const Set< T, C > & aSet )

inline

Copy constructor.

Parameters

aSet	Set to be copied.

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

Member Function Documentation

◆ addGroup()

template<class T , class C = Object>

void OpenSim::Set< T, C >::addGroup ( const std::string & aGroupName )

inline

Add an empty group to the set.

References OpenSim::Set< T, C >::_objectGroups.

◆ addObjectToGroup()

template<class T , class C = Object>

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

inline

Add an object to a group.

References OpenSim::Set< T, C >::_objectGroups, OpenSim::Set< T, C >::_objects, and OpenSim::ObjectGroup::add().

◆ adoptAndAppend()

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

aObject Object to be appended.

Returns: True if the append was successful, false otherwise.

References OpenSim::Set< T, C >::_objects.

Referenced by OpenSim::ModelScaler::addMeasurement(), OpenSim::ModelScaler::addScale(), and OpenSim::Set< T, C >::cloneAndAppend().

◆ clearAndDestroy()

template<class T , class C = Object>

virtual void OpenSim::Set< T, C >::clearAndDestroy ( )

inlinevirtual

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

◆ clone()

template<class T , class C = Object>

Set * OpenSim::Set< T, C >::clone ( ) const

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.

◆ cloneAndAppend()

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

aObject Object whose clone is to be appended.

Returns: True if the append was successful, false otherwise.

References OpenSim::Set< T, C >::adoptAndAppend().

Referenced by OpenSim::IKTaskSet::createMarkerWeightSet().

◆ computeNewCapacity()

template<class T , class C = Object>

bool OpenSim::Set< T, C >::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

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.

Returns: True if the new capacity was increased, false otherwise (i.e., if the capacity increment is set to 0).

See also: setCapacityIncrement()

References OpenSim::Set< T, C >::_objects.

◆ contains()

template<class T , class C = Object>

bool OpenSim::Set< T, C >::contains ( const std::string & aName ) const

inline

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

Parameters

aName Name of the desired object.

Returns: true if the object exists

References OpenSim::Set< T, C >::_objects.

Referenced by OpenSim::Set< T, C >::getGroupNamesContaining().

◆ ensureCapacity()

template<class T , class C = Object>

bool OpenSim::Set< T, C >::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

aCapacity Desired capacity.

Returns: true if the capacity was successfully obtained, false otherwise.

References OpenSim::Set< T, C >::_objects.

◆ get() [1/3]

template<class T , class C = Object>

T & OpenSim::Set< T, C >::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

aName Name of the desired object.

Returns: Pointer to the object.

Exceptions

Exception if no such object exists.

See also: getIndex()

References OpenSim::Set< T, C >::_objects.

◆ get() [2/3]

template<class T , class C = Object>

const T & OpenSim::Set< T, C >::get ( const std::string & aName ) const

inline

References OpenSim::Set< T, C >::_objects.

◆ get() [3/3]

template<class T , class C = Object>

virtual T & OpenSim::Set< T, C >::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

aIndex Index of the desired array element.

Returns: Reference to the array element.

Exceptions

Exception if (aIndex<0)||(aIndex>=_size) or if the pointer at aIndex is NULL.

See also: operator[].

References OpenSim::Set< T, C >::_objects.

◆ getCapacity()

template<class T , class C = Object>

int OpenSim::Set< T, C >::getCapacity ( ) const

inline

Get the capacity of this storage instance.

References OpenSim::Set< T, C >::_objects.

◆ getCapacityIncrement()

template<class T , class C = Object>

int OpenSim::Set< T, C >::getCapacityIncrement ( ) const

inline

Get the amount by which the capacity is increased.

References OpenSim::Set< T, C >::_objects.

◆ getClassName()

template<class T , class C = Object>

static const std::string & OpenSim::Set< T, C >::getClassName ( )

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.

◆ getConcreteClassName()

template<class T , class C = Object>

const std::string & OpenSim::Set< T, C >::getConcreteClassName ( ) const

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.

See also: getClassName()

Implements OpenSim::Object.

◆ getGroup() [1/2]

template<class T , class C = Object>

const ObjectGroup * OpenSim::Set< T, C >::getGroup ( const std::string & aGroupName ) const

inline

Get a group by name.

References OpenSim::Set< T, C >::_objectGroups.

◆ getGroup() [2/2]

template<class T , class C = Object>

const ObjectGroup * OpenSim::Set< T, C >::getGroup ( int aIndex ) const

inline

Get a group by index.

References OpenSim::Set< T, C >::_objectGroups.

◆ getGroupNames()

template<class T , class C = Object>

void OpenSim::Set< T, C >::getGroupNames ( Array< std::string > & rGroupNames ) const

inline

Get names of all groups.

References OpenSim::Set< T, C >::_objectGroups, OpenSim::Array< T >::append(), and OpenSim::Array< T >::setSize().

◆ getGroupNamesContaining()

template<class T , class C = Object>

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

inline

Get names of groups containing a given object.

References OpenSim::Set< T, C >::_objectGroups, OpenSim::Array< T >::append(), OpenSim::Set< T, C >::contains(), OpenSim::Object::getName(), and OpenSim::Array< T >::setSize().

◆ getIndex() [1/2]

template<class T , class C = Object>

virtual int OpenSim::Set< T, C >::getIndex	(	const std::string &	aName,
		int	aStartIndex = `0`
	)		const

inlinevirtual

Get the index of an object by specifying its name.

Parameters

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.

Returns: Index of the object named aName. If no such object exists in the array, -1 is returned.

References OpenSim::Set< T, C >::_objects.

◆ getIndex() [2/2]

template<class T , class C = Object>

virtual int OpenSim::Set< T, C >::getIndex	(	const T *	aObject,
		int	aStartIndex = `0`
	)		const

inlinevirtual

Get the index of an object.

Parameters

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.

Returns: Index of the object with the address aObject. If no such object exists in the array, -1 is returned.

References OpenSim::Set< T, C >::_objects.

◆ getLast()

template<class T , class C = Object>

virtual T * OpenSim::Set< T, C >::getLast ( ) const

inlinevirtual

Get the last value in the array.

Returns: Last value in the array.

Exceptions

Exception if the array is empty.

References OpenSim::Set< T, C >::_objects.

◆ getMemoryOwner()

template<class T , class C = Object>

bool OpenSim::Set< T, C >::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.

References OpenSim::Set< T, C >::_objects.

◆ getNames()

template<class T , class C = Object>

virtual void OpenSim::Set< T, C >::getNames ( OpenSim::Array< std::string > & rNames ) const

inlinevirtual

Get names of objects in the set.

Parameters

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.

References OpenSim::Set< T, C >::_objects, and OpenSim::Array< T >::append().

◆ getNumGroups()

template<class T , class C = Object>

int OpenSim::Set< T, C >::getNumGroups ( ) const

inline

Get the number of groups.

References OpenSim::Set< T, C >::_objectGroups.

◆ getSize()

template<class T , class C = Object>

int OpenSim::Set< T, C >::getSize ( ) const

inline

Get the size of the array.

Returns: Size of the array.

References OpenSim::Set< T, C >::_objects.

Referenced by OpenSim::ProbeReporter::disableIntegrationOnlyProbes(), OpenSim::Measurement::getNumMarkerPairs(), and OpenSim::StateTrackingTask::getTaskErrorGradient().

◆ insert() [1/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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.

Returns: True if the insertion was successful, false otherwise.

References OpenSim::Set< T, C >::insert().

◆ insert() [2/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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.

Returns: True if the insertion was successful, false otherwise.

References OpenSim::Set< T, C >::_objects.

Referenced by OpenSim::Set< T, C >::insert().

◆ operator=()

template<class T , class C = Object>

Set< T, C > & OpenSim::Set< T, C >::operator= ( const Set< T, C > & set )

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

set	The Set to be copied.

Returns: Reference to this set.

References OpenSim::Set< T, C >::_objectGroups, OpenSim::Set< T, C >::_objects, and OpenSim::Set< T, C >::set().

Referenced by OpenSim::IKTaskSet::operator=().

◆ operator[]()

template<class T , class C = Object>

T & OpenSim::Set< T, C >::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

aIndex Index of the desired element (0 <= aIndex < _size).

Returns: Reference to the array element.

Exceptions

Exception if a NULL pointer is encountered.

See also: get().

References OpenSim::Set< T, C >::_objects.

◆ remove() [1/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

aObject Pointer 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.

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

◆ remove() [2/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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.

Returns: True if the removal was successful, false otherwise.

Reimplemented in OpenSim::ForceSet.

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

◆ removeGroup()

template<class T , class C = Object>

void OpenSim::Set< T, C >::removeGroup ( const std::string & aGroupName )

inline

Remove a group from the set.

Elements are not removed.

References OpenSim::Set< T, C >::_objectGroups.

◆ renameGroup()

template<class T , class C = Object>

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

inline

Rename a group.

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Object::setName().

◆ safeDownCast()

template<class T , class C = Object>

static Set * OpenSim::Set< T, C >::safeDownCast ( OpenSim::Object * obj )

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++.

◆ searchBinary()

template<class T , class C = Object>

int OpenSim::Set< T, C >::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 appropriate element is identified), so the performance of this method is approximately ln(n), where n is the size of the array.

Parameters

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.

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.

References OpenSim::Set< T, C >::_objects.

◆ set() [1/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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

Returns: True if the set was successful, false otherwise.

References OpenSim::Set< T, C >::set().

◆ set() [2/2]

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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

Returns: True if the set was successful, false otherwise.

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

Referenced by OpenSim::Set< T, C >::operator=(), and OpenSim::Set< T, C >::set().

◆ setCapacityIncrement()

template<class T , class C = Object>

void OpenSim::Set< T, C >::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

aIncrement Desired capacity increment.

References OpenSim::Set< T, C >::_objects.

◆ setMemoryOwner()

template<class T , class C = Object>

void OpenSim::Set< T, C >::setMemoryOwner ( bool aTrueFalse )

inline

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

Parameters

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.

References OpenSim::Set< T, C >::_objects.

◆ setSize()

template<class T , class C = Object>

virtual bool OpenSim::Set< T, C >::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

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.

Returns: True if the requested size change was carried out, false otherwise.

References OpenSim::Set< T, C >::_objects.

◆ setupGroups()

template<class T , class C = Object>

void OpenSim::Set< T, C >::setupGroups ( )

inline

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

References OpenSim::Set< T, C >::_objectGroups, and OpenSim::Set< T, C >::_objects.

◆ trim()

template<class T , class C = Object>

void OpenSim::Set< T, C >::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.

References OpenSim::Set< T, C >::_objects.

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

OpenSim/Common/Set.h

Public Member Functions

Static Public Member Functions

Auto-generated functions <br>

Detailed Description

Constructor & Destructor Documentation

◆ ~Set()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

Member Function Documentation

◆ addGroup()

◆ addObjectToGroup()

◆ adoptAndAppend()

◆ clearAndDestroy()

◆ clone()

◆ cloneAndAppend()

◆ computeNewCapacity()

◆ contains()

◆ ensureCapacity()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getCapacity()

◆ getCapacityIncrement()

◆ getClassName()

◆ getConcreteClassName()

◆ getGroup() [1/2]

◆ getGroup() [2/2]

◆ getGroupNames()

◆ getGroupNamesContaining()

◆ getIndex() [1/2]

◆ getIndex() [2/2]

◆ getLast()

◆ getMemoryOwner()

◆ getNames()

◆ getNumGroups()

◆ getSize()

◆ insert() [1/2]

◆ insert() [2/2]

◆ operator=()

◆ operator[]()

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeGroup()

◆ renameGroup()

◆ safeDownCast()

◆ searchBinary()

◆ set() [1/2]

◆ set() [2/2]

◆ setCapacityIncrement()

◆ setMemoryOwner()

◆ setSize()

◆ setupGroups()

◆ trim()