API  4.1
For C++ developers
OpenSim::Property_Deprecated Class Referenceabstract
+ Inheritance diagram for OpenSim::Property_Deprecated:

Public Member Functions

 Property_Deprecated ()
 
 Property_Deprecated (PropertyType aType, const std::string &aName)
 
 Property_Deprecated (const Property_Deprecated &aProperty)
 
virtual PropertyType getPropertyType () const
 Return the enum value corresponding to the concrete property. More...
 
virtual bool isArrayProperty () const
 Return true if this is an array property. More...
 
void setMatchName (bool aMatchName)
 By default deprecated PropertyObj properties will ignore the name associated with the read-in object. More...
 
bool getMatchName () const
 Return the value of the matchName flag for this (deprecated) property. More...
 
bool isEqualTo (const AbstractProperty &other) const override
 The base class equals() method will have already done a lot of checking prior to calling this method, including verifying that both values are non-default and that the value lists are the same size; the concrete property need only compare the values. More...
 
Property_Deprecatedclone () const override=0
 Return a new instance of this concrete property object, containing new copies of this property's values. More...
 
virtual void readFromXMLElement (SimTK::Xml::Element &propertyElement, int versionNumber) override
 Read in a new value for this property from the XML element propertyElement. More...
 
virtual void writeToXMLElement (SimTK::Xml::Element &propertyElement) const override
 Output a serialized representation of this property by writing its value to the given XML property element. More...
 
int getNumValues () const override
 How may values are currently stored in this property? If this is an object property you can use this with getValueAsObject() to iterate over the contained objects. More...
 
void clearValues () override
 If the concrete property allows it, clear the value list. More...
 
bool isUnnamedProperty () const override
 An unnamed property is a one-object property whose name was given as null or as the contained object's type tag. More...
 
bool isObjectProperty () const override
 Return true if this is an "object property", meaning that its values are all concrete objects of types that ultimately derive from the OpenSim serializable base class Object. More...
 
bool isAcceptableObjectTag (const std::string &objectTypeTag) const override
 Return true if the given string is the XML tag name for one of the Object-derived types that is allowed by this property. More...
 
const ObjectgetValueAsObject (int index=-1) const override
 For an object property, the values can be obtained as references to the abstract base class Object from which all the objects derive. More...
 
ObjectupdValueAsObject (int index=-1) override
 Get writable access to an existing object value. More...
 
void setValueAsObject (const Object &obj, int index=-1) override
 Set the indicated value element to a new copy of the supplied object. More...
 
void setNull ()
 
Property_Deprecatedoperator= (const Property_Deprecated &aProperty)
 
virtual bool operator== (const Property_Deprecated &aProperty) const
 
virtual bool operator< (const Property_Deprecated &aProperty) const
 
void setType (PropertyType aType)
 
PropertyType getType () const
 
std::string getTypeName () const override=0
 This returns a string representation of this property's value type which will be the same as T::getClassName() for Object-derived types T, and some reasonably nice name for simple types, including at least "bool", "int", "double", "string", "Vec3", "Vector", and "Transform". More...
 
std::string toString () const override=0
 For relatively simple types, return the current value of this property in a string suitable for displaying to a user in the GUI (i.e., this number may be rounded and not an exact representation of the actual value being used). More...
 
virtual void setValue (bool aValue)
 
virtual bool & getValueBool ()
 
virtual const bool & getValueBool () const
 
virtual void setValue (int aValue)
 
virtual int & getValueInt ()
 
virtual const int & getValueInt () const
 
virtual void setValue (double aValue)
 
virtual double & getValueDbl ()
 
virtual const double & getValueDbl () const
 
virtual void setValue (const std::string &aValue)
 
virtual std::string & getValueStr ()
 
virtual const std::string & getValueStr () const
 
virtual void setValue (int aSize, const bool aArray[])
 
virtual void setValue (const Array< bool > &aArray)
 
virtual Array< bool > & getValueBoolArray ()
 
virtual const Array< bool > & getValueBoolArray () const
 
virtual void setValue (int aSize, const int aArray[])
 
virtual void setValue (const Array< int > &aArray)
 
virtual Array< int > & getValueIntArray ()
 
virtual const Array< int > & getValueIntArray () const
 
virtual void setValue (int aSize, const double aArray[])
 
virtual void setValue (const Array< double > &aArray)
 
virtual Array< double > & getValueDblArray ()
 
virtual const Array< double > & getValueDblArray () const
 
virtual void setValue (int aSize, const std::string aArray[])
 
virtual void setValue (const Array< std::string > &aArray)
 
virtual Array< std::string > & getValueStrArray ()
 
virtual const Array< std::string > & getValueStrArray () const
 
virtual bool isValidObject (const Object *aValue) const
 
virtual ObjectgetValueObj ()
 
virtual const ObjectgetValueObj () const
 
virtual void setValue (Object *aValue)
 
virtual const ObjectgetValueObjPtr () const
 
virtual const ObjectgetValueObjPtr (int index) const
 
virtual void appendValue (Object *obj)
 
virtual void clearObjArray ()
 
virtual int getArraySize () const
 
template<class T >
T & getValue ()
 
template<class T >
const T & getValue () const
 
template<class T >
Array< T > & getValueArray ()
 
template<class T >
const Array< T > & getValueArray () const
 
template<>
bool & getValue ()
 
template<>
const bool & getValue () const
 
template<>
int & getValue ()
 
template<>
const int & getValue () const
 
template<>
double & getValue ()
 
template<>
const double & getValue () const
 
template<>
std::string & getValue ()
 
template<>
const std::string & getValue () const
 
template<>
Array< bool > & getValue ()
 
template<>
const Array< bool > & getValue () const
 
template<>
Array< int > & getValue ()
 
template<>
const Array< int > & getValue () const
 
template<>
Array< double > & getValue ()
 
template<>
const Array< double > & getValue () const
 
template<>
Array< std::string > & getValue ()
 
template<>
const Array< std::string > & getValue () const
 
template<>
Array< bool > & getValueArray ()
 
template<>
const Array< bool > & getValueArray () const
 
template<>
Array< int > & getValueArray ()
 
template<>
const Array< int > & getValueArray () const
 
template<>
Array< double > & getValueArray ()
 
template<>
const Array< double > & getValueArray () const
 
template<>
Array< std::string > & getValueArray ()
 
template<>
const Array< std::string > & getValueArray () const
 
- Public Member Functions inherited from OpenSim::AbstractProperty
void setAllowableListSize (int aMin, int aMax)
 Require that the number of values n in the value list of this property be in the range aMin <= n <= aMax. More...
 
void setAllowableListSize (int aNum)
 Require that the number of values n in the value list of this property be exactly n=aNum values. More...
 
virtual ~AbstractProperty ()
 Return all heap space used by this property. More...
 
virtual std::string toStringForDisplay (const int precision) const
 For relatively simple types, return the current value of this property in a string suitable for displaying to a user in the GUI (i.e., this number may be rounded and not an exact representation of the actual value being used). More...
 
bool equals (const AbstractProperty &other) const
 Compare this property with another one; this is primarily used for testing. More...
 
bool isSamePropertyClass (const AbstractProperty &other) const
 Return true if the other property is an object of exactly the same concrete class as this one. More...
 
bool operator== (const AbstractProperty &other) const
 See the equals() method for the meaning of this operator. More...
 
void setAllPropertiesUseDefault (bool shouldUseDefault)
 This method sets the "use default" flag for this property and the properties of any objects it contains to the given value. More...
 
void readFromXMLParentElement (SimTK::Xml::Element &parent, int versionNumber)
 Given an XML parent element expected to contain a value for this property as an immediate child element, find that property element and set the property value from it. More...
 
void writeToXMLParentElement (SimTK::Xml::Element &parent) const
 Given an XML parent element, append a single child element representing the serialized form of this property. More...
 
void setName (const std::string &name)
 Set the property name. More...
 
void setComment (const std::string &aComment)
 Set a user-friendly comment to be associated with property. More...
 
void setValueIsDefault (bool isDefault)
 Set flag indicating whether the value of this property was simply taken from a default object and thus should not be written out when serializing. More...
 
const std::string & getName () const
 Get the property name. More...
 
const std::string & getComment () const
 Get the comment associated with this property. More...
 
bool getValueIsDefault () const
 Get the flag indicating whether the current value is just the default value for this property (in which case it doesn't need to be written out). More...
 
int getMinListSize () const
 Get the minimum number of values allowed in this property's value list. More...
 
int getMaxListSize () const
 Get the maximum number of values allowed in this property's value list. More...
 
bool isOptionalProperty () const
 This is an "optional" property if its value list can contain at most one value. More...
 
bool isListProperty () const
 This is a "list" property if its value list can contain more than one value. More...
 
bool isOneValueProperty () const
 This is a "one-value" property if its value list must always contain exactly one value. More...
 
bool isOneObjectProperty () const
 This is a "one-object" property if it is a "one-value" property and it contains an Object-derived value. More...
 
int size () const
 Return the number of values currently in this property's value list. More...
 
bool empty () const
 Return true if this property's value list is currently empty. More...
 
void clear ()
 Empty the value list for this property; fails if zero is not an allowable size for this property. More...
 
template<class T >
const T & getValue (int index=-1) const
 Return one of the values in this property as type T; this works only if the underlying concrete property stores type T and if the indexed element is present, otherwise throws an exception. More...
 
template<class T >
T & updValue (int index=-1)
 Return a writable reference to one of the values in this property as type T; this works only if the underlying concrete property is actually of type T and the indexed element is present. More...
 
template<class T >
int appendValue (const T &value)
 Append a new value of type T to the end of the list of values currently contained in this property. More...
 
virtual void assign (const AbstractProperty &that)=0
 Assign (copy) property that to this object. More...
 

Public Types

enum  PropertyType {
  None =0, Bool, Int, Dbl,
  Str, Obj, ObjPtr, BoolArray,
  IntArray, DblArray, StrArray, ObjArray,
  DblVec, DblVec3, Transform
}
 Enumeration of recognized types. More...
 

Friends

std::ostream & operator<< (std::ostream &aOut, const Property_Deprecated &aProperty)
 

Additional Inherited Members

- Protected Member Functions inherited from OpenSim::AbstractProperty
 AbstractProperty ()
 
 AbstractProperty (const std::string &name, const std::string &comment)
 
 AbstractProperty (const AbstractProperty &)=default
 
 AbstractProperty (AbstractProperty &&)=default
 
AbstractPropertyoperator= (const AbstractProperty &)=default
 
AbstractPropertyoperator= (AbstractProperty &&)=default
 

Member Enumeration Documentation

◆ PropertyType

Enumeration of recognized types.

Enumerator
None 
Bool 
Int 
Dbl 
Str 
Obj 
ObjPtr 
BoolArray 
IntArray 
DblArray 
StrArray 
ObjArray 
DblVec 
DblVec3 
Transform 

Constructor & Destructor Documentation

◆ Property_Deprecated() [1/3]

OpenSim::Property_Deprecated::Property_Deprecated ( )

◆ Property_Deprecated() [2/3]

OpenSim::Property_Deprecated::Property_Deprecated ( PropertyType  aType,
const std::string &  aName 
)

◆ Property_Deprecated() [3/3]

OpenSim::Property_Deprecated::Property_Deprecated ( const Property_Deprecated aProperty)

Member Function Documentation

◆ appendValue()

virtual void OpenSim::Property_Deprecated::appendValue ( Object obj)
inlinevirtual

◆ clearObjArray()

virtual void OpenSim::Property_Deprecated::clearObjArray ( )
inlinevirtual

◆ clearValues()

void OpenSim::Property_Deprecated::clearValues ( )
inlineoverridevirtual

If the concrete property allows it, clear the value list.

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyDblArray, OpenSim::PropertyIntArray, OpenSim::PropertyStrArray, and OpenSim::PropertyBoolArray.

◆ clone()

Property_Deprecated* OpenSim::Property_Deprecated::clone ( ) const
overridepure virtual

Return a new instance of this concrete property object, containing new copies of this property's values.

The new property object is allocated on the heap and it is up to the caller to delete it when done.

Implements OpenSim::AbstractProperty.

Implemented in OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyDblArray, OpenSim::PropertyIntArray, OpenSim::PropertyBoolArray, OpenSim::PropertyStrArray, OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, OpenSim::PropertyObj, OpenSim::PropertyTransform, OpenSim::PropertyBool, OpenSim::PropertyInt, OpenSim::PropertyStr, and OpenSim::PropertyDbl.

◆ getArraySize()

virtual int OpenSim::Property_Deprecated::getArraySize ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, OpenSim::PropertyDblArray, OpenSim::PropertyIntArray, OpenSim::PropertyStrArray, and OpenSim::PropertyBoolArray.

◆ getMatchName()

bool OpenSim::Property_Deprecated::getMatchName ( ) const
inline

Return the value of the matchName flag for this (deprecated) property.

◆ getNumValues()

int OpenSim::Property_Deprecated::getNumValues ( ) const
inlineoverridevirtual

How may values are currently stored in this property? If this is an object property you can use this with getValueAsObject() to iterate over the contained objects.

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyDblArray, OpenSim::PropertyIntArray, OpenSim::PropertyBoolArray, OpenSim::PropertyStrArray, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, and OpenSim::PropertyObjArray< Control >.

Referenced by OpenSim::AbstractProperty::appendValue().

◆ getPropertyType()

virtual PropertyType OpenSim::Property_Deprecated::getPropertyType ( ) const
inlinevirtual

Return the enum value corresponding to the concrete property.

◆ getType()

PropertyType OpenSim::Property_Deprecated::getType ( ) const

◆ getTypeName()

std::string OpenSim::Property_Deprecated::getTypeName ( ) const
overridepure virtual

This returns a string representation of this property's value type which will be the same as T::getClassName() for Object-derived types T, and some reasonably nice name for simple types, including at least "bool", "int", "double", "string", "Vec3", "Vector", and "Transform".

Implements OpenSim::AbstractProperty.

Implemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyDblArray, OpenSim::PropertyObj, OpenSim::PropertyIntArray, OpenSim::PropertyBoolArray, OpenSim::PropertyStrArray, OpenSim::PropertyStr, OpenSim::PropertyBool, OpenSim::PropertyInt, OpenSim::PropertyTransform, and OpenSim::PropertyDbl.

◆ getValue() [1/18]

template<class T >
T& OpenSim::Property_Deprecated::getValue ( )

◆ getValue() [2/18]

template<class T >
const T& OpenSim::Property_Deprecated::getValue ( ) const

◆ getValue() [3/18]

template<>
bool& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [4/18]

template<>
const bool& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [5/18]

template<>
int& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [6/18]

template<>
const int& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [7/18]

template<>
double& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [8/18]

template<>
const double& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [9/18]

template<>
std::string& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [10/18]

template<>
const std::string& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [11/18]

template<>
Array<bool>& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [12/18]

template<>
const Array<bool>& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [13/18]

template<>
Array<int>& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [14/18]

template<>
const Array<int>& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [15/18]

template<>
Array<double>& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [16/18]

template<>
const Array<double>& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValue() [17/18]

template<>
Array<std::string>& OpenSim::Property_Deprecated::getValue ( )
inline

◆ getValue() [18/18]

template<>
const Array<std::string>& OpenSim::Property_Deprecated::getValue ( ) const
inline

◆ getValueArray() [1/10]

template<class T >
Array<T>& OpenSim::Property_Deprecated::getValueArray ( )

◆ getValueArray() [2/10]

template<class T >
const Array<T>& OpenSim::Property_Deprecated::getValueArray ( ) const

◆ getValueArray() [3/10]

template<>
Array<bool>& OpenSim::Property_Deprecated::getValueArray ( )
inline

◆ getValueArray() [4/10]

template<>
const Array<bool>& OpenSim::Property_Deprecated::getValueArray ( ) const
inline

◆ getValueArray() [5/10]

template<>
Array<int>& OpenSim::Property_Deprecated::getValueArray ( )
inline

◆ getValueArray() [6/10]

template<>
const Array<int>& OpenSim::Property_Deprecated::getValueArray ( ) const
inline

◆ getValueArray() [7/10]

template<>
Array<double>& OpenSim::Property_Deprecated::getValueArray ( )
inline

◆ getValueArray() [8/10]

template<>
const Array<double>& OpenSim::Property_Deprecated::getValueArray ( ) const
inline

◆ getValueArray() [9/10]

template<>
Array<std::string>& OpenSim::Property_Deprecated::getValueArray ( )
inline

◆ getValueArray() [10/10]

template<>
const Array<std::string>& OpenSim::Property_Deprecated::getValueArray ( ) const
inline

◆ getValueAsObject()

const Object& OpenSim::Property_Deprecated::getValueAsObject ( int  index = -1) const
inlineoverridevirtual

For an object property, the values can be obtained as references to the abstract base class Object from which all the objects derive.

If the property can hold a list of values you must provide an index to select the value, otherwise it is optional but if supplied must be 0. This will throw an exception if this is not an object property, that is, if it is a simple property, because its values can't be represented as an Object in that case.

Parameters
[in]indexIf supplied must be 0 <= index < getNumValues().
Returns
const reference to the value as an Object
See also
updValueAsObject(), getValue<T>()

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ getValueBool() [1/2]

virtual bool& OpenSim::Property_Deprecated::getValueBool ( )
inlinevirtual

Reimplemented in OpenSim::PropertyBool.

◆ getValueBool() [2/2]

virtual const bool& OpenSim::Property_Deprecated::getValueBool ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyBool.

◆ getValueBoolArray() [1/2]

virtual Array<bool>& OpenSim::Property_Deprecated::getValueBoolArray ( )
inlinevirtual

Reimplemented in OpenSim::PropertyBoolArray.

◆ getValueBoolArray() [2/2]

virtual const Array<bool>& OpenSim::Property_Deprecated::getValueBoolArray ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyBoolArray.

◆ getValueDbl() [1/2]

virtual double& OpenSim::Property_Deprecated::getValueDbl ( )
inlinevirtual

Reimplemented in OpenSim::PropertyDbl.

◆ getValueDbl() [2/2]

virtual const double& OpenSim::Property_Deprecated::getValueDbl ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyDbl.

◆ getValueDblArray() [1/2]

virtual Array<double>& OpenSim::Property_Deprecated::getValueDblArray ( )
inlinevirtual

◆ getValueDblArray() [2/2]

virtual const Array<double>& OpenSim::Property_Deprecated::getValueDblArray ( ) const
inlinevirtual

◆ getValueInt() [1/2]

virtual int& OpenSim::Property_Deprecated::getValueInt ( )
inlinevirtual

Reimplemented in OpenSim::PropertyInt.

◆ getValueInt() [2/2]

virtual const int& OpenSim::Property_Deprecated::getValueInt ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyInt.

◆ getValueIntArray() [1/2]

virtual Array<int>& OpenSim::Property_Deprecated::getValueIntArray ( )
inlinevirtual

Reimplemented in OpenSim::PropertyIntArray.

◆ getValueIntArray() [2/2]

virtual const Array<int>& OpenSim::Property_Deprecated::getValueIntArray ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyIntArray.

◆ getValueObj() [1/2]

virtual Object& OpenSim::Property_Deprecated::getValueObj ( )
inlinevirtual

Reimplemented in OpenSim::PropertyObj.

◆ getValueObj() [2/2]

virtual const Object& OpenSim::Property_Deprecated::getValueObj ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyObj.

◆ getValueObjPtr() [1/2]

virtual const Object* OpenSim::Property_Deprecated::getValueObjPtr ( ) const
inlinevirtual

◆ getValueObjPtr() [2/2]

virtual const Object* OpenSim::Property_Deprecated::getValueObjPtr ( int  index) const
inlinevirtual

◆ getValueStr() [1/2]

virtual std::string& OpenSim::Property_Deprecated::getValueStr ( )
inlinevirtual

Reimplemented in OpenSim::PropertyStr.

◆ getValueStr() [2/2]

virtual const std::string& OpenSim::Property_Deprecated::getValueStr ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyStr.

◆ getValueStrArray() [1/2]

virtual Array<std::string>& OpenSim::Property_Deprecated::getValueStrArray ( )
inlinevirtual

Reimplemented in OpenSim::PropertyStrArray.

◆ getValueStrArray() [2/2]

virtual const Array<std::string>& OpenSim::Property_Deprecated::getValueStrArray ( ) const
inlinevirtual

Reimplemented in OpenSim::PropertyStrArray.

◆ isAcceptableObjectTag()

bool OpenSim::Property_Deprecated::isAcceptableObjectTag ( const std::string &  objectTypeTag) const
inlineoverridevirtual

Return true if the given string is the XML tag name for one of the Object-derived types that is allowed by this property.

If so, we expect that an element with that tag could be deserialized into a value element of this property. This always returns false for a simple property.

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ isArrayProperty()

virtual bool OpenSim::Property_Deprecated::isArrayProperty ( ) const
inlinevirtual

Return true if this is an array property.

Reimplemented in OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyDblArray, OpenSim::PropertyIntArray, OpenSim::PropertyBoolArray, OpenSim::PropertyStrArray, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, and OpenSim::PropertyObjArray< Control >.

Referenced by OpenSim::AbstractProperty::appendValue(), OpenSim::AbstractProperty::getValue(), and OpenSim::AbstractProperty::updValue().

◆ isEqualTo()

bool OpenSim::Property_Deprecated::isEqualTo ( const AbstractProperty other) const
inlineoverridevirtual

The base class equals() method will have already done a lot of checking prior to calling this method, including verifying that both values are non-default and that the value lists are the same size; the concrete property need only compare the values.

Implements OpenSim::AbstractProperty.

◆ isObjectProperty()

bool OpenSim::Property_Deprecated::isObjectProperty ( ) const
inlineoverridevirtual

Return true if this is an "object property", meaning that its values are all concrete objects of types that ultimately derive from the OpenSim serializable base class Object.

If this returns true then it is safe to call getValueAsObject(). Otherwise this property contains only simple types like "int" or "std::string", and you'll need to know the actual type in order to access the values.

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ isUnnamedProperty()

bool OpenSim::Property_Deprecated::isUnnamedProperty ( ) const
inlineoverridevirtual

An unnamed property is a one-object property whose name was given as null or as the contained object's type tag.

In that case getName() will return the object type tag, and the XML representation will just be the object, with name attribute ignored if there is one.

Implements OpenSim::AbstractProperty.

◆ isValidObject()

virtual bool OpenSim::Property_Deprecated::isValidObject ( const Object aValue) const
inlinevirtual

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ operator<()

virtual bool OpenSim::Property_Deprecated::operator< ( const Property_Deprecated aProperty) const
virtual

◆ operator=()

◆ operator==()

virtual bool OpenSim::Property_Deprecated::operator== ( const Property_Deprecated aProperty) const
virtual

Reimplemented in OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, OpenSim::PropertyObjPtr< T >, and OpenSim::PropertyObjPtr< OpenSim::Function >.

Referenced by OpenSim::PropertyObjPtr< OpenSim::Function >::operator==(), and OpenSim::PropertyObjArray< Control >::operator==().

◆ readFromXMLElement()

virtual void OpenSim::Property_Deprecated::readFromXMLElement ( SimTK::Xml::Element &  propertyElement,
int  versionNumber 
)
inlineoverridevirtual

Read in a new value for this property from the XML element propertyElement.

The element is expected to have the form

<propertyName> value(s) </propertyName>

where the values may be simple (like int or double) or may be objects contained in child elements for which the object type name serves as the element tag. Note that although the XML file may contain an abbreviated representation for one-object properties, it will have been canonicalized into the above form for the purpose of reading, so concrete properties may assume the above form always.

The format for the property value (and any of its contained objects) is assumed to be the one that was in use when the given ".osim" file version number was current; if necessary the in-memory version will be updated to the now-current format.

If this is an object property, the contained objects will be asked recursively to read themselves in from the same document. However, any object that has the "file" attribute will read in its contents from that file rather than from the supplied XML document, and the version number will be taken from that file rather than the argument supplied here.

Implements OpenSim::AbstractProperty.

◆ setMatchName()

void OpenSim::Property_Deprecated::setMatchName ( bool  aMatchName)
inline

By default deprecated PropertyObj properties will ignore the name associated with the read-in object.

This forces the name to match one specified for the property. Note that this is handled differently in the new Property system.

◆ setNull()

void OpenSim::Property_Deprecated::setNull ( )

◆ setType()

void OpenSim::Property_Deprecated::setType ( PropertyType  aType)

◆ setValue() [1/13]

virtual void OpenSim::Property_Deprecated::setValue ( bool  aValue)
inlinevirtual

◆ setValue() [2/13]

virtual void OpenSim::Property_Deprecated::setValue ( int  aValue)
inlinevirtual

Reimplemented in OpenSim::PropertyInt.

◆ setValue() [3/13]

virtual void OpenSim::Property_Deprecated::setValue ( double  aValue)
inlinevirtual

Reimplemented in OpenSim::PropertyDbl.

◆ setValue() [4/13]

virtual void OpenSim::Property_Deprecated::setValue ( const std::string &  aValue)
inlinevirtual

Reimplemented in OpenSim::PropertyStr.

◆ setValue() [5/13]

virtual void OpenSim::Property_Deprecated::setValue ( int  aSize,
const bool  aArray[] 
)
inlinevirtual

Reimplemented in OpenSim::PropertyBoolArray.

◆ setValue() [6/13]

virtual void OpenSim::Property_Deprecated::setValue ( const Array< bool > &  aArray)
inlinevirtual

Reimplemented in OpenSim::PropertyBoolArray.

◆ setValue() [7/13]

virtual void OpenSim::Property_Deprecated::setValue ( int  aSize,
const int  aArray[] 
)
inlinevirtual

Reimplemented in OpenSim::PropertyIntArray.

◆ setValue() [8/13]

virtual void OpenSim::Property_Deprecated::setValue ( const Array< int > &  aArray)
inlinevirtual

Reimplemented in OpenSim::PropertyIntArray.

◆ setValue() [9/13]

virtual void OpenSim::Property_Deprecated::setValue ( int  aSize,
const double  aArray[] 
)
inlinevirtual

◆ setValue() [10/13]

virtual void OpenSim::Property_Deprecated::setValue ( const Array< double > &  aArray)
inlinevirtual

◆ setValue() [11/13]

virtual void OpenSim::Property_Deprecated::setValue ( int  aSize,
const std::string  aArray[] 
)
inlinevirtual

Reimplemented in OpenSim::PropertyStrArray.

◆ setValue() [12/13]

virtual void OpenSim::Property_Deprecated::setValue ( const Array< std::string > &  aArray)
inlinevirtual

Reimplemented in OpenSim::PropertyStrArray.

◆ setValue() [13/13]

virtual void OpenSim::Property_Deprecated::setValue ( Object aValue)
inlinevirtual

◆ setValueAsObject()

void OpenSim::Property_Deprecated::setValueAsObject ( const Object obj,
int  index = -1 
)
inlineoverridevirtual

Set the indicated value element to a new copy of the supplied object.

If you already have a heap-allocated object you're willing to give up and want to avoid the extra copy, use adoptValueObject().

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ toString()

std::string OpenSim::Property_Deprecated::toString ( ) const
overridepure virtual

For relatively simple types, return the current value of this property in a string suitable for displaying to a user in the GUI (i.e., this number may be rounded and not an exact representation of the actual value being used).

Objects just return something like "(Object)". For Propertys, This function calls toStringForDisplay() with precision = 6.

Implements OpenSim::AbstractProperty.

Implemented in OpenSim::PropertyDblVec_< M >, OpenSim::PropertyDblVec_< 2 >, OpenSim::PropertyDblVec_< 3 >, OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, OpenSim::PropertyDblArray, OpenSim::PropertyObj, OpenSim::PropertyIntArray, OpenSim::PropertyStrArray, OpenSim::PropertyBoolArray, OpenSim::PropertyTransform, OpenSim::PropertyStr, OpenSim::PropertyBool, OpenSim::PropertyDbl, and OpenSim::PropertyInt.

◆ updValueAsObject()

Object& OpenSim::Property_Deprecated::updValueAsObject ( int  index = -1)
inlineoverridevirtual

Get writable access to an existing object value.

Note that you can't use this to install a different concrete object; see setValueAsObject() if you want to do that.

Parameters
[in]indexIf supplied must be 0 <= index < getNumValues().
Returns
writable reference to the value as an Object
See also
getValueAsObject(), updValue<T>()

Implements OpenSim::AbstractProperty.

Reimplemented in OpenSim::PropertyObjPtr< T >, OpenSim::PropertyObjPtr< OpenSim::Function >, OpenSim::PropertyObjArray< T >, OpenSim::PropertyObjArray< AbstractPathPoint >, OpenSim::PropertyObjArray< ExternalForce >, OpenSim::PropertyObjArray< Bhargava2004MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< ContactGeometry >, OpenSim::PropertyObjArray< Umberger2010MuscleMetabolicsProbe_MetabolicMuscleParameter >, OpenSim::PropertyObjArray< Coordinate >, OpenSim::PropertyObjArray< OpenSim::Constraint >, OpenSim::PropertyObjArray< OpenSim::ObjectGroup >, OpenSim::PropertyObjArray< OpenSim::Actuator >, OpenSim::PropertyObjArray< WrapObject >, OpenSim::PropertyObjArray< IKTask >, OpenSim::PropertyObjArray< Force >, OpenSim::PropertyObjArray< Joint >, OpenSim::PropertyObjArray< MarkerPair >, OpenSim::PropertyObjArray< Scale >, OpenSim::PropertyObjArray< OpenSim::Force >, OpenSim::PropertyObjArray< Probe >, OpenSim::PropertyObjArray< const OpenSim::Actuator >, OpenSim::PropertyObjArray< OpenSim::Muscle >, OpenSim::PropertyObjArray< Controller >, OpenSim::PropertyObjArray< ModelComponent >, OpenSim::PropertyObjArray< Function >, OpenSim::PropertyObjArray< TrackingTask >, OpenSim::PropertyObjArray< OpenSim::ControlLinearNode >, OpenSim::PropertyObjArray< Measurement >, OpenSim::PropertyObjArray< BodyScale >, OpenSim::PropertyObjArray< Marker >, OpenSim::PropertyObjArray< Analysis >, OpenSim::PropertyObjArray< Body >, OpenSim::PropertyObjArray< Constraint >, OpenSim::PropertyObjArray< Control >, and OpenSim::PropertyObj.

◆ writeToXMLElement()

virtual void OpenSim::Property_Deprecated::writeToXMLElement ( SimTK::Xml::Element &  propertyElement) const
inlineoverridevirtual

Output a serialized representation of this property by writing its value to the given XML property element.

If the "use default value" attribute is set for this property (meaning we don't have a meaningful value for it) then you should not call this method unless you are trying to serialize the defaults. Note that this method unconditionally serializes the property; it does not check to see whether it should.

This method is not called for the special case of a one-object property, in which case only the object is written to the XML file (without the property element). In all other cases (simple property or property containing an array of objects), the format is

<propertyName> value(s) </propertyName>

and that is the only format produced here since the empty-valued property element is supplied (with the property name as its tag).

Implements OpenSim::AbstractProperty.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  aOut,
const Property_Deprecated aProperty 
)
friend

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