VxSdk::VxNewSchedule Struct Reference

Represents a new schedule to be created. 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 <VxNewSchedule.h>

Public Member Functions
	VxNewSchedule ()
	Initializes a new instance of the VxNewSchedule struct. More...
	VxNewSchedule (const VxNewSchedule &ref)
	Initializes a new instance of the VxNewSchedule struct. More...
	~VxNewSchedule ()
	Finalizes an instance of the VxNewSchedule class. More...
void	Clear ()
	Clears this instance. More...

Public Attributes
bool	useAllDataSources
	Indicates whether the schedule shall apply to all data sources regardless of what data sources are linked to the schedule. More...
char	id [64]
	The unique identifier of the schedule. If not supplied, the system will create the identifier. More...
char	name [64]
	The friendly name of the schedule. More...
int	scheduleTriggerSize
	The size of scheduleTriggers. More...
VxNewScheduleTrigger *	scheduleTriggers
	The VxNewScheduleTriggers to create for the new schedule. Maximum of 16 triggers may be created. More...
VxScheduleAction::Value	action
	The action to perform when the schedule is active. More...

Detailed Description

Represents a new schedule to be created. 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 VxNewSchedule.h.

Constructor & Destructor Documentation

VxSdk::VxNewSchedule::VxNewSchedule ( )

inline

Initializes a new instance of the VxNewSchedule struct.

Definition at line 19 of file VxNewSchedule.h.

                        {
            Clear();
        }

VxSdk::VxNewSchedule::VxNewSchedule ( const VxNewSchedule &  ref )

inline

Initializes a new instance of the VxNewSchedule struct.

Parameters

ref	The reference.

Definition at line 27 of file VxNewSchedule.h.

                                                {
            Utilities::StrCopySafe(this->id, ref.id);
            Utilities::StrCopySafe(this->name, ref.name);
            this->useAllDataSources = ref.useAllDataSources;
            this->scheduleTriggerSize = ref.scheduleTriggerSize;
            this->scheduleTriggers = ref.scheduleTriggers;
            this->action = ref.action;
        }

VxSdk::VxNewSchedule::~VxNewSchedule ( )

inline

Finalizes an instance of the VxNewSchedule class.

Definition at line 39 of file VxNewSchedule.h.

                         {
            Clear();
        }

Member Function Documentation

void VxSdk::VxNewSchedule::Clear ( )

inline

Clears this instance.

Definition at line 46 of file VxNewSchedule.h.

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

Member Data Documentation

VxScheduleAction::Value VxSdk::VxNewSchedule::action

The action to perform when the schedule is active.

Definition at line 80 of file VxNewSchedule.h.

char VxSdk::VxNewSchedule::id[64]

The unique identifier of the schedule. If not supplied, the system will create the identifier.

Definition at line 63 of file VxNewSchedule.h.

char VxSdk::VxNewSchedule::name[64]

The friendly name of the schedule.

Definition at line 67 of file VxNewSchedule.h.

VxNewScheduleTrigger* VxSdk::VxNewSchedule::scheduleTriggers

The VxNewScheduleTriggers to create for the new schedule. Maximum of 16 triggers may be created.

Definition at line 76 of file VxNewSchedule.h.

int VxSdk::VxNewSchedule::scheduleTriggerSize

The size of scheduleTriggers.

Definition at line 71 of file VxNewSchedule.h.

bool VxSdk::VxNewSchedule::useAllDataSources

Indicates whether the schedule shall apply to all data sources regardless of what data sources are linked to the schedule.

Definition at line 59 of file VxNewSchedule.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/VxNewSchedule.h