Represents a recording schedule. A schedule is a group of 0 or more resources associated with a set of time and/or event based schedule triggers that, when any are active, cause the scheduled action to be performed. More...

#include <IVxSchedule.h>

Public Member Functions
virtual VxResult::Value	AddScheduleTrigger (VxNewScheduleTrigger &newTrigger) const =0
	Adds a schedule trigger to this schedule. More...

virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteSchedule () const =0
	Deletes this schedule from the VideoXpert system. More...

virtual VxResult::Value	GetLinks (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources associated with this schedule. More...

virtual VxResult::Value	GetScheduleTriggers (VxCollection< IVxScheduleTrigger ** > &triggerCollection) const =0
	Gets the schedule triggers associated with this schedule. More...

virtual VxResult::Value	Link (IVxDataSource &dataSource) const =0
	Associates a data source with this schedule. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	SetAction (VxScheduleAction::Value action)=0
	Sets the action property. More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

virtual VxResult::Value	SetUseAllDataSources (bool useAllDataSources)=0
	Sets whether the schedule applies to all data sources. More...

virtual VxResult::Value	UnLink (IVxDataSource &dataSource) const =0
	Removes a data source association from this schedule. More...

Public Attributes
bool	useAllDataSources
	Indicates whether the schedule applies to all data sources. More...

char	id [64]
	The unique identifier of the schedule. More...

char	name [64]
	The friendly name of the schedule. More...

VxScheduleAction::Value	action
	The action performed when the schedule is active. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a recording schedule. A schedule is a group of 0 or more resources associated with a set of time and/or event based schedule triggers that, when any are active, cause the scheduled action to be performed.

Definition at line 14 of file IVxSchedule.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxSchedule::AddScheduleTrigger ( VxNewScheduleTrigger & newTrigger ) const

pure virtual

Adds a schedule trigger to this schedule.

Parameters

newTrigger The new schedule trigger to add.

Returns: The Result of the request.

void VxSdk::IVxSchedule::Clear ( )

inlineprotected

Clears this instance.

Definition at line 103 of file IVxSchedule.h.

                      {
             this->useAllDataSources = false;
             VxZeroArray(this->id);
             VxZeroArray(this->name);
             this->action = VxScheduleAction::kUnknown;
         }

virtual VxResult::Value VxSdk::IVxSchedule::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxSchedule::DeleteSchedule ( ) const

pure virtual

Deletes this schedule from the VideoXpert system.

Returns: The Result of deleting the situation.

virtual VxResult::Value VxSdk::IVxSchedule::GetLinks ( VxCollection< IVxDataSource ** > & dataSourceCollection ) const

pure virtual

Gets the data sources associated with this schedule.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

dataSourceCollection The data sources associated with this schedule.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSchedule::GetScheduleTriggers ( VxCollection< IVxScheduleTrigger ** > & triggerCollection ) const

pure virtual

Gets the schedule triggers associated with this schedule.

Parameters

triggerCollection A VxCollection of the associated schedule triggers.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSchedule::Link ( IVxDataSource & dataSource ) const

pure virtual

Associates a data source with this schedule.

Parameters

dataSource The data source to associate the schedule with.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxSchedule::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxSchedule::SetAction ( VxScheduleAction::Value action )

pure virtual

Sets the action property.

Parameters

action The new action value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSchedule::SetName ( char name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSchedule::SetUseAllDataSources ( bool useAllDataSources )

pure virtual

Sets whether the schedule applies to all data sources.

Parameters

useAllDataSources True to use all data sources, otherwise false.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxSchedule::UnLink ( IVxDataSource & dataSource ) const

pure virtual

Removes a data source association from this schedule.

Parameters

dataSource The data source to remove association with.

Returns: The Result of the request.

Member Data Documentation

VxScheduleAction::Value VxSdk::IVxSchedule::action

The action performed when the schedule is active.

Definition at line 97 of file IVxSchedule.h.

char VxSdk::IVxSchedule::id[64]

The unique identifier of the schedule.

Definition at line 89 of file IVxSchedule.h.

char VxSdk::IVxSchedule::name[64]

The friendly name of the schedule.

Definition at line 93 of file IVxSchedule.h.

bool VxSdk::IVxSchedule::useAllDataSources

Indicates whether the schedule applies to all data sources.

Definition at line 85 of file IVxSchedule.h.

The documentation for this struct was generated from the following file:

C:/Git/VXSDK_M3/VxSdk/Include/IVxSchedule.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation