Deadline Scripting Reference  10.3.2.1
Deadline.Pulses.PulseSettings Class Reference

Pulse settings. More...

Inherits LastWriteDocument, and IComparable.

Public Member Functions

int CompareTo (object obj)
 Compare 2 pulse settings by Name More...
 

Properties

string PulseHostMachineIPAddressOverride [get, set]
 If non-empty, this host name or IP address will be used for remote communication with pulse. More...
 
bool PulseIsPrimary [get, set]
 Is this Pulse the Primary Pulse? More...
 
int PulseListeningPort [get, set]
 The port to use listen on if PulseOverridePort is enabled. More...
 
string PulseMacAddressOverride [get, set]
 If non-empty, this is used to override the MAC address for pulse. More...
 
string PulseName [get, set]
 The Pulse name. More...
 
bool PulseOverrideListeningPort [get, set]
 If pulse should listen on a specific port. More...
 
bool PulseOverridePort [get, set]
 If pulse should use a specific port. More...
 
int PulsePort [get, set]
 The port to use if PulseOverridePort is enabled. More...
 

Detailed Description

Pulse settings.

Member Function Documentation

◆ CompareTo()

int Deadline.Pulses.PulseSettings.CompareTo ( object  obj)

Compare 2 pulse settings by Name

Property Documentation

◆ PulseHostMachineIPAddressOverride

string Deadline.Pulses.PulseSettings.PulseHostMachineIPAddressOverride
getset

If non-empty, this host name or IP address will be used for remote communication with pulse.

◆ PulseIsPrimary

bool Deadline.Pulses.PulseSettings.PulseIsPrimary
getset

Is this Pulse the Primary Pulse?

◆ PulseListeningPort

int Deadline.Pulses.PulseSettings.PulseListeningPort
getset

The port to use listen on if PulseOverridePort is enabled.

◆ PulseMacAddressOverride

string Deadline.Pulses.PulseSettings.PulseMacAddressOverride
getset

If non-empty, this is used to override the MAC address for pulse.

◆ PulseName

string Deadline.Pulses.PulseSettings.PulseName
getset

The Pulse name.

◆ PulseOverrideListeningPort

bool Deadline.Pulses.PulseSettings.PulseOverrideListeningPort
getset

If pulse should listen on a specific port.

◆ PulseOverridePort

bool Deadline.Pulses.PulseSettings.PulseOverridePort
getset

If pulse should use a specific port.

◆ PulsePort

int Deadline.Pulses.PulseSettings.PulsePort
getset

The port to use if PulseOverridePort is enabled.