PikeAero::CTaskConsolePacket Class Reference

The packetized console object. More...

#include <ctaskconsolepacket.h>

Inheritance diagram for PikeAero::CTaskConsolePacket:

[legend]

Collaboration diagram for PikeAero::CTaskConsolePacket:

[legend]

Public Member Functions
	CTaskConsolePacket (CCommunication *comm)
virtual void	event (CEvent *e)
	Receive a software event.
virtual CMachine::bit32	fault ()
	The CTaskScheduler will call the fault() method when a fault code was returned by any of the task's other methods.
virtual CMachine::bit32	init ()
	Called exactly once. perform task initialization such as initializing private variable. other tasks are not guaranteed so do not interract with other tasks at this stage.
virtual const char *	name ()
virtual CMachine::bit32	run ()
	Called periodically by CTaskScheduler to do a piece of work.
virtual CMachine::bit32	start ()
	Called exactly once. all tasks are initialized at this point. called just prior to first call to run().
virtual CMachine::bit32	stop ()
	The CTaskScheduler will call the stop() method after the task was scheduled for cancelation.
virtual	~CTaskConsolePacket ()
Protected Member Functions
CCommandHandler *	commandHandler ()
CMachine::bit32	execute (CString *command)
	Execute a command.
virtual void	monitor ()
Private Attributes
CCommandHandler *	mCommandHandler

---

Detailed Description

The packetized console object.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 32 of file ctaskconsolepacket.h.

---

Constructor & Destructor Documentation

PikeAero::CTaskConsolePacket::CTaskConsolePacket

(

CCommunication *

comm

)

Definition at line 29 of file ctaskconsolepacket.cpp.

 : inherited(comm)
 , mCommandHandler(NULL)
{
}

PikeAero::CTaskConsolePacket::~CTaskConsolePacket

(

)

[virtual]

Definition at line 36 of file ctaskconsolepacket.cpp.

References mCommandHandler.

{
    if ( mCommandHandler != NULL )
    {
        delete mCommandHandler;
        mCommandHandler = NULL;
    }
}

---

Member Function Documentation

CCommandHandler* PikeAero::CTaskConsolePacket::commandHandler

(

)

[inline, protected]

Definition at line 71 of file ctaskconsolepacket.h.

References mCommandHandler.

Referenced by execute().

{return mCommandHandler;}

Here is the caller graph for this function:

void PikeAero::CTaskConsolePacket::event

(

CEvent *

e

)

[virtual]

Receive a software event.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 145 of file ctaskconsolepacket.cpp.

{
    inherited::event(e);
}

CMachine::bit32 PikeAero::CTaskConsolePacket::execute

(

CString *

command

)

[protected]

Execute a command.

Delete the argument string objects...

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 153 of file ctaskconsolepacket.cpp.

References PikeAero::CArray< T >::at(), commandHandler(), PikeAero::CArray< T >::count(), PikeAero::CCommandHandler::execute(), and PikeAero::CString::explode().

Referenced by run().

{
    CArray<CString*> argv = command->explode(':');
    CMachine::bit32 rc = commandHandler()->execute(argv);

    /**
    ** Delete the argument string objects...
    */
    for ( CMachine::ubit32 i = 0; i < argv.count(); i++ )
    {
        CString* str = argv.at(i);
        delete str;
    }
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsolePacket::fault

(

)

[virtual]

The CTaskScheduler will call the fault() method when a fault code was returned by any of the task's other methods.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 110 of file ctaskconsolepacket.cpp.

References stop().

{
    return inherited::stop();
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsolePacket::init

(

)

[virtual]

Called exactly once. perform task initialization such as initializing private variable. other tasks are not guaranteed so do not interract with other tasks at this stage.

called exactly once. perform task initialization such as initializing private variable other tasks are not guaranteed so do not interract with other tasks at this stage.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 49 of file ctaskconsolepacket.cpp.

{
    return inherited::init();
}

void PikeAero::CTaskConsolePacket::monitor

(

)

[protected, virtual]

FIXME - move all this stuff to CStatistics class and reply on demand only

FIXME - move all this stuff to CStatistics class and reply on demand only

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 115 of file ctaskconsolepacket.cpp.

References PikeAero::CTaskConsoleBase::aggregator(), PikeAero::CMemHeap::available(), PikeAero::CMemHeap::bottom(), PikeAero::CTaskTerminal::comm(), PikeAero::CTaskScheduler::count(), PikeAero::CTaskConsoleBase::mAggregator, PikeAero::CString::sprintf(), stackPointer, stackTop, PikeAero::CMemHeap::top(), PikeAero::CCommunication::tx(), and PikeAero::CMemHeap::used().

{
    if ( mAggregator != NULL )
    {
        CString str;
        comm()->tx("RPY");

        CMachine::ubit32 taskCount = CTaskScheduler::count();
        CMachine::ubit32 top = stackTop();
        CMachine::ubit32 ptr = stackPointer();

        /** FIXME - move all this stuff to CStatistics class and reply on demand only  */
        comm()->tx( str.sprintf( ":SWP:%d:%d:%d", aggregator()->taskSlicesPerSecond(), 1000000/aggregator()->taskSlicesPerSecond(), aggregator()->vectorIRQCountPerSecond() ) );
        comm()->tx( str.sprintf( ":EVT:%d:%d:%d", aggregator()->enqueueEventsPerSecond(), aggregator()->deliverEventsPerSecond(), aggregator()->maxEventsInQueuePerSecond() ) );
        comm()->tx( str.sprintf( ":STK:%d:%d:%d", top-(CMachine::ubit32)CMemHeap::top(), (top-(CMachine::ubit32)CMemHeap::top())-(top-ptr), top-ptr  ) );
        comm()->tx( str.sprintf( ":HEP:%d:%d:%d", CMemHeap::top()-CMemHeap::bottom(), CMemHeap::used(), CMemHeap::available() ) );

        /** FIXME - move all this stuff to CStatistics class and reply on demand only  */
        for( CMachine::ubit32 i=0; i < 16; i++ )
        {
            comm()->tx( str.sprintf( ":A:%d:%d", i, aggregator()->analog(i) ) );
        }

        comm()->tx( str.sprintf( ":R:%d\n\r", aggregator()->rpm() ) );
    }
}

Here is the call graph for this function:

virtual const char* PikeAero::CTaskConsolePacket::name

(

)

[inline, virtual]

Returns:

A CString containing an human readable name for the task.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 39 of file ctaskconsolepacket.h.

{return "CTaskConsolePacket";}

CMachine::bit32 PikeAero::CTaskConsolePacket::run

(

)

[virtual]

Called periodically by CTaskScheduler to do a piece of work.

called periodically by CTaskScheduler to do a piece of work.

Returns:

0 on success.

interpret input here

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 80 of file ctaskconsolepacket.cpp.

References PikeAero::CString::append(), PikeAero::CByteArray::clear(), PikeAero::CTaskTerminal::comm(), execute(), PikeAero::CTaskConsoleBase::mCommandLine, PikeAero::CTaskConsoleBase::mMonitorMode, PikeAero::CTaskConsoleBase::monitorNone, and PikeAero::CCommunication::rx().

{
    /** interpret input here  */
    while ( comm()->rxReady() )
    {
        CMachine::ubit8 ch = comm()->rx();
        mMonitorMode = monitorNone;
        switch ( ch )
        {
            case '\n':
            case '\r':
                execute( &mCommandLine );
                mCommandLine.clear();
            break;
            default:
                if ( ch >= ' ' && ch <= '~' )
                {
                    mCommandLine.append(ch);
                }
                break;
        }
    }

    return 0;
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsolePacket::start

(

)

[virtual]

Called exactly once. all tasks are initialized at this point. called just prior to first call to run().

called exactly once. all tasks are initialized at this point. called just prior to first call to run()

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 58 of file ctaskconsolepacket.cpp.

References PikeAero::CTaskConsoleBase::aggregator(), PikeAero::CTaskTerminal::comm(), and mCommandHandler.

{
    CMachine::bit32 rc = inherited::start();
    mCommandHandler = new CCommandHandler(comm(),aggregator());
    return rc;
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsolePacket::stop

(

)

[virtual]

The CTaskScheduler will call the stop() method after the task was scheduled for cancelation.

The CTaskScheduler will call the stop () method after the task was scheduled for cancelation.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 69 of file ctaskconsolepacket.cpp.

References mCommandHandler.

Referenced by fault().

{
    delete mCommandHandler;
    mCommandHandler = NULL;
    return inherited::stop();
}

Here is the caller graph for this function:

---

Field Documentation

CCommandHandler* PikeAero::CTaskConsolePacket::mCommandHandler [private]

Definition at line 75 of file ctaskconsolepacket.h.

Referenced by commandHandler(), start(), stop(), and ~CTaskConsolePacket().

---

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

• ctaskconsolepacket.h
• ctaskconsolepacket.cpp