OpenSim::PropertyBoolArray Class Reference

Class PropertyBoolArray extends class Property. More...

#include <PropertyBoolArray.h>

Inheritance diagram for OpenSim::PropertyBoolArray:

List of all members.

Public Member Functions
	PropertyBoolArray ()
	Default Constructor.
	PropertyBoolArray (const std::string &aName, const Array< bool > &aArray)
	PropertyBoolArray (const std::string &aName, int aSize, const bool aArray[])
	PropertyBoolArray (const PropertyBoolArray &aProperty)
	Copy constructor.
virtual Property *	copy () const
	Construct and return a copy of this property.
virtual	~PropertyBoolArray ()
PropertyBoolArray &	operator= (const PropertyBoolArray &aProperty)
	Assign this property to another.
virtual const char *	getTypeAsString () const
	Get the type of this property as a string.
virtual void	setValue (const Array< bool > &aArray)
	Set the value of this property.
virtual void	setValue (int aSize, const bool aArray[])
	Set the value of this property.
virtual Array< bool > &	getValueBoolArray ()
	Get a reference to the value of this property.
virtual const Array< bool > &	getValueBoolArray () const
	Get a constant reference to the value of this property.
virtual int	getArraySize () const
virtual const std::string &	toString ()
	Get a constantString represeting the value of this property.

---

Detailed Description

Class PropertyBoolArray extends class Property.

It consists of an array of booleans (i.e., Array<bool>) and the methods for accessing and modifying this array.

Version:

1.0

Author:

Frank C. Anderson

---

Constructor & Destructor Documentation

PropertyBoolArray::PropertyBoolArray

(

)

Default Constructor.

OpenSim::PropertyBoolArray::PropertyBoolArray	(	const std::string &	aName,
		const Array< bool > &	aArray
	)

OpenSim::PropertyBoolArray::PropertyBoolArray	(	const std::string &	aName,
		int	aSize,
		const bool	aArray[]
	)

PropertyBoolArray::PropertyBoolArray

(

const PropertyBoolArray &

aProperty

)

Copy constructor.

Parameters:

aProperty

Property to be copied.

virtual OpenSim::PropertyBoolArray::~PropertyBoolArray

(

)

[inline, virtual]

---

Member Function Documentation

Property * PropertyBoolArray::copy

(

)

const [virtual]

Construct and return a copy of this property.

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

Returns:

Copy of this property.

Implements OpenSim::Property.

virtual int OpenSim::PropertyBoolArray::getArraySize

(

)

const [inline, virtual]

Reimplemented from OpenSim::Property.

const char * PropertyBoolArray::getTypeAsString

(

)

const [virtual]

Get the type of this property as a string.

Returns:

Type of the property.

Reimplemented from OpenSim::Property.

const Array< bool > & PropertyBoolArray::getValueBoolArray

(

)

const [virtual]

Get a constant reference to the value of this property.

Returns:

Reference to the value of this property.

Reimplemented from OpenSim::Property.

Array< bool > & PropertyBoolArray::getValueBoolArray

(

)

[virtual]

Get a reference to the value of this property.

Note that the returned reference can be used to change the value of this property.

Returns:

Reference to the value of this property.

Reimplemented from OpenSim::Property.

PropertyBoolArray & PropertyBoolArray::operator=

(

const PropertyBoolArray &

aProperty

)

Assign this property to another.

Parameters:

aProperty

Property to which to assign this property.

Returns:

Reference to this property.

Reimplemented from OpenSim::Property.

void PropertyBoolArray::setValue	(	int	aSize,
		const bool	aArray[]
	)			[virtual]

Set the value of this property.

Parameters:

	aSize	Size of the specified array.
	aValue	Array to which this property is to be assigned.

Reimplemented from OpenSim::Property.

void PropertyBoolArray::setValue

(

const Array< bool > &

aArray

)

[virtual]

Set the value of this property.

Parameters:

aArray

Array to which this property is to be assigned.

Reimplemented from OpenSim::Property.

const string & PropertyBoolArray::toString

(

)

[virtual]

Get a constantString represeting the value of this property.

Returns:

Constant String represeting the value of this property.

Implements OpenSim::Property.

---

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

• OpenSim/Common/PropertyBoolArray.h
• OpenSim/Common/PropertyBoolArray.cpp