#include <TTask.h>

Inheritance diagram for TTask:

Public Types
enum	State { State_Created = BITFLAG( 0 ) , State_Active = BITFLAG( 1 ) , State_Dying = BITFLAG( 2 ) }

using	ThisClass = TTask

using	BaseClass = TObject

Public Types inherited from TObject
enum	{ IsTObject = TTRUE }

Public Member Functions
virtual Toshi::TClass *	GetClass () override

	TTask ()

virtual	~TTask ()

virtual TBOOL	Create ()

virtual TBOOL	CreateFailed ()

virtual TBOOL	Reset ()

virtual TBOOL	OnCreate ()

virtual TBOOL	OnUpdate (TFLOAT a_fDeltaTime)

virtual void	OnPreDestroy ()

virtual void	OnDestroy ()

virtual TBOOL	OnChildDying (TTask *child)

virtual void	OnChildDied (TClass a_pClass, TTask a_pDeletedTask)

virtual void	OnActivate ()

virtual void	OnDeactivate ()

void	Activate (TBOOL activate)

void	SetParent (TTask *a_pAttachTo)

TUINT32 &	GetFlags ()

TBOOL	IsCreated () const

TBOOL	IsActive () const

TBOOL	IsCreatedAndActive () const

TBOOL	IsDying () const

Public Member Functions inherited from TObject
virtual void	Delete ()

virtual	~TObject ()

TBOOL	IsExactly (TClass *a_pClass)

TBOOL	IsA (TClass *a_pClass)

Public Member Functions inherited from TRefCounted
	TRefCounted ()

	~TRefCounted ()

TINT	DecRefCount ()

TINT	GetRefCount ()

TINT	IncRefCount ()

TRefCounted &	operator= (TRefCounted const &)

Public Member Functions inherited from TNodeTree< T >::TNode
TBOOL	IsChildOfDefaultRoot () const

TBOOL	IsLinked () const

T *	Parent () const

T *	Next () const

T *	Prev () const

TNodeTree< T > *	Tree () const

T *	Child () const

Static Public Member Functions
static Toshi::TObject *	CreateTObject ()

static Toshi::TObject *	CreateTObjectInPlace (void *a_pPtr)

static void	InitialiseClass ()

static void	DeinitialiseClass ()

static TFORCEINLINE Toshi::TClass *	GetClassStatic ()

Static Public Member Functions inherited from TObject
static Toshi::TObject *	CreateTObject ()

static Toshi::TObject *	CreateTObjectInPlace (void *a_pPtr)

static void	InitialiseClass ()

static void	DeinitialiseClass ()

static TFORCEINLINE TClass *	GetClassStatic ()

Public Attributes
friend	TScheduler

Public Attributes inherited from TNodeTree< T >::TNode
friend	TNodeTree

Static Public Attributes
static constexpr Toshi::TClass *	PARENTCLASS = & TObject::ms_oClass

static Toshi::TClass	ms_oClass = Toshi::TClass( "TTask", TTask::PARENTCLASS, TTask::CreateTObject, TTask::CreateTObjectInPlace, TTask::InitialiseClass, TTask::DeinitialiseClass, 0, 1, sizeof( TTask ), alignof( TTask ) )

Static Public Attributes inherited from TObject
static constexpr Toshi::TClass *	PARENTCLASS = TNULL

static constinit Toshi::TClass	ms_oClass = Toshi::TClass( "TObject", TObject::CreateTObject, TObject::CreateTObjectInPlace, TObject::InitialiseClass, TObject::DeinitialiseClass, 0, 2, sizeof( TObject ), alignof( TObject ) )

Additional Inherited Members
Protected Member Functions inherited from TNodeTree< T >::TNode
	TNode ()

Protected Attributes inherited from TRefCounted
TINT	m_iRefCount

Protected Attributes inherited from TNodeTree< T >::TNode
TNodeTree< T > *	m_Tree

T *	m_Next

T *	m_Prev

T *	m_Parent

T *	m_Child

Detailed Description

Definition at line 10 of file TTask.h.

Member Typedef Documentation

◆ BaseClass

using TTask::BaseClass = TObject

Definition at line 15 of file TTask.h.

◆ ThisClass

using TTask::ThisClass = TTask

Definition at line 15 of file TTask.h.

Member Enumeration Documentation

◆ State

enum TTask::State

Enumerator
State_Created
State_Active
State_Dying

Definition at line 20 of file TTask.h.

    {
        State_Created = BITFLAG( 0 ),
        State_Active  = BITFLAG( 1 ),
        State_Dying   = BITFLAG( 2 ),
    };

Constructor & Destructor Documentation

◆ TTask()

TTask::TTask ( )

Definition at line 14 of file TTask.cpp.

{
    m_State = 0;
}

◆ ~TTask()

TTask::~TTask ( )

virtual

Definition at line 19 of file TTask.cpp.

{
    TASSERT( IsLinked() == TFALSE );
}

Member Function Documentation

◆ Activate()

void TTask::Activate ( TBOOL activate )

Definition at line 110 of file TTask.cpp.

{
    TUINT8 oldState = m_State;
    TUINT8 newFlags = activate ? State_Active : 0;
 
    m_State = ( m_State & ~State_Active ) | newFlags;
 
    if ( oldState != m_State )
    {
        if ( activate )
        {
            OnActivate();
        }
        else
        {
            OnDeactivate();
        }
    }
}

◆ Create()

TBOOL TTask::Create ( )

virtual

Definition at line 24 of file TTask.cpp.

{
    TASSERT( IsCreated() == TFALSE );
 
    if ( !IsCreated() )
    {
        if ( !OnCreate() )
        {
            OnDestroy();
            m_Tree->Remove( this, TFALSE );
            Delete();
 
            return TFALSE;
        }
 
        TUINT32 oldState = m_State;
        m_State |= State_Created;
        Activate( TTRUE );
    }
 
    return TTRUE;
}

◆ CreateFailed()

TBOOL TTask::CreateFailed ( )

virtual

Definition at line 47 of file TTask.cpp.

{
    TASSERT( IsCreated() == TFALSE );
 
    if ( !IsCreated() )
    {
        m_Tree->Remove( this, TFALSE );
        Delete();
    }
 
    return TFALSE;
}

◆ CreateTObject()

Toshi::TObject * TTask::CreateTObject ( )

static

Definition at line 12 of file TTask.cpp.

◆ CreateTObjectInPlace()

Toshi::TObject * TTask::CreateTObjectInPlace ( void * a_pPtr )

static

Definition at line 12 of file TTask.cpp.

◆ DeinitialiseClass()

void TTask::DeinitialiseClass ( )

static

Definition at line 12 of file TTask.cpp.

◆ GetClass()

Toshi::TClass * TTask::GetClass ( )

overridevirtual

Reimplemented from TObject.

Definition at line 12 of file TTask.cpp.

◆ GetClassStatic()

static TFORCEINLINE Toshi::TClass * TTask::GetClassStatic ( )

inlinestatic

Definition at line 15 of file TTask.h.

◆ GetFlags()

TUINT32 & TTask::GetFlags ( )

inline

Definition at line 46 of file TTask.h.

46{ return m_State; }

◆ InitialiseClass()

void TTask::InitialiseClass ( )

static

Definition at line 12 of file TTask.cpp.

◆ IsActive()

TBOOL TTask::IsActive ( ) const

inline

Definition at line 48 of file TTask.h.

48{ return m_State & State_Active; }

◆ IsCreated()

TBOOL TTask::IsCreated ( ) const

inline

Definition at line 47 of file TTask.h.

47{ return m_State & State_Created; }

◆ IsCreatedAndActive()

TBOOL TTask::IsCreatedAndActive ( ) const

inline

Definition at line 49 of file TTask.h.

49{ return ( m_State & ( State_Created | State_Active ) ) == ( State_Created | State_Active ); }

◆ IsDying()

TBOOL TTask::IsDying ( ) const

inline

Definition at line 50 of file TTask.h.

50{ return m_State & State_Dying; }

◆ OnActivate()

void TTask::OnActivate ( )

virtual

Definition at line 102 of file TTask.cpp.

103{

104}

◆ OnChildDied()

void TTask::OnChildDied	(	TClass *	a_pClass,
		TTask *	a_pDeletedTask )

virtual

Definition at line 98 of file TTask.cpp.

99{

100}

◆ OnChildDying()

TBOOL TTask::OnChildDying ( TTask * child )

virtual

Definition at line 93 of file TTask.cpp.

{
    return TTRUE;
}

◆ OnCreate()

TBOOL TTask::OnCreate ( )

virtual

Definition at line 75 of file TTask.cpp.

{
    return TTRUE;
}

◆ OnDeactivate()

void TTask::OnDeactivate ( )

virtual

Definition at line 106 of file TTask.cpp.

107{

108}

◆ OnDestroy()

void TTask::OnDestroy ( )

virtual

Definition at line 89 of file TTask.cpp.

90{

91}

◆ OnPreDestroy()

void TTask::OnPreDestroy ( )

virtual

Definition at line 85 of file TTask.cpp.

86{

87}

◆ OnUpdate()

TBOOL TTask::OnUpdate ( TFLOAT a_fDeltaTime )

virtual

Definition at line 80 of file TTask.cpp.

{
    return TTRUE;
}

◆ Reset()

TBOOL TTask::Reset ( )

virtual

Definition at line 60 of file TTask.cpp.

{
    TTask* firstAttached = Child();
    TTask* node          = firstAttached;
    TBOOL  result        = TTRUE;
 
    while ( node != TNULL && node != firstAttached )
    {
        result &= node->Reset();
        node = node->Next();
    }
 
    return result;
}

◆ SetParent()

void TTask::SetParent ( TTask * a_pAttachTo )

Definition at line 130 of file TTask.cpp.

{
    if ( this != Parent() && a_pAttachTo != TNULL )
    {
        Tree()->ReInsert( this != Parent() ? a_pAttachTo : TNULL, this );
    }
}

Member Data Documentation

◆ ms_oClass

Toshi::TClass TTask::ms_oClass = Toshi::TClass( "TTask", TTask::PARENTCLASS, TTask::CreateTObject, TTask::CreateTObjectInPlace, TTask::InitialiseClass, TTask::DeinitialiseClass, 0, 1, sizeof( TTask ), alignof( TTask ) )

static

Definition at line 15 of file TTask.h.

◆ PARENTCLASS

Toshi::TClass* TTask::PARENTCLASS = & TObject::ms_oClass

staticconstexpr

Definition at line 15 of file TTask.h.

◆ TScheduler

friend TTask::TScheduler

Definition at line 18 of file TTask.h.

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

D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TTask.h
D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TTask.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ ThisClass

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ TTask()

◆ ~TTask()

Member Function Documentation

◆ Activate()

◆ Create()

◆ CreateFailed()

◆ CreateTObject()

◆ CreateTObjectInPlace()

◆ DeinitialiseClass()

◆ GetClass()

◆ GetClassStatic()

◆ GetFlags()

◆ InitialiseClass()

◆ IsActive()

◆ IsCreated()

◆ IsCreatedAndActive()

◆ IsDying()

◆ OnActivate()

◆ OnChildDied()

◆ OnChildDying()

◆ OnCreate()

◆ OnDeactivate()

◆ OnDestroy()

◆ OnPreDestroy()

◆ OnUpdate()

◆ Reset()

◆ SetParent()

Member Data Documentation

◆ ms_oClass

◆ PARENTCLASS

◆ TScheduler