ulxr::Dispatcher::MethodCallDescriptor Struct Reference

#include <ulxr_dispatcher.h>

List of all members.

Public Member Functions
	MethodCallDescriptor (const MethodCall &call)
	Constructs a method call descriptor.
	MethodCallDescriptor (CallType calltype, const CppString &ret_sig, const CppString &name, const CppString &signature, const CppString &help)
	Constructs a method call descriptor.
bool	operator== (const MethodCallDescriptor &desc) const
	Compares two method call descriptors.
bool	operator< (const MethodCallDescriptor &desc) const
	Compares two method call descriptors.
CppString	getSignature (bool with_name, bool with_return) const
	Gets the signature of the method call.
unsigned long	getInvoked () const
	The the invocation counter.
void	incInvoked () const
	Increments the invocation counter by one.
bool	isEnabled () const
	Returns the status of availability.
void	setEnabled (bool ena) const
	Sets the status of availability.
CppString	getMethodName () const
	Gets the method name.
CppString	getParameterSignature () const
	Gets the parameter signature.
CppString	getReturnValueSignature () const
	Gets the return value signature.
CppString	getDocumentation () const
	Gets the documentation.
CallType	getCallType () const
	Gets the call type.
Private Attributes
CallType	calltype
CppString	method_name
CppString	signature
CppString	return_signature
CppString	documentation
unsigned long	invoked
bool	enabled
Friends
class	Dispatcher

---

Detailed Description

Definition at line 62 of file ulxr_dispatcher.h.

---

Constructor & Destructor Documentation

ulxr::Dispatcher::MethodCallDescriptor::MethodCallDescriptor

(

const MethodCall &

call

)

Constructs a method call descriptor.

Parameters:

call

method call data

Definition at line 57 of file ulxr_dispatcher.cpp.

References ulxr::MethodAdder::CallNone, calltype, documentation, enabled, ulxr::MethodCall::getMethodName(), ulxr::MethodCall::getSignature(), invoked, method_name, return_signature, signature, and ULXR_PCHAR.

ulxr::Dispatcher::MethodCallDescriptor::MethodCallDescriptor	(	CallType	calltype,
		const CppString &	ret_sig,
		const CppString &	name,
		const CppString &	signature,
		const CppString &	help
	)

Constructs a method call descriptor.

Parameters:

	calltype	type of descriptor
	ret_sig	signature of return type
	name	method name
	signature	signature of parameters
	help	description of method

Definition at line 71 of file ulxr_dispatcher.cpp.

References calltype, documentation, enabled, invoked, method_name, return_signature, and signature.

---

Member Function Documentation

bool ulxr::Dispatcher::MethodCallDescriptor::operator==

(

const MethodCallDescriptor &

desc

)

const [inline]

Compares two method call descriptors.

Returns:

true: both are NOT equal

Definition at line 88 of file ulxr_dispatcher.h.

References getSignature().

bool ulxr::Dispatcher::MethodCallDescriptor::operator<

(

const MethodCallDescriptor &

desc

)

const [inline]

Compares two method call descriptors.

Returns:

true: both are equal

Definition at line 94 of file ulxr_dispatcher.h.

References getSignature().

CppString ulxr::Dispatcher::MethodCallDescriptor::getSignature	(	bool	with_name,
		bool	with_return
	)			const

Gets the signature of the method call.

Parameters:

	with_name	includes also the name of the method (in the middle)
	with_return	includes also the return type (at the begining)

Returns:

the signature as string

Definition at line 113 of file ulxr_dispatcher.cpp.

References ULXR_PCHAR, and ULXR_TRACE.

Referenced by operator<(), and operator==().

unsigned long ulxr::Dispatcher::MethodCallDescriptor::getInvoked

(

)

const

The the invocation counter.

Returns:

how many this methods was invoked

Definition at line 88 of file ulxr_dispatcher.cpp.

References invoked.

void ulxr::Dispatcher::MethodCallDescriptor::incInvoked

(

)

const

Increments the invocation counter by one.

Definition at line 94 of file ulxr_dispatcher.cpp.

bool ulxr::Dispatcher::MethodCallDescriptor::isEnabled

(

)

const

Returns the status of availability.

Returns:

true: method is available

Definition at line 100 of file ulxr_dispatcher.cpp.

void ulxr::Dispatcher::MethodCallDescriptor::setEnabled

(

bool

ena

)

const

Sets the status of availability.

Parameters:

ena

true: method is available

Definition at line 106 of file ulxr_dispatcher.cpp.

CppString ulxr::Dispatcher::MethodCallDescriptor::getMethodName

(

)

const

Gets the method name.

Returns:

method name

Definition at line 146 of file ulxr_dispatcher.cpp.

CppString ulxr::Dispatcher::MethodCallDescriptor::getParameterSignature

(

)

const

Gets the parameter signature.

Returns:

parameter signature

Definition at line 152 of file ulxr_dispatcher.cpp.

CppString ulxr::Dispatcher::MethodCallDescriptor::getReturnValueSignature

(

)

const

Gets the return value signature.

Returns:

return value signature

Definition at line 158 of file ulxr_dispatcher.cpp.

CppString ulxr::Dispatcher::MethodCallDescriptor::getDocumentation

(

)

const

Gets the documentation.

Returns:

documentation

Definition at line 164 of file ulxr_dispatcher.cpp.

Dispatcher::CallType ulxr::Dispatcher::MethodCallDescriptor::getCallType

(

)

const

Gets the call type.

Returns:

call type

Definition at line 170 of file ulxr_dispatcher.cpp.

---

Friends And Related Function Documentation

friend class Dispatcher [friend]

Definition at line 65 of file ulxr_dispatcher.h.

---

Member Data Documentation

CallType ulxr::Dispatcher::MethodCallDescriptor::calltype [private]

Definition at line 150 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

CppString ulxr::Dispatcher::MethodCallDescriptor::method_name [private]

Definition at line 151 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

CppString ulxr::Dispatcher::MethodCallDescriptor::signature [private]

Definition at line 152 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

CppString ulxr::Dispatcher::MethodCallDescriptor::return_signature [private]

Definition at line 153 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

CppString ulxr::Dispatcher::MethodCallDescriptor::documentation [private]

Definition at line 154 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

unsigned long ulxr::Dispatcher::MethodCallDescriptor::invoked [mutable, private]

Definition at line 156 of file ulxr_dispatcher.h.

Referenced by getInvoked(), and MethodCallDescriptor().

bool ulxr::Dispatcher::MethodCallDescriptor::enabled [mutable, private]

Definition at line 157 of file ulxr_dispatcher.h.

Referenced by MethodCallDescriptor().

---

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

• ulxr_dispatcher.h
• ulxr_dispatcher.cpp

---