CascadeVessel.h

Go to the documentation of this file.

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEVESSEL_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEVESSEL_H

#include <cascade/CascadeTypedefs.h>
#include <cascade/app/CascadeMountMessage.h>
#include <cascade/util/CascadeString.h>
#include <cascade/util/CascadeArray.h>
#include <cascade/util/CascadeFSObject.h>
#include <cascade/graphics/CascadeDims.h>

class Vessel
{
public:
    Vessel()
        : m_name(""), m_mountPath(""), m_workingPath(""), m_capacity(0), 
          m_capacityAvailable(0), m_imageCount(0), m_musicCount(0), 
          m_executables(NULL){}
    Vessel( CascadeMountMessage::MediaType type,
            const CascadeString name,
            const CascadeString path );
    virtual ~Vessel(){}

    CascadeString m_name;         // such as "Compact Flash"
    CascadeString m_mountPath;    // such as /mnt/compactflash
    CascadeString m_workingPath;  // such as /mnt/compactflash/Images/Planes
    CascadeString m_renderText;   // such as silverbox/ph...
    CascadeDims   m_renderDims;   // dims of m_renderText
    u64     m_capacity;                 // size, in bytes
    u64     m_capacityAvailable;        // available space, in bytes
    u32     m_imageCount;               // number of image-type files on the volume
    u32     m_musicCount;               // number of music-type files on the volume
    u32         m_executableCount;                      // number of roku-recognized executable files on the volume
    CascadeTemplateArray<CascadeFSObject*>* m_executables;
    CascadeMountMessage::MediaType m_vesselType;

    static Vessel * GetInternalVessel( void );
    static bool GetMountedVessels( CascadeTemplateArray<Vessel*>* &inArrayToFill );
    static bool GetContainingVessel( const CascadeString &inPath,
                                     Vessel* &outVessel );
    static void ConvertEscapedOctalCharacters( CascadeString &string );

};

#endif //_ROKU_INCLUDE_CASCADE_UTIL_CASCADEVESSEL_H

//  LOG
//  11-Nov-04   dwoodward   added m_renderText and m_renderDims
//  18-May-05   mjkobb      Added GetInternalVessel

---