mx::IHttpLookupTable Class Reference
[Component Interfaces]

#include <IHttpLookupTable.h>

Inheritance diagram for mx::IHttpLookupTable:

mx::IInterface List of all members.

Public Types

enum  EHttpLookupTableId {
  ID_NOID = 0, ID_PROP_LIST_ALL = 101, ID_PROP_LIST_UPDATE = 102, ID_PROP_MANUFAKTUR = 103,
  ID_PROP_MODEL = 104, ID_PROP_SOFT_VER = 105, ID_PROP_RESO_VAL_RANGE = 106, ID_PROP_PTZ = 107,
  ID_PROP_PTZ_SOFT = 108, ID_RINFO_BASIC = 150, ID_VIDEO_MJPEG = 201, ID_BRIGHTNESS = 301,
  ID_SHARPNESS = 302, ID_RESOLUTION = 303, ID_SATURATION = 304, ID_BACKLIGHT = 305,
  ID_CONTRAST = 306, ID_FRAMES = 307, ID_JPEGQ = 308, ID_NOISE = 309,
  ID_AUTO_CONTRAST = 310, ID_WHITE_BALANCE = 311, ID_NIGHT_IMPROV = 312, ID_F_STOP = 313,
  ID_EXPOSURE_MIN = 315, ID_EXPOSURE_MAX = 316, ID_REDUCED_MODE = 317, ID_IMAGE_SETTINGS_ALL = 318,
  ID_BESTIMAGERESET = 320, ID_RESOLUTION_VAL_RANGE = 323, ID_IMAGESETTINGS_LIST_ALL = 324, ID_IMAGESETTINGS_UPDATE = 325,
  ID_STREAMCODEX = 326, ID_CAM_EYE_MODE = 327, ID_REC_SWITCH = 401, ID_REC_LIST_ALL = 408,
  ID_REC_UPDATE = 409, ID_REC_TIMETABLE = 410, ID_REC_FREEZE_ACTIVE = 411, ID_REC_FREEZE_ALERTMASK = 412,
  ID_REC_FREEZE_DELAY = 413, ID_REC_RECORDING_MODE = 414, ID_REC_STORYPACKING = 415, ID_REC_STREAM_FRAMERATE = 416,
  ID_REC_STREAM_AUDIO = 417, ID_REC_START_MASK = 418, ID_REC_STORY_INTERVAL = 419, ID_REC_ANTE_COUNT = 420,
  ID_REC_POST_COUNT = 421, ID_REC_STREAM_EVENT_FPS_100 = 422, ID_REC_STREAM_ANTE_TIME = 423, ID_REC_STREAM_TIME = 424,
  ID_REC_STRETCH_MASK = 425, ID_REC_STOP_MASK = 426, ID_REC_STORY_STOP_COUNT = 427, ID_REC_STREAM_STOP_TIME = 428,
  ID_REC_STOP_DEAD_TIME = 429, ID_REC_HISTORY_SEC = 430, ID_REC_HISTORY_IMG_PROF = 431, ID_FSERVER_LIST_ALL = 450,
  ID_FSERVER_UPDATE = 451, ID_FSERVER_TYPE = 452, ID_FSERVER_REC_SERVER = 453, ID_FSERVER_REC_PATH = 454,
  ID_FSERVER_WIN_USERNAME = 457, ID_FSERVER_WIN_PASSWD = 458, ID_FSERVER_REC_SIZE = 459, ID_FSERVER_REC_AGE = 460,
  ID_FSERVER_REC_COUNT = 461, ID_FSEVER_UID = 462, ID_FSEVER_GID = 463, ID_FSERVER_PLEX_FS = 464,
  ID_FSEVER_LOGMODE = 465, ID_FSERVER_COPY_LOGFILES = 466, ID_EVENT_LIST_ALL = 700, ID_EVENT_UPDATE = 701,
  ID_VM_ON_OFF = 702, ID_VM_WINDOW_DEF = 703, ID_VM_WINDOW_ID = 704, ID_VM_WINDOW_TYPE = 705,
  ID_VM_NIGHT_MODE = 706, ID_VM2_ON_OFF = 711, ID_VM2_WINDOW_DEF = 712, ID_VM2_WINDOW_ID = 713,
  ID_VM2_WINDOW_TYPE = 714, ID_VM2_NIGHT_MODE = 715, ID_ES_MICRO_CHECK = 716, ID_ES_SIGNAL_IMPUT_CHECK = 717,
  ID_ES_SIGNAL_IMPUT2_CHECK = 718, ID_ES_SIGNAL_IMPUT3_CHECK = 719, ID_ES_SIGNAL_IMPUT4_CHECK = 720, ID_ES_PERIODIC_EVENT_CHECK = 721,
  ID_ES_TIME_TASK_CHECK = 722, ID_ES_USER_CLICK = 723, ID_ES_REC_BEGIN_CHECK = 724, ID_ES_REC_END_CHECK = 725,
  ID_ES_REC_HISTORY_CHECK = 726, ID_ES_REC_TERMINATE_CHECK = 727, ID_ES_BUTTONS_CHECK = 728, ID_ES_IP_RECEIVE_CHECK = 729,
  ID_ES_TEMPERATURE_CHECK = 730, ID_ES_ILLUMINATION_CHECK = 731, ID_ES_RANDOM_EVENT_CHECK = 732, ID_ES_EVENT_COUNTER_CHECK = 733,
  ID_ES_EVENT_LOGIC_CHECK = 734, ID_ES_EVENT_LOGIC2_CHECK = 735, ID_ES_PASSIV_INFRARED_CHECK = 736, ID_ES_COM_IN_CHECK = 737,
  ID_ES_REMOTE_CONTROL_CHECK = 738, ID_ARMING_MODE = 801, ID_PTZ_EYE = 903, ID_JPG_SZ_X = 904,
  ID_JPG_SZ_Y = 905, ID_WIDTH_RATIO_X = 906, ID_WIDTH_RATIO_Y = 907, ID_CENTER_X = 908,
  ID_CENTER_Y = 909, ID_RC_REBOOT = 1001, ID_RC_STORE_CONFIG = 1002, ID_ACTION_LIST_ALL = 1100,
  ID_ACTION_UPDATE = 1101, ID_AC_VISUAL_ALARM = 1102, ID_EXPOSURECONTROL_LIST_ALL = 1200, ID_EXPOSURECONTROL_UPDATE = 1201
}

Public Member Functions

virtual mxmString cameraModelRequestString ()=0
virtual mxmString parseBufferForModel (const mxmString &buffer)=0
virtual bool isSupported (enum EHttpLookupTableId id)=0
virtual mxm::smart< mxmStringListimageSettingsRequestString ()=0
virtual mxm::smart< mxmStringListrecordingSettingsRequestString ()=0
virtual mxm::smart< mxmStringListtimetableSettingsRequestString ()=0
virtual mxm::smart< mxmStringListvmSettingsRequestString ()=0
virtual EErrorCode parseImageSettings (const mxmString &buffer)=0
virtual EErrorCode parseRecordingSettings (const mxmString &buffer)=0
virtual EErrorCode parseTimetableSettings (const mxmString &buffer)=0
virtual EErrorCode parseVmSettings (const mxmString &buffer)=0
virtual mxmString idValue (enum EHttpLookupTableId id)=0
virtual EErrorCode setIdValue (enum EHttpLookupTableId id, const mxmString &value)=0
virtual mxm::smart< mxmStringListallSettingsUpdateString (bool bStorePermanent=false)=0
virtual mxm::smart< mxmStringListvalueRange (enum EHttpLookupTableId id)=0
virtual float valueIntervalStepSize (enum EHttpLookupTableId id)=0
virtual mxmString rebootRequestString ()=0
virtual mxmString storeRequestString ()=0
virtual mxmString getModelName ()=0
 Fetch camera model name.
virtual bool needReboot ()=0
virtual void reset ()=0
virtual void setEye (mx::ECamEye eye)=0
 Set lookup table eye state!
virtual mx::ECamEye eye ()=0

Detailed Description

Via this interface calling contexts can get strings, it can send to the camera to request the actual settings or set them in the camera. The called context can parse the buffers returned by the camera and hold the settings in an internal state. This state is polled by the calling context afterwards. If the calling context wants to set the settings on the camera, it sets the indiviual attributes via setIdValue. These attributes are stored in an internal state in the called context until allSettingsUpdateString is called. After this call the internal state is reset.


Member Enumeration Documentation

enum mx::IHttpLookupTable::EHttpLookupTableId
 

Enumerator:
ID_NOID  No valid ID.
ID_PROP_MANUFAKTUR  Identifies HTTP-String used for requesting the camera manufacturer.
ID_PROP_MODEL  Identifies HTTP-String used for requesting the camera model.
ID_PROP_RESO_VAL_RANGE  Identifies HTTP-String used for requesting the resolution value range.
ID_PROP_PTZ  Token for finding hardware PTZ property!
ID_PROP_PTZ_SOFT  Token for finding software PTZ property!
ID_RINFO_BASIC  Mobo specific Http-String for fetching general information about a cam.
ID_VIDEO_MJPEG  Identifies HTTP-String used for requesting a mjpeg stream.
ID_BRIGHTNESS  Connected to a atomic HTTP-String bonded to brightness.
ID_SHARPNESS  Connected to a atomic HTTP-String bonded to sharpness.
ID_RESOLUTION  Connected to a atomic HTTP-String bonded to resolution.
ID_SATURATION  Connected to a atomic HTTP-String bonded to saturation.
ID_BACKLIGHT  Connected to a atomic HTTP-String bonded to backlight.
ID_CONTRAST  Connected to a atomic HTTP-String bonded to contrast.
ID_FRAMES  Connected to a atomic HTTP-String bonded to frames.
ID_JPEGQ  Connected to a atomic HTTP-String bonded to jpeg quality.
ID_NOISE  Connected to a atomic HTTP-String bonded to noise reduction.
ID_AUTO_CONTRAST  Connected to a atomic HTTP-String bonded to auto contrast.
ID_WHITE_BALANCE  Connected to a atomic HTTP-String bonded to white balance.
ID_NIGHT_IMPROV  Connected to a atomic HTTP-String bonded to night improvement.
ID_F_STOP  Connected to a atomic HTTP-String bonded to exposure F-Stop.
ID_EXPOSURE_MIN  Connected to a atomic HTTP-String bonded to exposure time min.
ID_EXPOSURE_MAX  Connected to a atomic HTTP-String bonded to exposure time max.
ID_REDUCED_MODE  Connected to a atomic HTTP-String bonded to reduced mode.
ID_IMAGE_SETTINGS_ALL  Identifies a HTTP-String consisting of all available image settings.
ID_BESTIMAGERESET  Identifies a special section of control/control named bestimagereset.
ID_RESOLUTION_VAL_RANGE  Identifies HTTP-String used for requesting the resolution value range.
ID_REC_SWITCH  Arm Recording": "Enable", "Off", "SI Open (high)", "SI Closed (low)".
ID_REC_LIST_ALL  Http-Request string for listing the recording config section.
ID_REC_UPDATE  Contains the section for updating.
ID_REC_TIMETABLE  The current timetable (can be empty!) e.g. Weekdays_Mo-Fr.
ID_REC_FREEZE_ACTIVE  Terminate Recording (TR).
ID_REC_FREEZE_ALERTMASK  Termination Condition -Select the events which will terminate recording.
ID_REC_FREEZE_DELAY  Time Before Terminate.
ID_REC_RECORDING_MODE  Recording Mode": "Snap Shot Recording", "Event Recording", "Continuous Recording".
ID_REC_STORYPACKING  Pack Event Story.
ID_REC_STREAM_FRAMERATE  Continuous Recording Frame Rate.
ID_REC_STREAM_AUDIO  Record Audio Data.
ID_REC_START_MASK  Start Recording.
ID_REC_STORY_INTERVAL  Recording interval for story images in milliseconds [0..600000 ms].
ID_REC_ANTE_COUNT  Pre-alarm images for event story.
ID_REC_POST_COUNT  Post-alarm images for event story.
ID_REC_STREAM_EVENT_FPS_100  Recording speed if an event is detected, in frames per second.
ID_REC_STREAM_ANTE_TIME  Additional recording time before an event stream.
ID_REC_STREAM_TIME  Recording Time": "2 s", "4 s", "6 s", ..., 10 min.
ID_REC_STRETCH_MASK  Retrigger Recording.
ID_REC_STOP_MASK  Stop Recording.
ID_REC_STORY_STOP_COUNT  Images to include in recorded snap shots after Stop Recording event has occurred.
ID_REC_STREAM_STOP_TIME  Time to include in recorded stream after Stop Recording event has occurred. "2 s", "4 s", "6 s", ..., 10 min.
ID_REC_STOP_DEAD_TIME  Recording Dead Time.
ID_REC_HISTORY_SEC  History Recording (HR).
ID_REC_HISTORY_IMG_PROF  Image Profile for History": "Live Image", "MEGA", "VGA", "CIF".
ID_FSERVER_LIST_ALL  List fileserversettings.
ID_FSERVER_UPDATE  Requestring for setting FS valus on a cam.
ID_FSERVER_TYPE  Recording Target: None, SMB, NFS, CIFS.
ID_FSERVER_REC_SERVER  Server IP.
ID_FSERVER_REC_PATH  Remote Directory.
ID_FSERVER_WIN_USERNAME  The username!
ID_FSERVER_WIN_PASSWD  The passwd!
ID_FSERVER_REC_SIZE  Max size in MB.
ID_FSERVER_REC_AGE  Max age of sequence in dayes.
ID_FSERVER_REC_COUNT  NbOf Sequences.
ID_FSEVER_UID  User ID for NFS-Server (default:0).
ID_FSEVER_GID  Group ID for NFS-Server (default:65534).
ID_FSERVER_PLEX_FS  Internal Storage Filesystem".
ID_FSEVER_LOGMODE  Event Storage Logfile": "off", "on".
ID_FSERVER_COPY_LOGFILES  Copy Camera Logfiles": "off", "on".
ID_EVENT_LIST_ALL  List parameters in the even section.
ID_EVENT_UPDATE  Update parameters request string.
ID_VM_ON_OFF  Video Motion Enable. Can be found in the event section.
ID_VM_WINDOW_DEF  Video Motion Definitions (VM).
ID_VM_WINDOW_ID  Show Video Motion Window ID.
ID_VM_WINDOW_TYPE  Appearance of motion window border.
ID_VM_NIGHT_MODE  Dark Video Motion Suppress.
ID_VM2_ON_OFF  Video Motion Enable.
ID_VM2_WINDOW_DEF  Video Motion Definitions (VM).
ID_VM2_WINDOW_ID  Show Video Motion Window ID.
ID_VM2_WINDOW_TYPE  Appearance of motion window border.
ID_VM2_NIGHT_MODE  Dark Video Motion Suppress.
ID_ES_MICRO_CHECK  "Microphone (MI)"
ID_ES_SIGNAL_IMPUT_CHECK  Signal Input (SI).
ID_ES_SIGNAL_IMPUT2_CHECK  Signal Input (SI2).
ID_ES_SIGNAL_IMPUT3_CHECK  Signal Input (SI3).
ID_ES_SIGNAL_IMPUT4_CHECK  Signal Input (SI4).
ID_ES_PERIODIC_EVENT_CHECK  "Periodic Event (PE)"
ID_ES_TIME_TASK_CHECK  "Time Task (TT)"
ID_ES_USER_CLICK  "User Click (UC)"
ID_ES_REC_BEGIN_CHECK  "Recording Begin (RB)"
ID_ES_REC_END_CHECK  "Recording End (RE)"
ID_ES_REC_HISTORY_CHECK  "Recording History (RH)"
ID_ES_REC_TERMINATE_CHECK  "Recording Terminate (RT)"
ID_ES_BUTTONS_CHECK  "Buttons (BT)"
ID_ES_IP_RECEIVE_CHECK  "IP Receive (RC)"
ID_ES_TEMPERATURE_CHECK  "Temperature (TP)"
ID_ES_ILLUMINATION_CHECK  "Illumination (IL)"
ID_ES_RANDOM_EVENT_CHECK  "Random Event (RD)"
ID_ES_EVENT_COUNTER_CHECK  "Event Counter (EC)"
ID_ES_EVENT_LOGIC_CHECK  "Event Logic (EL)"
ID_ES_EVENT_LOGIC2_CHECK  "Event Logic (EL2)"
ID_ES_PASSIV_INFRARED_CHECK  "Passiv Infrared (PI)"
ID_ES_COM_IN_CHECK  "COM in (CI)"
ID_ES_REMOTE_CONTROL_CHECK  "IR remote control (IR)"
ID_ARMING_MODE  Activate arming mode. Can be found in the event section.
ID_RC_REBOOT  Reboot the camera.
ID_RC_STORE_CONFIG  Store config in camera.
ID_ACTION_LIST_ALL  HTTP-Requeststring for control action sections.
ID_ACTION_UPDATE  Action update.
ID_AC_VISUAL_ALARM  enable/disable visual alarm switch
ID_EXPOSURECONTROL_LIST_ALL  Fetch the camera section which contains exposure informations.
ID_EXPOSURECONTROL_UPDATE  Update the camera section which contains exposure informations.


Member Function Documentation

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::allSettingsUpdateString bool  bStorePermanent = false  )  [pure virtual]
 

get one or more strings which sets all settings of all sections, which are set in the internal state. If more than one string is returned, they all must be sent to the camera

virtual mxmString mx::IHttpLookupTable::cameraModelRequestString  )  [pure virtual]
 

get a string which request the camera model when sent to the camera

virtual mxmString mx::IHttpLookupTable::idValue enum EHttpLookupTableId  id  )  [pure virtual]
 

retrieve a value from the internal state. The return value must be converted from string to the right data type by the calling context.

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::imageSettingsRequestString  )  [pure virtual]
 

get one or more strings which request image settings section of the camera. If more than one string is returned, they all must be sent to the camera

virtual bool mx::IHttpLookupTable::isSupported enum EHttpLookupTableId  id  )  [pure virtual]
 

find out if a certain attribute is supported by this camera model

virtual bool mx::IHttpLookupTable::needReboot  )  [pure virtual]
 

returns the reboot status

virtual mxmString mx::IHttpLookupTable::parseBufferForModel const mxmString buffer  )  [pure virtual]
 

parse the buffer returned by the camera and extract the model. The model is stored in the calling context. Other methods may depend on the model, so it is a good idea to retrieve the model in an early stage. If a method depends on the model and it is not stored yet, the method throws an cameraModelUnknownException exception.

virtual EErrorCode mx::IHttpLookupTable::parseImageSettings const mxmString buffer  )  [pure virtual]
 

parse the buffer returned by the imageSettingsRequestString. The result is hold in an internal state.

virtual EErrorCode mx::IHttpLookupTable::parseRecordingSettings const mxmString buffer  )  [pure virtual]
 

parse the buffer returned by the recordingSettingsRequestString. The result is hold in an internal state.

virtual EErrorCode mx::IHttpLookupTable::parseTimetableSettings const mxmString buffer  )  [pure virtual]
 

parse the buffer returned by the timetableSettingsRequestString. The result is hold in an internal state.

virtual EErrorCode mx::IHttpLookupTable::parseVmSettings const mxmString buffer  )  [pure virtual]
 

parse the buffer returned by the vmSettingsRequestString. The result is hold in an internal state.

virtual mxmString mx::IHttpLookupTable::rebootRequestString  )  [pure virtual]
 

returns the request string, which is used to reboot the camera

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::recordingSettingsRequestString  )  [pure virtual]
 

get one or more strings which request recording settings section of the camera. If more than one string is returned, they all must be sent to the camera

virtual void mx::IHttpLookupTable::reset  )  [pure virtual]
 

resets table

virtual EErrorCode mx::IHttpLookupTable::setIdValue enum EHttpLookupTableId  id,
const mxmString value
[pure virtual]
 

set a value to the internal state.

virtual mxmString mx::IHttpLookupTable::storeRequestString  )  [pure virtual]
 

returns the request string, which is used to store the data permanently in the camera

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::timetableSettingsRequestString  )  [pure virtual]
 

get one or more strings which time table image settings section of the camera. If more than one string is returned, they all must be sent to the camera

virtual float mx::IHttpLookupTable::valueIntervalStepSize enum EHttpLookupTableId  id  )  [pure virtual]
 

get the interval step size of an attribute

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::valueRange enum EHttpLookupTableId  id  )  [pure virtual]
 

get the range of an attribute

virtual mxm::smart<mxmStringList> mx::IHttpLookupTable::vmSettingsRequestString  )  [pure virtual]
 

get one or more strings which request video motion settings section of the camera. If more than one string is returned, they all must be sent to the camera


The documentation for this class was generated from the following file:
Generated on Fri Jun 29 17:21:05 2007 for MxPEG SDK by  doxygen 1.4.6