OpenSim::PropertyGroup Class Reference

A class implementing a property group. More...

#include <PropertyGroup.h>

List of all members.

Public Member Functions
	PropertyGroup ()
	Default constructor.
	PropertyGroup (std::string &aName)
	PropertyGroup (const PropertyGroup &aGroup)
	Copy constructor.
virtual	~PropertyGroup ()
	Destructor.
virtual PropertyGroup *	copy () const
	Construct and return a copy of this object.
PropertyGroup &	operator= (const PropertyGroup &aGroup)
	Assignment operator.
bool	operator< (const PropertyGroup &aGroup) const
	Less than operator.
bool	operator== (const PropertyGroup &aGroup) const
	Equality operator.
void	copyData (const PropertyGroup &aGroup)
	Copy data members from one PropertyGroup to another.
void	clear ()
	Clear the group (remove all property members).
bool	contains (const std::string &aName) const
void	add (Property *aProperty)
	Add a property, if it is not already in the group.
void	remove (Property *aProperty)
	Remove a property.
const Array< Property * > &	getProperties () const
Property *	get (int aIndex)
	Get a property by index.
int	getPropertyIndex (Property *aProperty) const
	Get the index of a property.
void	setName (const std::string &aName)
const std::string &	getName () const
Protected Attributes
Array< Property * >	_properties
	Pointers to the properties in the group.

---

Detailed Description

A class implementing a property group.

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

PropertyGroup::PropertyGroup

(

)

Default constructor.

OpenSim::PropertyGroup::PropertyGroup

(

std::string &

aName

)

PropertyGroup::PropertyGroup

(

const PropertyGroup &

aGroup

)

Copy constructor.

Parameters:

aGroup

Group to be copied.

PropertyGroup::~PropertyGroup

(

)

[virtual]

Destructor.

---

Member Function Documentation

void PropertyGroup::add

(

Property *

aProperty

)

Add a property, if it is not already in the group.

void PropertyGroup::clear

(

)

Clear the group (remove all property members).

bool OpenSim::PropertyGroup::contains

(

const std::string &

aName

)

const

PropertyGroup * PropertyGroup::copy

(

)

const [virtual]

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:

Copy of this object.

void PropertyGroup::copyData

(

const PropertyGroup &

aGroup

)

Copy data members from one PropertyGroup to another.

Parameters:

aGroup

PropertyGroup to be copied.

Property * PropertyGroup::get

(

int

aIndex

)

Get a property by index.

const std::string& OpenSim::PropertyGroup::getName

(

)

const [inline]

const Array<Property*>& OpenSim::PropertyGroup::getProperties

(

)

const [inline]

int PropertyGroup::getPropertyIndex

(

Property *

aProperty

)

const

Get the index of a property.

bool PropertyGroup::operator<

(

const PropertyGroup &

aGroup

)

const

Less than operator.

Parameters:

aGroup

Group with which to evaluate less than.

Returns:

True if number of properties in this group is less than the number in aGroup.

PropertyGroup & PropertyGroup::operator=

(

const PropertyGroup &

aGroup

)

Assignment operator.

Returns:

Reference to this object.

bool PropertyGroup::operator==

(

const PropertyGroup &

aGroup

)

const

Equality operator.

Parameters:

aGroup

Group with which to evaluate less than.

Returns:

True if the two groups have the same number of properties.

void PropertyGroup::remove

(

Property *

aProperty

)

Remove a property.

void OpenSim::PropertyGroup::setName

(

const std::string &

aName

)

[inline]

---

Member Data Documentation

Array<Property*> OpenSim::PropertyGroup::_properties [protected]

Pointers to the properties in the group.

---

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

• OpenSim/Common/PropertyGroup.h
• OpenSim/Common/PropertyGroup.cpp