CPPCli::Schedule Class Reference

The Schedule class 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 <Schedule.h>

Public Types
enum	Actions {   Actions::Unknown,   Actions::EventSourceRecord,   Actions::Record }
	Values that represent schedule recording actions. More...

Public Member Functions
	Schedule (VxSdk::IVxSchedule *vxSchedule)
	Constructor. More...
virtual	~Schedule ()
	Destructor. More...
	!Schedule ()
	Finaliser. More...
CPPCli::Results::Value	AddScheduleTrigger (CPPCli::NewScheduleTrigger^ newScheduleTrigger)
	Add a new schedule trigger to the schedule. More...
CPPCli::Results::Value	DeleteScheduleTrigger (CPPCli::ScheduleTrigger^ scheduleTrigger)
	Delete a schedule trigger from the schedule. This will delete the schedule trigger from any other schedules as well. More...
System::Collections::Generic::List< DataSource^ >^	GetLinks ()
	Get the data sources linked to the schedule. More...
Results::Value	Link (System::Collections::Generic::List< DataSource^ >^dataSources)
	Add data sources to the schedule. More...
Results::Value	Refresh ()
	Update this instances properties. More...
Results::Value	Unlink (System::Collections::Generic::List< DataSource^ >^dataSources)
	Delete existing data sources from the schedule. More...

Package Functions
System::Collections::Generic::List< ScheduleTrigger^ >^	_GetScheduleTriggers ()

Package Attributes
VxSdk::IVxSchedule *	_schedule

Properties
System::Collections::Generic::List< ScheduleTrigger^ >^	ScheduleTriggers [get]
	Gets the schedule triggers associated with this schedule. More...
Actions	Action [get, set]
	Gets or sets the action performed when the schedule is active. More...
System::String^	Id [get]
	Gets the unique identifier of the schedule. More...
System::String^	Name [get, set]
	Gets or sets the friendly name of the schedule. More...
bool	UseAllDataSources [get, set]
	Gets or sets a value indicating whether the schedule applies to all data sources. More...

Detailed Description

The Schedule class 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 17 of file Schedule.h.

Member Enumeration Documentation

enum CPPCli::Schedule::Actions

strong

Values that represent schedule recording actions.

Enumerator
Unknown	An error or unknown value was returned.
EventSourceRecord	Record only the resource (associated with the Schedule) that was the source of the event causing the schedule trigger to activate.
Record	Record all resources associated with the schedule.

Definition at line 23 of file Schedule.h.

                           {
            Unknown,

            EventSourceRecord,

            Record
        };

Constructor & Destructor Documentation

CPPCli::Schedule::Schedule

(

VxSdk::IVxSchedule *

vxSchedule

)

Constructor.

Parameters

vxSchedule

The vx schedule.

Definition at line 8 of file Schedule.cpp.

                                                     {
    _schedule = vxSchedule;
}

virtual CPPCli::Schedule::~Schedule ( )

inlinevirtual

Destructor.

Definition at line 44 of file Schedule.h.

                            {
            this->!Schedule();
        }

CPPCli::Schedule::!Schedule

(

)

Finaliser.

Definition at line 12 of file Schedule.cpp.

                          {
    _schedule->Delete();
    _schedule = nullptr;
}

Member Function Documentation

List< CPPCli::ScheduleTrigger^ > CPPCli::Schedule::_GetScheduleTriggers ( )

package

Definition at line 140 of file Schedule.cpp.

                                                                   {
    // Create a list of managed trigger objects
    List<CPPCli::ScheduleTrigger^>^ mlist = gcnew List<CPPCli::ScheduleTrigger^>();
    // Create a collection of unmanaged trigger objects
    VxSdk::VxCollection<VxSdk::IVxScheduleTrigger**> scheduleTriggers;

    // Make the GetScheduleTriggers call, which will return with the total trigger count,
    // this allows the client to allocate memory
    VxSdk::VxResult::Value result = _schedule->GetScheduleTriggers(scheduleTriggers);
    // Unless there are no triggers associated with the schedule, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxScheduleTrigger collection
        scheduleTriggers.collection = new VxSdk::IVxScheduleTrigger*[scheduleTriggers.collectionSize];
        result = _schedule->GetScheduleTriggers(scheduleTriggers);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < scheduleTriggers.collectionSize; i++)
                mlist->Add(gcnew CPPCli::ScheduleTrigger(scheduleTriggers.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] scheduleTriggers.collection;
    }
    return mlist;
}

CPPCli::Results::Value CPPCli::Schedule::AddScheduleTrigger

(

CPPCli::NewScheduleTrigger^

newScheduleTrigger

)

Add a new schedule trigger to the schedule.

Parameters

newScheduleTrigger

The new schedule trigger to add.

Returns

The Result of adding the schedule trigger.

Definition at line 17 of file Schedule.cpp.

                                                                                                  {
    // Create a new schedule trigger object
    VxSdk::VxNewScheduleTrigger newTrigger;
    VxSdk::Utilities::StrCopySafe(newTrigger.dailyEndTime, Utils::ConvertDateTimeToTimeChar(newScheduleTrigger->DailyEndTime));
    VxSdk::Utilities::StrCopySafe(newTrigger.dailyStartTime, Utils::ConvertDateTimeToTimeChar(newScheduleTrigger->DailyStartTime));
    VxSdk::Utilities::StrCopySafe(newTrigger.endDate, Utils::ConvertDateTimeToChar(newScheduleTrigger->EndDate));
    VxSdk::Utilities::StrCopySafe(newTrigger.startDate, Utils::ConvertDateTimeToChar(newScheduleTrigger->StartDate));
    VxSdk::Utilities::StrCopySafe(newTrigger.id, Utils::ConvertSysString(newScheduleTrigger->Id));
    VxSdk::Utilities::StrCopySafe(newTrigger.eventSourceDevice, Utils::ConvertSysString(newScheduleTrigger->EventSource));
    newTrigger.postTrigger = newScheduleTrigger->PostTrigger;
    newTrigger.preTrigger = newScheduleTrigger->PreTrigger;
    newTrigger.timeout = newScheduleTrigger->Timeout;
    newTrigger.event = VxSdk::VxSituationType::Value(newScheduleTrigger->Event);
    newTrigger.recurrence = VxSdk::VxRecurrenceType::Value(newScheduleTrigger->RecurrenceType);
    newTrigger.framerate = VxSdk::VxRecordingFramerate::Value(newScheduleTrigger->Framerate);

    // Get the weekly interval values
    int weeklySize = newScheduleTrigger->RecurWeekly->Count;
    int *weekIntervals = new int[weeklySize];
    for (int iW = 0; iW < weeklySize; iW++) {
        weekIntervals[iW] = newScheduleTrigger->RecurWeekly[iW];
    }
    // Add any weekly interval values to the new schedule trigger
    newTrigger.recurWeekly = weekIntervals;
    newTrigger.recurWeeklySize = weeklySize;

    // Get the monthly interval values
    int monthlySize = newScheduleTrigger->RecurMonthly->Count;
    int *monthIntervals = new int[monthlySize];
    for (int iM = 0; iM < monthlySize; iM++) {
        monthIntervals[iM] = newScheduleTrigger->RecurMonthly[iM];
    }
    // Add any monthly interval values to the new schedule trigger
    newTrigger.recurMonthly = monthIntervals;
    newTrigger.recurMonthlySize = monthlySize;

    // Get the yearly interval values
    int yearlySize = newScheduleTrigger->RecurYearly->Count;
    int *yearIntervals = new int[yearlySize];
    for (int iY = 0; iY < yearlySize; iY++) {
        yearIntervals[iY] = newScheduleTrigger->RecurYearly[iY];
    }
    // Add any yearly interval values to the new schedule trigger
    newTrigger.recurYearly = yearIntervals;
    newTrigger.recurYearlySize = yearlySize;

    // Add any event properties to the new schedule trigger
    int size = newScheduleTrigger->EventProperties->Count;
    VxSdk::VxKvObject *kvObj = new VxSdk::VxKvObject[size];
    newTrigger.eventPropertySize = size;
    newTrigger.eventProperties = kvObj;
    for (int ii = 0; ii < size; ii++) {
        VxSdk::Utilities::StrCopySafe(newTrigger.eventProperties[ii].key,
            Utils::ConvertSysString(newScheduleTrigger->EventProperties[ii].Key));
        VxSdk::Utilities::StrCopySafe(newTrigger.eventProperties[ii].value,
            Utils::ConvertSysString(newScheduleTrigger->EventProperties[ii].Value));
    }

    // Add the schedule trigger to the schedule
    return CPPCli::Results::Value(_schedule->AddScheduleTrigger(newTrigger));
}

CPPCli::Results::Value CPPCli::Schedule::DeleteScheduleTrigger

(

CPPCli::ScheduleTrigger^

scheduleTrigger

)

Delete a schedule trigger from the schedule. This will delete the schedule trigger from any other schedules as well.

Parameters

scheduleTrigger

The schedule trigger to delete.

Returns

The Result of deleting the schedule trigger.

Definition at line 79 of file Schedule.cpp.

                                                                                               {
    // Delete the schedule trigger
    return CPPCli::Results::Value(scheduleTrigger->_scheduleTrigger->DeleteScheduleTrigger());
}

List< CPPCli::DataSource^ > CPPCli::Schedule::GetLinks

(

)

Get the data sources linked to the schedule.

Returns

A List containing the data sources linked to the schedule.

Definition at line 84 of file Schedule.cpp.

                                                  {
    // Create a list of managed data source objects
    List<CPPCli::DataSource^>^ mlist = gcnew List<CPPCli::DataSource^>();
    // Create a collection of unmanaged data source objects
    VxSdk::VxCollection<VxSdk::IVxDataSource**> dataSources;

    // Make the GetLinks call, which will return with the total data source count, this allows the client to allocate memory
    VxSdk::VxResult::Value result = _schedule->GetLinks(dataSources);
    // The result should be kInsufficientSize if the number of data sources on the system are greater than 0
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxDataSource collection
        dataSources.collection = new VxSdk::IVxDataSource*[dataSources.collectionSize];
        result = _schedule->GetLinks(dataSources);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < dataSources.collectionSize; i++) {
                mlist->Add(gcnew CPPCli::DataSource(dataSources.collection[i]));
            }
        }
        // Remove the memory we previously allocated to the collection
        delete[] dataSources.collection;
    }
    return mlist;
}

CPPCli::Results::Value CPPCli::Schedule::Link

(

System::Collections::Generic::List< DataSource^ >^

dataSources

)

Add data sources to the schedule.

Parameters

dataSources

A List containing the data sources to be added.

Returns

The Result of adding the data sources.

Definition at line 109 of file Schedule.cpp.

                                                                            {
    VxSdk::VxResult::Value result = VxSdk::VxResult::kUnknownError;

    // Iterate the managed list of data sources
    for (int i = 0; i < dataSources->Count; i++) {
        // Link the data sources to the schedule
        result = _schedule->Link(*dataSources[i]->_dataSource);
    }

    // Unless there was an issue linking the data sources the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::Schedule::Refresh

(

)

Update this instances properties.

Returns

The Result of updating the properties.

Definition at line 123 of file Schedule.cpp.

                                           {
    return (CPPCli::Results::Value)_schedule->Refresh();
}

CPPCli::Results::Value CPPCli::Schedule::Unlink

(

System::Collections::Generic::List< DataSource^ >^

dataSources

)

Delete existing data sources from the schedule.

Parameters

dataSources

A List containing the data sources to be deleted.

Returns

The Result of deleting the data sources.

Definition at line 127 of file Schedule.cpp.

                                                                              {
    VxSdk::VxResult::Value result = VxSdk::VxResult::kUnknownError;

    // Iterate the managed list of data sources
    for (int i = 0; i < dataSources->Count; i++) {
        // UnLink the data sources to the schedule
        result = _schedule->UnLink(*dataSources[i]->_dataSource);
    }

    // Unless there was an issue unlinking the data sources the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

Member Data Documentation

VxSdk::IVxSchedule* CPPCli::Schedule::_schedule

package

Definition at line 146 of file Schedule.h.

Property Documentation

Actions CPPCli::Schedule::Action

getset

Gets or sets the action performed when the schedule is active.

The Action.

Definition at line 106 of file Schedule.h.

System:: String^ CPPCli::Schedule::Id

get

Gets the unique identifier of the schedule.

The unique identifier.

Definition at line 116 of file Schedule.h.

System:: String^ CPPCli::Schedule::Name

getset

Gets or sets the friendly name of the schedule.

The friendly name.

Definition at line 125 of file Schedule.h.

System:: Collections:: Generic:: List< ScheduleTrigger^>^ CPPCli::Schedule::ScheduleTriggers

get

Gets the schedule triggers associated with this schedule.

The List of schedule triggers associated with this schedule.

Definition at line 97 of file Schedule.h.

bool CPPCli::Schedule::UseAllDataSources

getset

Gets or sets a value indicating whether the schedule applies to all data sources.

true if this schedule applies to all data sources, false if not.

Definition at line 139 of file Schedule.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Schedule.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Schedule.cpp