CyberEngineMkIII
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CYB::API::Interop::Allocatable Class Reference

Defines the base class for allocatable engine objects. More...

#include <Allocatable.hpp>

Inheritance diagram for CYB::API::Interop::Allocatable:
Inheritance graph
[legend]

Public Types

enum  ID {
  ID::NULL_ID, ID::File, ID::Mutex, ID::Path,
  ID::Semaphore
}
 Defines the IDs of allocatable engine objects. More...
 
using Constructor = NullConstructor
 Override in descendants.
 
using CopyConstructor = NullConstructor
 Override in descendants.
 

Public Member Functions

virtual ~Allocatable ()=default
 See Default Constructors and Destructor.
 

Static Public Member Functions

template<class AParent >
static constexpr ID GetID (void)
 Returns the ID of an allocatable object. More...
 

Detailed Description

Defines the base class for allocatable engine objects.

Definition at line 7 of file Allocatable.hpp.

Member Enumeration Documentation

Defines the IDs of allocatable engine objects.

Enumerator
NULL_ID 

Used in case of error.

File 

CYB::API::File.

Mutex 

CYB::API::Mutex.

Path 

CYB::API::Path.

Semaphore 

CYB::API::Semaphore.

Definition at line 10 of file Allocatable.hpp.

10  {
11  NULL_ID,
12  File,
13  Mutex,
14  Path,
15  Semaphore,
16  };

Member Function Documentation

template<class AParent >
static constexpr ID CYB::API::Interop::Allocatable::GetID ( void  )
static

Returns the ID of an allocatable object.

Template Parameters
AParentThe allocatable object whose ID is being checked
Returns
The ID of AParent

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