Gorgon Game Engine
StaticMember Class Referenceabstract

This is the base class for all static members. More...

Inheritance diagram for StaticMember:
[legend]

Public Types

enum  MemberType {
  RegularType, EventType, EnumType, Namespace,
  DataMember, Function, Constant
}
 Possible member types. More...
 

Public Member Functions

 StaticMember (const std::string &name, const std::string &help)
 
virtual Data Get () const =0
 Returns the value of this static member. More...
 
virtual MemberType GetMemberType () const =0
 Returns the type of this member. More...
 
bool IsInstanceable () const
 Whether this member can be used to instantiate an object. More...
 
virtual bool IsInstanceMember () const override final
 Returns if this member is an instance member. More...
 
- Public Member Functions inherited from Member
 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...
 

Additional Inherited Members

- Protected Member Functions inherited from Member
virtual void SetParent (const Member &parent)
 Changes the parent of the member. More...
 
- Protected Attributes inherited from Member
std::string help
 Help string of the datamember. More...
 
std::string name
 The name of the datamember. More...
 
const Memberparent
 

Detailed Description

This is the base class for all static members.

Static members include Function, Type and variants, and Namespace.

Member Enumeration Documentation

◆ MemberType

enum MemberType

Possible member types.

Enumerator
RegularType 

A type.

EventType 

An event type, which contains additional information about an event.

EnumType 

Enumeration, which is also a type.

Namespace 

Namespace, which is also a type.

DataMember 

Data member.

Function 

Function, functions can also be represented as data members.

Constant 

Static fixed constant.

Constructor & Destructor Documentation

◆ StaticMember()

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

Member Function Documentation

◆ Get()

virtual Data Get ( ) const
pure virtual

Returns the value of this static member.

For types and functions, this function returns type and function objects.

Implemented in EnumType, EventType, Constant, Function, Type, Namespace, and StaticDataMember.

◆ GetMemberType()

virtual MemberType GetMemberType ( ) const
pure virtual

Returns the type of this member.

Implemented in Constant, EnumType, EventType, Type, Namespace, Function, and StaticDataMember.

◆ IsInstanceable()

bool IsInstanceable ( ) const

Whether this member can be used to instantiate an object.

Determined using GetMemberType

References StaticMember::GetMemberType().

◆ IsInstanceMember()

virtual bool IsInstanceMember ( ) const
finaloverridevirtual

Returns if this member is an instance member.

Implements Member.


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