acpObject class

#include <acpObject.h>

object code: aGarcia shared library

Object Description:

The acpObject class encapsulates the basic structure of the objects in the Garcia API. A user manipulates objects by setting and getting object property values. Most all of your interaction with the Garcia API will take place through the acpObject interface.

Constructors

acpObject( const char* pClassName, const char* pName = NULL);

This constructs an acpObject with the specified class name and object name.

acpObject( );

This is the basic default constructor for the main Garcia API object, the object.

Destructors

~acpObject( );

Methods

virtual int numSubObjects( ) const;

virtual void enumSubObjects( aObjectEnumProc enumProc, void* vpRef, const char* pClassNameFilter = NULL) const;

virtual acpObject* getNamedSubObject( const char* pClassName, const char* pName) const;

virtual acpObject* getSubObject( const int nObjectIndex) const;

virtual int numProperties( ) const;

virtual void enumProperties( propertyEnumProc enumProc, void* vpRef) const;

virtual acpProperty* getProperty( const int nPropertyIndex) const;

virtual int getPropertyIndex( const char* pPropertyName) const;

virtual char* getPropertyName( const int nPropertyIndex) const;

virtual aPROPERTY_FLAGS getPropertyFlags( const int nPropertyIndex) const;

virtual acpValue* getValue( const int nPropIndex);

virtual acpValue* getNamedValue( const char* pPropName);

virtual void setValue( const int nPropIndex, const acpValue* pValue);

virtual void setNamedValue( const char* pPropName, const acpValue* pValue);

virtual aErr readValue( const int nPropIndex, aStreamRef stream);

Method Details

virtual int numSubObjects( ) const;

Return Value:

The number of subobjects associated with an object.

Description:

This method returns the number of subobjects associated with an object.

virtual void enumSubObjects( aObjectEnumProc enumProc, void* vpRef, const char* pClassNameFilter = NULL) const;

Parameters:

`enumProc`	-	An enumeration procedure.
`vpRef`	-	A void pointer.
`pClassNameFilter = NULL`	-	Class type to enumerate.

Description:

This method enumerates the subobjects associatied with the object. The user must implement an enumProc routine in order to use this function. When the pClassNameFilter is not null the routine will only enumerate the subobjects of the specified class.

virtual acpObject* getNamedSubObject( const char* pClassName, const char* pName) const;

Parameters:

`pClassName`	-	Class name for the object being retrieved.
`pName`	-	Name of the object being retrieved.

Return Value:

Description:

This method retrieves a subobject given its class name and object name. Two names are required to retrieve an object since two objects with different class names may have the same object name.

virtual acpObject* getSubObject( const int nObjectIndex) const;

Parameters:

nObjectIndex - Index of the object being retrieved.

Return Value:

Description:

This method retrieves a subobject given its index. Each subobject has a unique index.

virtual int numProperties( ) const;

Return Value:

The number of properties associated with an object.

Description:

This method returns the number of properties associated with an object.

virtual void enumProperties( propertyEnumProc enumProc, void* vpRef) const;

Parameters:

`enumProc`	-	An enumeration procedure.
`vpRef`	-	A void pointer.

Description:

This method enumerates the properties associated with an object. The user must implement an enumProc routine in order to use this function.

virtual acpProperty* getProperty( const int nPropertyIndex) const;

Parameters:

nPropertyIndex - Index of the property to be accessed.

Return Value:

Description:

This method returns a pointer to the indexed property.

virtual int getPropertyIndex( const char* pPropertyName) const;

Parameters:

pPropertyName - Name of the property whose index is to be retrieved.

Return Value:

Description:

This method retrieves the index of a property given its name.

virtual char* getPropertyName( const int nPropertyIndex) const;

Parameters:

nPropertyIndex - Index of the property whose name is to be retrieved.

Return Value:

Description:

This method retrieves the name of a property given its index.

virtual aPROPERTY_FLAGS getPropertyFlags( const int nPropertyIndex) const;

Parameters:

nPropertyIndex - Index of the property whose flags are to be retrieved.

Return Value:

Description:

This method retrieves the flags of a property given its index.

virtual acpValue* getValue( const int nPropIndex);

Parameters:

nPropIndex - The index of the property being retrieved.

Return Value:

Pointer to the acpValue object with the value of the property.

Description:

This method attempts to retreive an acpValue object with the value of the indexed property. If the property does not exist in the object, the function returns a NULL pointer.

virtual acpValue* getNamedValue( const char* pPropName);

Parameters:

pPropName - A pointer to the name of the property being retrieved.

Return Value:

Pointer to the acpValue object with the value of the property.

Description:

This method attempts to retreive an acpValue object with the value of the named property. If the property does not exist in the object, the function returns a NULL pointer.

virtual void setValue( const int nPropIndex, const acpValue* pValue);

Parameters:

`nPropIndex`	-	The index of the property being set.
`pValue`	-	Pointer to the acpValue object with the new value for the property.

Description:

This method attempts to set the indexed property if it is a property in the object.

virtual void setNamedValue( const char* pPropName, const acpValue* pValue);

Parameters:

`pPropName`	-	A pointer to the name of the property being set.
`pValue`	-	Pointer to the acpValue object with the new value for the property.

Description:

This method attempts to set the named property if it is a property in the object.

virtual aErr readValue( const int nPropIndex, aStreamRef stream);

Parameters:

`nPropIndex`	-	The index of the property to be written.
`stream`	-	Output stream.

Return Value:

Description:

This method writes the value of the indexed property to the specified stream.

version: 1.0, build n.a.