MythTV: RecordingRule Class Reference

MythTV 0.26-pre

Internal representation of a recording rule, mirrors the record table. More...

#include <recordingrule.h>

List of all members.

Public Member Functions
	RecordingRule ()
	~RecordingRule ()
bool	Load (bool asTemplate=false)
bool	LoadByProgram (const ProgramInfo *proginfo)
bool	LoadBySearch (RecSearchType lsearch, QString textname, QString forwhat, QString from="")
bool	LoadTemplate (QString category, QString categoryType="Default")
bool	ModifyPowerSearchByID (int rid, QString textname, QString forwhat, QString from="")
bool	MakeOverride (void)
bool	MakeTemplate (QString category)
bool	Save (bool sendSig=true)
bool	Delete (bool sendSig=true)
bool	IsLoaded () const
void	UseTempTable (bool usetemp, QString table="record_tmp")
void	ToMap (InfoMap &infoMap) const
AutoExpireType	GetAutoExpire (void) const
Static Public Member Functions
static unsigned	GetDefaultFilter (void)
static QString	SearchTypeToString (const RecSearchType searchType)
static QStringList	GetTemplateNames (void)
Public Attributes
int	m_recordID
int	m_parentRecID
	Unique Recording Rule ID.
bool	m_isInactive
QString	m_title
	Recording rule is enabled?
QString	m_subtitle
QString	m_description
uint	m_season
uint	m_episode
QString	m_category
QTime	m_starttime
QDate	m_startdate
QTime	m_endtime
QDate	m_enddate
QString	m_seriesid
QString	m_programid
QString	m_inetref
int	m_channelid
QString	m_station
int	m_findday
	callsign?
QTime	m_findtime
	Day of the week for once per week etc.
int	m_findid
	Time for timeslot rules.
RecordingType	m_type
RecSearchType	m_searchType
int	m_recPriority
int	m_prefInput
int	m_startOffset
int	m_endOffset
RecordingDupMethodType	m_dupMethod
RecordingDupInType	m_dupIn
unsigned	m_filter
QString	m_recProfile
QString	m_recGroup
QString	m_storageGroup
QString	m_playGroup
bool	m_autoExpire
int	m_maxEpisodes
bool	m_maxNewest
bool	m_autoCommFlag
bool	m_autoTranscode
int	m_transcoder
bool	m_autoUserJob1
bool	m_autoUserJob2
bool	m_autoUserJob3
bool	m_autoUserJob4
bool	m_autoMetadataLookup
QDateTime	m_nextRecording
QDateTime	m_lastRecorded
QDateTime	m_lastDeleted
int	m_averageDelay
QString	m_recordTable
int	m_tempID
bool	m_isOverride
bool	m_isTemplate
Static Public Attributes
static const int	kNumFilters = 12
Private Member Functions
void	AssignProgramInfo ()
Private Attributes
QString	m_template
const ProgramInfo *	m_progInfo
bool	m_loaded

Detailed Description

Internal representation of a recording rule, mirrors the record table.

Please keep clean and tidy, don't let this class become a dumping ground for single use utility functions, UI related stuff or anything which has a tenuous link to recording rules. See RecordingInfo or ProgramInfo instead.

Definition at line 30 of file recordingrule.h.

Constructor & Destructor Documentation

RecordingRule::RecordingRule ( )

Definition at line 26 of file recordingrule.cpp.

RecordingRule::~RecordingRule ( ) [inline]

Definition at line 37 of file recordingrule.h.

Member Function Documentation

bool RecordingRule::Load ( bool asTemplate = false )

Definition at line 80 of file recordingrule.cpp.

Referenced by LookerUpper::CopyRuleInetrefsToRecordings(), ScheduleEditor::Create(), Dvr::DisableRecordSchedule(), Dvr::EnableRecordSchedule(), Dvr::GetRecordSchedule(), GuessLookupType(), MainServer::HandleGetPendingRecordings(), LoadByProgram(), LoadBySearch(), LoadTemplate(), ModifyPowerSearchByID(), ProgramRecPriority::remove(), and ProgramRecPriority::scheduleChanged().

bool RecordingRule::LoadByProgram ( const ProgramInfo * proginfo )

Definition at line 196 of file recordingrule.cpp.

Referenced by ScheduleEditor::Create(), LookerUpper::customEvent(), ViewScheduled::deleteRule(), GuideGrid::deleteRule(), ProgramRecPriority::edit(), RecordingInfo::GetAutoRunJobs(), RecordingInfo::GetProgramRecordingProfile(), RecordingInfo::GetProgramRecordingStatus(), ProgDetails::loadPage(), ScheduleCommon::MakeOverride(), ScheduleEditor::RunScheduleEditor(), ProgLister::ShowDeleteRuleMenu(), and RecordingInfo::StartedRecording().

bool RecordingRule::LoadBySearch	(	RecSearchType	lsearch,
		QString	textname,
		QString	forwhat,
		QString	from = `""`
	)

Definition at line 221 of file recordingrule.cpp.

Referenced by CustomEdit::recordClicked(), PhrasePopup::recordClicked(), and PowerSearchPopup::recordClicked().

bool RecordingRule::LoadTemplate	(	QString	category,
		QString	categoryType = `"Default"`
	)

Definition at line 271 of file recordingrule.cpp.

Referenced by TV::InitFromDB(), LoadByProgram(), LoadBySearch(), ScheduleEditor::LoadTemplate(), MakeTemplate(), and PlaybackBox::setRecGroup().

bool RecordingRule::ModifyPowerSearchByID	(	int	rid,
		QString	textname,
		QString	forwhat,
		QString	from = `""`
	)

Definition at line 331 of file recordingrule.cpp.

Referenced by CustomEdit::recordClicked().

bool RecordingRule::MakeOverride ( void )

Definition at line 351 of file recordingrule.cpp.

Referenced by RecordingInfo::ApplyRecordStateChange(), and ScheduleCommon::MakeOverride().

bool RecordingRule::MakeTemplate ( QString category )

Definition at line 306 of file recordingrule.cpp.

Referenced by doUpgradeTVDatabaseSchema(), and ProgramRecPriority::newTemplate().

bool RecordingRule::Save ( bool sendSig = true )

Definition at line 373 of file recordingrule.cpp.

Referenced by Dvr::AddRecordSchedule(), RecordingInfo::ApplyRecordRecPriorityChange(), RecordingInfo::ApplyRecordStateChange(), LookerUpper::customEvent(), Dvr::DisableRecordSchedule(), doUpgradeTVDatabaseSchema(), Dvr::EnableRecordSchedule(), TVRec::NotifySchedulerOfRecording(), ScheduleEditor::Save(), and UseTempTable().

bool RecordingRule::Delete ( bool sendSig = true )

Definition at line 479 of file recordingrule.cpp.

Referenced by RecordingInfo::ApplyRecordStateChange(), ViewScheduled::customEvent(), ProgLister::customEvent(), ProgramRecPriority::customEvent(), GuideGrid::customEvent(), ScheduleEditor::DeleteRule(), and Dvr::RemoveRecordSchedule().

bool RecordingRule::IsLoaded ( ) const [inline]

Definition at line 53 of file recordingrule.h.

Referenced by ScheduleEditor::Create(), Dvr::DisableRecordSchedule(), and Dvr::EnableRecordSchedule().

void RecordingRule::UseTempTable	(	bool	usetemp,
		QString	table = `"record_tmp"`
	)

Definition at line 610 of file recordingrule.cpp.

Referenced by ScheduleEditor::ShowPreview().

unsigned RecordingRule::GetDefaultFilter ( void ) [static]

Definition at line 717 of file recordingrule.cpp.

void RecordingRule::ToMap ( InfoMap & infoMap ) const

Definition at line 513 of file recordingrule.cpp.

Referenced by ScheduleEditor::Load(), and SchedEditChild::SetTextFromMaps().

AutoExpireType RecordingRule::GetAutoExpire ( void ) const [inline]

Definition at line 59 of file recordingrule.h.

Referenced by TVRec::TuningRestartRecorder().

QString RecordingRule::SearchTypeToString ( const RecSearchType searchType ) [static]

Definition at line 736 of file recordingrule.cpp.

Referenced by LoadBySearch(), and ToMap().

QStringList RecordingRule::GetTemplateNames ( void ) [static]

Definition at line 765 of file recordingrule.cpp.

Referenced by ScheduleEditor::showTemplateMenu().

void RecordingRule::AssignProgramInfo ( ) [private]

Definition at line 670 of file recordingrule.cpp.

Referenced by LoadByProgram(), and MakeOverride().

Member Data Documentation

const int RecordingRule::kNumFilters = 12 [static]

Definition at line 34 of file recordingrule.h.

Referenced by GetDefaultFilter(), and Scheduler::UpdateMatches().

int RecordingRule::m_recordID

int RecordingRule::m_parentRecID

Unique Recording Rule ID.

Definition at line 66 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), MakeOverride(), and Save().

bool RecordingRule::m_isInactive

Definition at line 68 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), Dvr::DisableRecordSchedule(), Dvr::EnableRecordSchedule(), FillRecRuleInfo(), SchedOptMixin::Load(), Load(), MakeOverride(), SchedOptMixin::Save(), Save(), and ProgramRecPriority::scheduleChanged().

QString RecordingRule::m_subtitle

Definition at line 72 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), MetadataOptions::FindNetArt(), GuessLookupType(), Load(), LoadBySearch(), MetadataFactory::Lookup(), ModifyPowerSearchByID(), MetadataOptions::OnImageSearchListSelection(), MetadataOptions::PerformQuery(), Save(), and ToMap().

QString RecordingRule::m_description

Definition at line 73 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), LoadBySearch(), ProgDetails::loadPage(), ModifyPowerSearchByID(), Save(), and ToMap().

uint RecordingRule::m_season

Definition at line 74 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), AssignProgramInfo(), MetadataOptions::Create(), LookerUpper::customEvent(), FillRecRuleInfo(), GuessLookupType(), Load(), MetadataFactory::Lookup(), MetadataOptions::MetadataOptions(), Save(), MetadataOptions::Save(), and ToMap().

uint RecordingRule::m_episode

Definition at line 75 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), AssignProgramInfo(), MetadataOptions::Create(), LookerUpper::customEvent(), FillRecRuleInfo(), GuessLookupType(), Load(), MetadataFactory::Lookup(), Save(), MetadataOptions::Save(), and ToMap().

QString RecordingRule::m_category

Definition at line 76 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), ScheduleEditor::Load(), MakeTemplate(), Save(), ProgramRecPriority::scheduleChanged(), and ToMap().

QTime RecordingRule::m_starttime

Definition at line 78 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), Save(), and ToMap().

QDate RecordingRule::m_startdate

Definition at line 79 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), LoadBySearch(), Save(), and ToMap().

QTime RecordingRule::m_endtime

Definition at line 80 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), Save(), and ToMap().

QDate RecordingRule::m_enddate

Definition at line 81 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), Save(), and ToMap().

QString RecordingRule::m_seriesid

Definition at line 83 of file recordingrule.h.

Referenced by AssignProgramInfo(), MetadataOptions::customEvent(), FillRecRuleInfo(), Load(), Save(), and ScheduleEditor::showUpcomingByTitle().

QString RecordingRule::m_programid

Definition at line 84 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), and Save().

QString RecordingRule::m_inetref

Definition at line 85 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), AssignProgramInfo(), LookerUpper::CopyRuleInetrefsToRecordings(), MetadataOptions::Create(), LookerUpper::customEvent(), FillRecRuleInfo(), Load(), MetadataFactory::Lookup(), MetadataOptions::MetadataOptions(), Save(), MetadataOptions::Save(), and ToMap().

int RecordingRule::m_channelid

Definition at line 88 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), Save(), and ToMap().

QString RecordingRule::m_station

Definition at line 89 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), ScheduleEditor::Load(), Save(), and ToMap().

int RecordingRule::m_findday

callsign?

Definition at line 90 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), LoadBySearch(), Save(), and ToMap().

QTime RecordingRule::m_findtime

Day of the week for once per week etc.

Definition at line 91 of file recordingrule.h.

Referenced by AssignProgramInfo(), FillRecRuleInfo(), Load(), Save(), and ToMap().

int RecordingRule::m_findid

Time for timeslot rules.

Definition at line 92 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), AssignProgramInfo(), FillRecRuleInfo(), Load(), LoadBySearch(), and Save().

RecordingType RecordingRule::m_type

Definition at line 95 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), RecordingInfo::ApplyRecordStateChange(), doUpgradeTVDatabaseSchema(), FillRecRuleInfo(), RecordingInfo::GetProgramRecordingStatus(), Load(), ScheduleEditor::Load(), LoadByProgram(), ScheduleCommon::MakeOverride(), MakeOverride(), MakeTemplate(), TVRec::NotifySchedulerOfRecording(), SchedOptMixin::RuleChanged(), StoreOptMixin::RuleChanged(), PostProcMixin::RuleChanged(), ScheduleEditor::RuleChanged(), Save(), ScheduleEditor::Save(), ProgramRecPriority::scheduleChanged(), ScheduleEditor::ShowFilters(), ScheduleEditor::ShowMetadataOptions(), ScheduleEditor::ShowNextView(), ScheduleEditor::ShowPostProc(), ScheduleEditor::ShowPreview(), ScheduleEditor::showPrevious(), ScheduleEditor::ShowPreviousView(), ScheduleEditor::ShowSchedInfo(), ScheduleEditor::ShowSchedOpt(), ScheduleEditor::ShowStoreOpt(), ScheduleEditor::showUpcomingByRule(), ScheduleEditor::showUpcomingByTitle(), and ToMap().

RecSearchType RecordingRule::m_searchType

Definition at line 96 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), LookerUpper::customEvent(), ProgramRecPriority::edit(), FillRecRuleInfo(), MainServer::HandleGetPendingRecordings(), Load(), ScheduleEditor::Load(), LoadByProgram(), LoadBySearch(), ProgDetails::loadPage(), MakeOverride(), ModifyPowerSearchByID(), Save(), ScheduleEditor::showUpcomingByTitle(), and ToMap().

int RecordingRule::m_recPriority

Definition at line 97 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), RecordingInfo::ApplyRecordRecPriorityChange(), FillRecRuleInfo(), RecordingInfo::InsertProgram(), Load(), SchedOptMixin::Load(), SchedOptMixin::Save(), Save(), and ProgramRecPriority::scheduleChanged().

int RecordingRule::m_prefInput

Definition at line 98 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), SchedOptMixin::Load(), SchedOptMixin::Save(), and Save().

int RecordingRule::m_startOffset

Definition at line 99 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), SchedOptMixin::Load(), SchedOptMixin::Save(), and Save().

int RecordingRule::m_endOffset

Definition at line 100 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), SchedOptMixin::Load(), TVRec::NotifySchedulerOfRecording(), SchedOptMixin::Save(), and Save().

RecordingDupMethodType RecordingRule::m_dupMethod

Definition at line 101 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), SchedOptMixin::DupMethodChanged(), FillRecRuleInfo(), Load(), SchedOptMixin::Load(), SchedOptMixin::RuleChanged(), SchedOptMixin::Save(), and Save().

RecordingDupInType RecordingRule::m_dupIn

Definition at line 102 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), SchedOptMixin::Load(), SchedOptMixin::Save(), and Save().

unsigned RecordingRule::m_filter

Definition at line 103 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), SchedFilterEditor::Load(), Save(), and SchedFilterEditor::Save().

QString RecordingRule::m_recProfile

Definition at line 107 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetProgramRecordingProfile(), RecordingInfo::InsertProgram(), Load(), StoreOptMixin::Load(), load_profile(), ProgDetails::loadPage(), Save(), StoreOptMixin::Save(), and ProgramRecPriority::scheduleChanged().

QString RecordingRule::m_recGroup

Definition at line 108 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), StoreOptMixin::Load(), Save(), StoreOptMixin::Save(), and TVRec::TuningRestartRecorder().

QString RecordingRule::m_storageGroup

Definition at line 109 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), StoreOptMixin::Load(), Save(), and StoreOptMixin::Save().

QString RecordingRule::m_playGroup

Definition at line 110 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), StoreOptMixin::Load(), LoadByProgram(), Save(), and StoreOptMixin::Save().

bool RecordingRule::m_autoExpire

Definition at line 112 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), TV::InitFromDB(), RecordingInfo::InsertProgram(), Load(), StoreOptMixin::Load(), Save(), StoreOptMixin::Save(), and PlaybackBox::setRecGroup().

int RecordingRule::m_maxEpisodes

Definition at line 113 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), StoreOptMixin::Load(), StoreOptMixin::MaxEpisodesChanged(), StoreOptMixin::RuleChanged(), Save(), and StoreOptMixin::Save().

bool RecordingRule::m_maxNewest

Definition at line 114 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), Load(), StoreOptMixin::Load(), Save(), and StoreOptMixin::Save().

bool RecordingRule::m_autoCommFlag

Definition at line 117 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoTranscode

Definition at line 118 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), PostProcMixin::RuleChanged(), Save(), PostProcMixin::Save(), and PostProcMixin::TranscodeChanged().

int RecordingRule::m_transcoder

Definition at line 119 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::InsertProgram(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoUserJob1

Definition at line 120 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoUserJob2

Definition at line 121 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoUserJob3

Definition at line 122 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoUserJob4

Definition at line 123 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

bool RecordingRule::m_autoMetadataLookup

Definition at line 124 of file recordingrule.h.

Referenced by Dvr::AddRecordSchedule(), FillRecRuleInfo(), RecordingInfo::GetAutoRunJobs(), Load(), PostProcMixin::Load(), Save(), and PostProcMixin::Save().

QDateTime RecordingRule::m_nextRecording

Definition at line 128 of file recordingrule.h.

Referenced by FillRecRuleInfo(), Load(), Save(), and ToMap().

QDateTime RecordingRule::m_lastRecorded

Definition at line 129 of file recordingrule.h.

Referenced by FillRecRuleInfo(), Load(), Save(), ProgramRecPriority::scheduleChanged(), and ToMap().

QDateTime RecordingRule::m_lastDeleted

Definition at line 130 of file recordingrule.h.

Referenced by FillRecRuleInfo(), Load(), Save(), and ToMap().

int RecordingRule::m_averageDelay

Definition at line 131 of file recordingrule.h.

Referenced by FillRecRuleInfo(), Load(), and Save().

QString RecordingRule::m_recordTable

Definition at line 134 of file recordingrule.h.

Referenced by Save(), and UseTempTable().

int RecordingRule::m_tempID

Definition at line 135 of file recordingrule.h.

Referenced by Save(), ScheduleEditor::ShowPreview(), and UseTempTable().

bool RecordingRule::m_isOverride

Definition at line 139 of file recordingrule.h.

Referenced by Load(), ScheduleEditor::Load(), and MakeOverride().

bool RecordingRule::m_isTemplate

Definition at line 143 of file recordingrule.h.

Referenced by ScheduleEditor::Create(), SchedOptEditor::Create(), SchedFilterEditor::Create(), StoreOptEditor::Create(), PostProcEditor::Create(), MetadataOptions::Create(), Load(), ScheduleEditor::Load(), MakeTemplate(), ScheduleEditor::showMenu(), ScheduleEditor::ShowNextView(), and ScheduleEditor::ShowPreviousView().

QString RecordingRule::m_template [private]

Definition at line 150 of file recordingrule.h.

Referenced by Load(), and ToMap().

const ProgramInfo* RecordingRule::m_progInfo [private]

Definition at line 154 of file recordingrule.h.

Referenced by AssignProgramInfo(), and LoadByProgram().

bool RecordingRule::m_loaded [private]

Definition at line 158 of file recordingrule.h.

Referenced by Load(), LoadByProgram(), LoadBySearch(), MakeTemplate(), and ModifyPowerSearchByID().

The documentation for this class was generated from the following files:

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends