PLCore::MemberDesc Class Reference

Member descriptor. More...

#include <MemberDesc.h>

Inheritance diagram for PLCore::MemberDesc:

List of all members.

Public Member Functions
PLCORE_API	MemberDesc (EMemberType nMemberType, const String &sName, const String &sDescription, const String &sAnnotation)
	Constructor.
virtual PLCORE_API	~MemberDesc ()
	Destructor.
EMemberType	GetMemberType () const
	Get member type.
String	GetName () const
	Get name.
String	GetDescription () const
	Get description.
String	GetAnnotation () const
	Get annotation.
Protected Member Functions
PLCORE_API void	Register (ClassReal *pClass)
	Register member at class.
Protected Attributes
EMemberType	m_nMemberType
String	m_sName
String	m_sDescription
String	m_sAnnotation

---

Detailed Description

Member descriptor.

Remarks:

This class contains a descriptor for a member of a class, such as a variable or a method. It consists of information equal for all member types (name, description, etc.).

---

Constructor & Destructor Documentation

PLCORE_API PLCore::MemberDesc::MemberDesc	(	EMemberType	nMemberType,
		const String &	sName,
		const String &	sDescription,
		const String &	sAnnotation
	)

Constructor.

Parameters:

[in]	nMemberType	Member type
[in]	sName	Var name
[in]	sDescription	Var description
[in]	sAnnotation	Var annotation

virtual PLCORE_API PLCore::MemberDesc::~MemberDesc

(

)

[virtual]

Destructor.

---

Member Function Documentation

EMemberType PLCore::MemberDesc::GetMemberType

(

)

const [inline]

Get member type.

Get type.

Returns:

Member type

String PLCore::MemberDesc::GetName

(

)

const [inline]

Get name.

Returns:

Name

String PLCore::MemberDesc::GetDescription

(

)

const [inline]

Get description.

Returns:

Description

String PLCore::MemberDesc::GetAnnotation

(

)

const [inline]

Get annotation.

Returns:

Annotation

PLCORE_API void PLCore::MemberDesc::Register

(

ClassReal *

pClass

)

[protected]

Register member at class.

Parameters:

[in]

pClass

Pointer to class (must be valid!)

---

Member Data Documentation

EMemberType PLCore::MemberDesc::m_nMemberType [protected]

Member type

String PLCore::MemberDesc::m_sName [protected]

Name

String PLCore::MemberDesc::m_sDescription [protected]

Description

String PLCore::MemberDesc::m_sAnnotation [protected]

Annotation

---

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

• MemberDesc.h
• MemberDesc.inl