mx::ITimetableEntry Class Reference
[Component Interfaces]

Representation MX time tables. More...

#include <ITimetableEntry.h>

Inheritance diagram for mx::ITimetableEntry:

mx::IInterface List of all members.

Public Types

enum  EWeekdays {
  eMon = 1, eTue = 2, eWed = 4, eThu = 8,
  eFri = 16, eSat = 32, eSun = 64
}

Public Member Functions

virtual void setName (const mxmString &name)=0
virtual mxmString name ()=0
virtual void setActive (int index, bool bActive)=0
virtual bool active (int index)=0
virtual EErrorCode addRange (u32 uWeekdays, int iHoursFrom, int iMinutesFrom, int iHoursTo, int iMinutesTo, int &index)=0
virtual EErrorCode addRange (mxm::smart< ICustomDay > customDay, int iHoursFrom, int iMinutesFrom, int iHoursTo, int iMinutesTo, int &index)=0
virtual bool usesCustomDay (int index)=0
virtual bool range (u32 &uWeekdays, int &iHoursFrom, int &iMinutesFrom, int &iHoursTo, int &iMinutesTo, int index)=0
virtual bool range (mxm::smart< ICustomDay > &customDay, int &iHoursFrom, int &iMinutesFrom, int &iHoursTo, int &iMinutesTo, int index)=0
virtual int countRanges ()=0

Detailed Description

Representation MX time tables.


Member Function Documentation

virtual EErrorCode mx::ITimetableEntry::addRange mxm::smart< ICustomDay customDay,
int  iHoursFrom,
int  iMinutesFrom,
int  iHoursTo,
int  iMinutesTo,
int &  index
[pure virtual]
 

add a range. The customDays parameter references a custom day created earlier. The index is an unique identifier for this entry returned by the implementation. Use the index if you want to remove this entry.

virtual EErrorCode mx::ITimetableEntry::addRange u32  uWeekdays,
int  iHoursFrom,
int  iMinutesFrom,
int  iHoursTo,
int  iMinutesTo,
int &  index
[pure virtual]
 

add a range. The uWeekdays parameter is an OR'ed combination of the enum EWeekdays, where the interval iHoursFrom:iMinutesFrom to iHoursTo:iMinutesTo is valid. The index is an unique identifier for this entry returned by the implementation. Use the index if you want to remove this entry.

virtual int mx::ITimetableEntry::countRanges  )  [pure virtual]
 

return the number of ranges set in this time table entry.

virtual bool mx::ITimetableEntry::range mxm::smart< ICustomDay > &  customDay,
int &  iHoursFrom,
int &  iMinutesFrom,
int &  iHoursTo,
int &  iMinutesTo,
int  index
[pure virtual]
 

get the range index returns false if the range uses weekdays or a range with index index is not defined.

virtual bool mx::ITimetableEntry::range u32 &  uWeekdays,
int &  iHoursFrom,
int &  iMinutesFrom,
int &  iHoursTo,
int &  iMinutesTo,
int  index
[pure virtual]
 

get the range index returns false if the range uses a custom day or a range with index index is not defined.

virtual bool mx::ITimetableEntry::usesCustomDay int  index  )  [pure virtual]
 

true if the entry referenced by index uses a custom day, false otherwise. The result is undefined, if the index does not exist.


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