mx::ISupportsTimetableConfiguration Class Reference
[Component Interfaces]

Allows for configuring MX time tables. More...

#include <ISupportsTimeTableConfiguration.h>

Inheritance diagram for mx::ISupportsTimetableConfiguration:

mx::IInterface List of all members.

Public Member Functions

virtual EErrorCode addEntry (mxm::smart< ITimetableEntry > entry)=0
virtual EErrorCode removeEntry (mxm::smart< ITimetableEntry > entry)=0
virtual EErrorCode removeEntry (const mxmString &name)=0
virtual mxm::smart< mxmStringListlistAllEntries ()=0
virtual mxm::smart< ITimetableEntryentry (const mxmString &name)=0
virtual mxm::smart< ITimetableEntrycreateTimetableEntry ()=0
virtual void clearTimetableEntries ()=0
virtual bool isCustomDaySupported ()=0
virtual mxm::smart< ICustomDaycreateCustomDay ()=0
virtual EErrorCode addCustomDay (mxm::smart< ICustomDay > customDay)=0
virtual EErrorCode removeCustomDay (mxm::smart< ICustomDay > customDay)=0
virtual EErrorCode removeCustomDay (const mxmString &name)=0
virtual mxm::smart< mxmStringListcustomDays ()=0
virtual mxm::smart< ICustomDaycustomDay (const mxmString &name)=0
virtual void clearCustomDays ()=0

Detailed Description

Allows for configuring MX time tables.


Member Function Documentation

virtual EErrorCode mx::ISupportsTimetableConfiguration::addCustomDay mxm::smart< ICustomDay customDay  )  [pure virtual]
 

add a previously created custom day entry The unique identifier of the custom day is its name (see ICustomDay documentation). Therefore it is an error to add an entry without a name or an existing name.

virtual EErrorCode mx::ISupportsTimetableConfiguration::addEntry mxm::smart< ITimetableEntry entry  )  [pure virtual]
 

add a previously created time table entry The unique identifier of the time table is its name (see ITimetable documentation). Therefore it is an error to add an entry without a name or an existing name.

virtual void mx::ISupportsTimetableConfiguration::clearCustomDays  )  [pure virtual]
 

clear the list of custom days

virtual void mx::ISupportsTimetableConfiguration::clearTimetableEntries  )  [pure virtual]
 

clear the list of time table entries

virtual mxm::smart<ICustomDay> mx::ISupportsTimetableConfiguration::createCustomDay  )  [pure virtual]
 

create a new custom day entry

virtual mxm::smart<ITimetableEntry> mx::ISupportsTimetableConfiguration::createTimetableEntry  )  [pure virtual]
 

create a new time table entry

virtual mxm::smart<ICustomDay> mx::ISupportsTimetableConfiguration::customDay const mxmString name  )  [pure virtual]
 

retrieve a custom day entry. If the entry is not found a null pointer is returned. /param name the name of the time table entry

virtual mxm::smart<mxmStringList> mx::ISupportsTimetableConfiguration::customDays  )  [pure virtual]
 

list all known custom time entries

virtual mxm::smart<ITimetableEntry> mx::ISupportsTimetableConfiguration::entry const mxmString name  )  [pure virtual]
 

retrieve a time table entry. If the entry is not found a null pointer is returned. /param name the name of the time table entry

virtual bool mx::ISupportsTimetableConfiguration::isCustomDaySupported  )  [pure virtual]
 

returns true if the driver understands the concept of custom days.

virtual mxm::smart<mxmStringList> mx::ISupportsTimetableConfiguration::listAllEntries  )  [pure virtual]
 

list all known time table entries

virtual EErrorCode mx::ISupportsTimetableConfiguration::removeCustomDay const mxmString name  )  [pure virtual]
 

remove a custom day entry. If the entry was not found, mx::eObjectNotPresent is returned, mx::eOK otherwise. /param name the name of the ustom day entry

virtual EErrorCode mx::ISupportsTimetableConfiguration::removeCustomDay mxm::smart< ICustomDay customDay  )  [pure virtual]
 

remove a custom day entry. If the entry was not found, mx::eObjectNotPresent is returned, mx::eOK otherwise.

virtual EErrorCode mx::ISupportsTimetableConfiguration::removeEntry const mxmString name  )  [pure virtual]
 

remove a time table entry. If the entry was not found, mx::eObjectNotPresent is returned, mx::eOK otherwise. /param name the name of the time table entry

virtual EErrorCode mx::ISupportsTimetableConfiguration::removeEntry mxm::smart< ITimetableEntry entry  )  [pure virtual]
 

remove a time table entry. If the entry was not found, mx::eObjectNotPresent is returned, mx::eOK otherwise.


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