MethodGroup Class Reference

#include <Ample.h>

Inheritance diagram for MethodGroup:

[legend]

Collaboration diagram for MethodGroup:

[legend]

List of all members.

Public Types
typedef Observer < MethodGroupObserver >	ObserverType
typedef std::vector < MethodGroupObserver * >	ObserverList
Public Member Functions
void	destroy (void)
void	createMethod (const std::string &name, const MethodParamList &parameters)
Method *	getMethodByID (uint16 methodID)
const Method *	getMethodByID (uint16 methodID) const
Method *	getMethodByIndex (unsigned int index)
const Method *	getMethodByIndex (unsigned int index) const
Method *	getMethodByName (const std::string &name)
const Method *	getMethodByName (const std::string &name) const
unsigned int	getMethodCount (void) const
const uint16	getID (void) const
const std::string &	getName (void) const
ObjectNode &	getNode (void) const
unsigned int	getDataVersion (void) const
unsigned int	getStructureVersion (void) const
void	addObserver (MethodGroupObserver &observer)
void	removeObserver (MethodGroupObserver &observer)
void	removeObserver (Observer< MethodGroupObserver > &observer)
const ObserverList &	getObservers (void) const
Friends
class	ObjectNode

---

Detailed Description

Method group class. Represents a single method group in an object node.

---

Member Typedef Documentation

typedef std::vector<MethodGroupObserver *> ObserverList [inherited]

typedef Observer<MethodGroupObserver > ObserverType [inherited]

---

Member Function Documentation

void addObserver

(

MethodGroupObserver &

observer

)

[inline, inherited]

Adds the specified observer to this object.

Parameters:

observer

The observer to add.

Remarks:

An observer can only be added once. Additional additions are ignored.

void createMethod	(	const std::string &	name,
		const MethodParamList &	parameters
	)

Creates a new method in this method group.

Parameters:

	name	The desired name of the method.
	parameters	The parameters accepted by the method.

Remarks:

This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

void destroy

(

void

)

Destroys this method group.

Remarks:

This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

unsigned int getDataVersion

(

void

)

const [inherited]

Returns:

The current version of the internal state.

Remarks:

This value is updated for any kind of change.

const uint16 getID

(

void

)

const

Returns:

The ID of this method group.

const Method* getMethodByID

(

uint16

methodID

)

const

Parameters:

methodID

The ID of the desired method.

Returns:

The method with the specified ID, or NULL if no such method exists.

Method* getMethodByID

(

uint16

methodID

)

Parameters:

methodID

The ID of the desired method.

Returns:

The method with the specified ID, or NULL if no such method exists.

const Method* getMethodByIndex

(

unsigned int

index

)

const

Parameters:

index

The index of the desired method.

Returns:

The method at the specified index, or NULL if no such method exists.

Method* getMethodByIndex

(

unsigned int

index

)

Parameters:

index

The index of the desired method.

Returns:

The method at the specified index, or NULL if no such method exists.

const Method* getMethodByName

(

const std::string &

name

)

const

Parameters:

name

The name of the desired method.

Returns:

The method with the specified name, or NULL if no such method exists.

Method* getMethodByName

(

const std::string &

name

)

Parameters:

name

The name of the desired method.

Returns:

The method with the specified name, or NULL if no such method exists.

unsigned int getMethodCount

(

void

)

const

Returns:

The number of methods in this node.

const std::string& getName

(

void

)

const

Returns:

The name of this method group.

ObjectNode& getNode

(

void

)

const

Returns:

The node containing this method group.

const ObserverList& getObservers

(

void

)

const [inline, inherited]

Returns:

The list of observers attached to this object.

unsigned int getStructureVersion

(

void

)

const [inherited]

Returns:

The current version of the internal structure.

Remarks:

This value is only updated when the internal structure changes.

void removeObserver

(

Observer< MethodGroupObserver > &

observer

)

[inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

void removeObserver

(

MethodGroupObserver &

observer

)

[inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

---

Friends And Related Function Documentation

friend class ObjectNode [friend]

Reimplemented from Versioned.