Gorgon Game Engine
Member Class Referenceabstract

Represents a member of a type. More...

Inheritance diagram for Member:
[legend]

Public Member Functions

 Member (const std::string &name, const std::string &help)
 
virtual ~Member ()
 
std::string GetHelp () const
 Returns the help string. Help strings may contain markdown notation. More...
 
std::string GetName () const
 Returns the name of this member. More...
 
const MemberGetOwner () const
 
std::string GetQualifiedName () const
 Returns the namespace qualified name of this member. More...
 
virtual bool IsInstanceMember () const =0
 Returns if this member is an instance member. More...
 

Protected Member Functions

virtual void SetParent (const Member &parent)
 Changes the parent of the member. More...
 

Protected Attributes

std::string help
 Help string of the datamember. More...
 
std::string name
 The name of the datamember. More...
 
const Memberparent
 

Detailed Description

Represents a member of a type.

This serves as a code base to other member types: StaticMember and InstanceMember

Constructor & Destructor Documentation

◆ Member()

Member ( const std::string &  name,
const std::string &  help 
)

◆ ~Member()

virtual ~Member ( )
virtual

Member Function Documentation

◆ GetHelp()

std::string GetHelp ( ) const

Returns the help string. Help strings may contain markdown notation.

References Member::help.

◆ GetName()

std::string GetName ( ) const

Returns the name of this member.

References Member::name.

◆ GetOwner()

const Member* GetOwner ( ) const

References Member::parent.

◆ GetQualifiedName()

std::string GetQualifiedName ( ) const

Returns the namespace qualified name of this member.

References Member::GetQualifiedName(), Member::name, and Member::parent.

◆ IsInstanceMember()

virtual bool IsInstanceMember ( ) const
pure virtual

Returns if this member is an instance member.

Implemented in InstanceMember, and StaticMember.

◆ SetParent()

virtual void SetParent ( const Member parent)
protectedvirtual

Changes the parent of the member.

Subclasses may perform additional checks when the parent is determined. Subclass should always call parent class' SetParent function first

Reimplemented in Function, and Library.

References Member::parent.

Member Data Documentation

◆ help

std::string help
protected

Help string of the datamember.

◆ name

std::string name
protected

The name of the datamember.

◆ parent

const Member* parent
protected

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