PikeAero::CMap Class Reference

#include <cmap.h>

Inheritance diagram for PikeAero::CMap:

[legend]

Collaboration diagram for PikeAero::CMap:

[legend]

Data Structures
union	tMap
	Map union. More...
struct	tMap1D
struct	tMap1DScaled
struct	tMap2D
struct	tMap2DScaled
Public Types
Public Member Functions
virtual CMachine::ubit32	calculateCRC ()
	Calculate a CRC record for the map.
	CMap (CConfiguration *config, tMap *map)
CConfiguration *	config ()
bool	load ()
	Load the record into volatile memory.
bool	loaded ()
tMap *	map ()
tMap *	romMap ()
void	unload ()
	Unload the record from volatile memory.
virtual bool	valid ()
	record is valid?
bool	validType (tMapType type)
virtual	~CMap ()
Private Attributes
CConfiguration *	mConfig
bool	mLoaded
tMap *	mMap
tMap *	mRomMap

---

Detailed Description

Definition at line 37 of file cmap.h.

---

Member Enumeration Documentation

enum PikeAero::CMap::tDataType

Enumerated data type for describing the type of dat contained in a map.

Enumerator:

invalid
typeReal	Unknown
typeBit8	Real Number
typeUBit8	8 bit signed
typeBit16	8 bit unsigned
typeUBit16	16 bit signed
typeBit32	16 bit unsigned
typeUBit32	32 bit signed 32 bit unsigned

Definition at line 45 of file cmap.h.

        {
            invalid         =   0,      /** Unknown */
            typeReal        =   1,      /** Real Number */
            typeBit8,                   /** 8 bit signed */
            typeUBit8,                  /** 8 bit unsigned */
            typeBit16,                  /** 16 bit signed */
            typeUBit16,                 /** 16 bit unsigned */
            typeBit32,                  /** 32 bit signed */
            typeUBit32                  /** 32 bit unsigned */
        } tDataType;

enum PikeAero::CMap::tMapType

describes the type of map.

Enumerator:

unknown
map1D	Unknown
map1DScaled	1D Map
map2D	1D Map Scaled
map2DScaled	2D Map

Definition at line 60 of file cmap.h.

        {
            unknown         =   0,      /** Unknown */
            map1D           =   1,      /** 1D Map */
            map1DScaled,                /** 1D Map Scaled */
            map2D,                      /** 2D Map */
            map2DScaled,                /** 2D Map Scaled */
        } tMapType;

---

Constructor & Destructor Documentation

PikeAero::CMap::CMap	(	CConfiguration *	config,
		tMap *	map
	)

Definition at line 27 of file cmap.cpp.

: inherited()
, mConfig(config)
, mRomMap(map)
, mMap(NULL)
, mLoaded(false)
{

}

PikeAero::CMap::~CMap

(

)

[virtual]

Definition at line 37 of file cmap.cpp.

References unload().

{
    unload();
}

Here is the call graph for this function:

---

Member Function Documentation

CMachine::ubit32 PikeAero::CMap::calculateCRC

(

)

[virtual]

Calculate a CRC record for the map.

FIXME - do stuff

Definition at line 102 of file cmap.cpp.

Referenced by valid().

{
    /** FIXME - do stuff */
    return 0;
}

Here is the caller graph for this function:

CConfiguration* PikeAero::CMap::config

(

)

[inline]

Definition at line 118 of file cmap.h.

References mConfig.

{ return mConfig; }

bool PikeAero::CMap::load

(

)

Load the record into volatile memory.

Returns:

true on success else false.

FIXME - do stuff here

Definition at line 46 of file cmap.cpp.

References PikeAero::CMemHeap::malloc(), memset, mLoaded, mMap, unload(), and valid().

{
    unload();
    mMap = (tMap*)CMemHeap::malloc(sizeof(tMap));
    memset(mMap,0,sizeof(tMap));
    if ( valid() )
    {
        /** FIXME - do stuff here */
        mLoaded = true;
    }
    else
    {
        mLoaded = true;
    }
    return mLoaded;
}

Here is the call graph for this function:

bool PikeAero::CMap::loaded

(

)

[inline]

Definition at line 117 of file cmap.h.

References mLoaded.

Referenced by map().

{ return mLoaded; }

Here is the caller graph for this function:

tMap* PikeAero::CMap::map

(

)

[inline]

Definition at line 120 of file cmap.h.

References loaded(), mMap, and romMap().

Referenced by valid().

{ return loaded() ? mMap : romMap(); }

Here is the call graph for this function:

Here is the caller graph for this function:

tMap* PikeAero::CMap::romMap

(

)

[inline]

Definition at line 119 of file cmap.h.

References mRomMap.

Referenced by map().

{ return mRomMap; }

Here is the caller graph for this function:

void PikeAero::CMap::unload

(

)

Unload the record from volatile memory.

Definition at line 67 of file cmap.cpp.

References PikeAero::CMemHeap::free(), mLoaded, and mMap.

Referenced by load(), and ~CMap().

{
    if ( mMap != NULL )
    {
        CMemHeap::free( mMap );
        mMap = NULL;
    }
    mLoaded = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool PikeAero::CMap::valid

(

)

[virtual]

record is valid?

Reimplemented in PikeAero::CMap1D.

Definition at line 80 of file cmap.cpp.

References calculateCRC(), map(), MAP_HEAD, MAP_TAIL, and validType().

Referenced by load().

{
    bool rc = false;
    if ( map()->head == MAP_HEAD )
    {
        if ( map()->tail == MAP_TAIL )
        {
            if ( validType( (CMap::tMapType)map()->type ) )
            {
                if ( map()->crc == calculateCRC() )
                {
                    rc = true;
                }
            }
        }
    }
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool PikeAero::CMap::validType

(

tMapType

type

)

[inline]

Definition at line 121 of file cmap.h.

References map2DScaled, and unknown.

Referenced by valid().

{ return type > unknown && type <= map2DScaled; }

Here is the caller graph for this function:

---

Field Documentation

CConfiguration* PikeAero::CMap::mConfig [private]

Reimplemented in PikeAero::CMap1D.

Definition at line 146 of file cmap.h.

Referenced by config().

bool PikeAero::CMap::mLoaded [private]

the in-RAM map pointer

Definition at line 149 of file cmap.h.

Referenced by load(), loaded(), and unload().

tMap* PikeAero::CMap::mMap [private]

the in-ROM map pointer

Reimplemented in PikeAero::CMap1D.

Definition at line 148 of file cmap.h.

Referenced by load(), map(), and unload().

tMap* PikeAero::CMap::mRomMap [private]

the configuration record

Reimplemented in PikeAero::CMap1D.

Definition at line 147 of file cmap.h.

Referenced by romMap().

---

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

• cmap.h
• cmap.cpp