ExternalDataAccess Class Reference

#include <ExternalDataAccess.h>

List of all members.

Public Types

enum   DataType {
  kEnvironments = 0, kRecentFiles = 1, kCamera = 2, kStyles = 3,
  kShots = 4
}
 

These are exposed as parameters to certain messages and should never be modified.

More...
enum   Parameter {
  kEnvironmentId = 0, kEnvironmentLabel, kEnvironmentPath, kEnvironmentThumbnailPath,
  kRecentLabel = 10, kRecentPath, kRecentThumbnailPath, kCameraFocalLength = 20,
  kCameraCompensation, kStyleId = 30, kStyleLabel, kStyleThumbnailPath,
  kShotId = 40, kShotLabel, kShotThumbnailPath
}

Public Member Functions

bool  registerAccess (DataType type, ExternalData &data)
bool  deregisterAccess (DataType type)
bool  isRegistered (DataType type)
ExternalDataRef  getData (DataType type)
bool  hasUnsynchronizedData () const

Static Public Member Functions

static ExternalDataAccess instance ()
static void  destruct ()
static const awString::IString &  getParameterName (Parameter p)
static const awString::IString &  getTypeName (DataType dt)
static ExternalDataAccess::DataType  getTypeFromName (const awString::IString &tn)

Protected Member Functions

  ExternalDataAccess ()
virtual  ~ExternalDataAccess ()

Member Enumeration Documentation

enum DataType

These are exposed as parameters to certain messages and should never be modified.

Enumerator:
kEnvironments 
kRecentFiles 
kCamera 
kStyles 
kShots 
    {
          kEnvironments = 0
        , kRecentFiles = 1
        , kCamera = 2
        , kStyles = 3
        , kShots = 4
    };
Enumerator:
kEnvironmentId 
kEnvironmentLabel 
kEnvironmentPath 
kEnvironmentThumbnailPath 
kRecentLabel 
kRecentPath 
kRecentThumbnailPath 
kCameraFocalLength 
kCameraCompensation 
kStyleId 
kStyleLabel 
kStyleThumbnailPath 
kShotId 
kShotLabel 
kShotThumbnailPath 
    {
        // Environment parameters
        //
          kEnvironmentId=0
        , kEnvironmentLabel
        , kEnvironmentPath
        , kEnvironmentThumbnailPath

        // Recent files parameters
        , kRecentLabel=10
        , kRecentPath
        , kRecentThumbnailPath

        // Camera parameters
        //
        , kCameraFocalLength=20
        , kCameraCompensation

        // Styles parameters
        //
        , kStyleId=30
        , kStyleLabel
        , kStyleThumbnailPath

        // Shots parameters
        //
        , kShotId=40
        , kShotLabel
        , kShotThumbnailPath
    };

Constructor & Destructor Documentation

ExternalDataAccess ( ) [protected]
virtual ~ExternalDataAccess ( ) [protected, virtual]

Member Function Documentation

static ExternalDataAccess& instance ( ) [static]
static void destruct ( ) [static]
static const awString::IString& getParameterName ( Parameter  p ) [static]
static const awString::IString& getTypeName ( DataType  dt ) [static]
static ExternalDataAccess::DataType getTypeFromName ( const awString::IString &  tn ) [static]
bool registerAccess ( DataType  type,
ExternalData data 
)
bool deregisterAccess ( DataType  type )
bool isRegistered ( DataType  type )
bool hasUnsynchronizedData ( ) const

ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess
ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess ExternalDataAccess