CLASS ndi.cloud.sync.SyncOptions
SyncOptions Options class for controlling sync behavior
This class defines a set of configurable options used when performing
dataset synchronization tasks, i.e document synchronization.
This class is meant to be used in argument blocks of various sync
functions in order to provide a reusable set of sync options.
Available options:
SyncFiles (logical) - If true, files will be synced (default: false).
Verbose (logical) - If true, verbose output is printed (default: true).
DryRun (logical) - If true, actions are simulated but not performed (default: false).
FileUploadStrategy (string) - "serial" to upload files one by one or
"batch" (default) to upload a bundles of files using zip files.
The "batch" option is recommended when uploading many files,
and the serial option can be used as a fallback if batch upload fails.
Superclasses
matlab.mixin.SetGet, handle
Properties
| Property | Description |
|---|---|
| SyncFiles | |
| Verbose | |
| DryRun | |
| FileUploadStrategy |
Methods
| Method | Description |
|---|---|
| SyncOptions | SyncOptions Construct a new SyncOptions object |
| addlistener | addlistener Add listener for event. |
| delete | DELETE Delete a handle object. |
| eq | == (EQ) Test handle equality. |
| findobj | FINDOBJ Find objects matching specified conditions. |
| findprop | findprop Find property of MATLAB handle object. |
| ge | >= (GE) Greater than or equal relation for handles. |
| get | GET Get MATLAB object properties. |
| gt | > (GT) Greater than relation for handles. |
| isvalid | ISVALID Test handle validity. |
| le | <= (LE) Less than or equal relation for handles. |
| listener | listener Add listener for event without binding the listener to the source object. |
| lt | < (LT) Less than relation for handles. |
| ne | ~= (NE) Not equal relation for handles. |
| notify | NOTIFY Notify listeners of event. |
| set | SET Set MATLAB object property values. |
| toCell | value pairs |
Methods help
SyncOptions - SyncOptions Construct a new SyncOptions object
obj = SyncOptions() creates a SyncOptions object with default values.
obj = SyncOptions(options) initializes properties from the given struct.
Each field in the struct must correspond to a property name.
Documentation for ndi.cloud.sync.SyncOptions/SyncOptions
doc ndi.cloud.sync.SyncOptions
addlistener - addlistener Add listener for event.
el = addlistener(hSource, Eventname, callbackFcn) creates a listener
for the event named Eventname. The source of the event is the handle
object hSource. If hSource is an array of source handles, the listener
responds to the named event on any handle in the array. callbackFcn
is a function handle that is invoked when the event is triggered.
el = addlistener(hSource, PropName, Eventname, Callback) adds a
listener for a property event. Eventname must be one of
'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be
a string scalar or character vector. PropName must be a single
property name specified as string scalar or character vector, or a
collection of property names specified as a cell array of character
vectors or a string array, or as an array of one or more
matlab.metadata.Property objects. The properties must belong to the
class of hSource. If hSource is scalar, PropName can include dynamic
properties.
For all forms, addlistener returns an event.listener. To remove a
listener, delete the object returned by addlistener. For example,
delete(el) calls the handle class delete method to remove the listener
and delete it from the workspace.
addlistener binds the listener's lifecycle to the object that is the
source of the event. Unless you explicitly delete the listener, it is
destroyed only when the source object is destroyed. To control the
lifecycle of the listener independently from the event source object,
use listener or the event.listener constructor to create the listener.
See also listener, event.listener, ndi.cloud.sync.syncoptions, matlab.metadata.Property, events
Help for ndi.cloud.sync.SyncOptions/addlistener is inherited from superclass handle
delete - DELETE Delete a handle object.
DELETE(H) deletes all handle objects in array H. After the delete
function call, H is an array of invalid objects.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/ISVALID, CLEAR
Help for ndi.cloud.sync.SyncOptions/delete is inherited from superclass handle
eq - == (EQ) Test handle equality.
Handles are equal if they are handles for the same object.
H1 == H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise equality result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = EQ(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/GE, NDI.CLOUD.SYNC.SYNCOPTIONS/GT, NDI.CLOUD.SYNC.SYNCOPTIONS/LE, NDI.CLOUD.SYNC.SYNCOPTIONS/LT, NDI.CLOUD.SYNC.SYNCOPTIONS/NE
Help for ndi.cloud.sync.SyncOptions/eq is inherited from superclass handle
findobj - FINDOBJ Find objects matching specified conditions.
The FINDOBJ method of the HANDLE class follows the same syntax as the
MATLAB FINDOBJ command, except that the first argument must be an array
of handles to objects.
HM = FINDOBJ(H, <conditions>) searches the handle object array H and
returns an array of handle objects matching the specified conditions.
Only the public members of the objects of H are considered when
evaluating the conditions.
See also FINDOBJ, NDI.CLOUD.SYNC.SYNCOPTIONS
Help for ndi.cloud.sync.SyncOptions/findobj is inherited from superclass handle
findprop - findprop Find property of MATLAB handle object.
p = findprop(H,PropName) finds and returns the matlab.metadata.Property
object associated with property name PropName of scalar handle object H.
PropName can be a string scalar or character vector. It can be the
name of a property defined by the class of H or a dynamic property
added to scalar object H.
If no property named PropName exists for object H, an empty
matlab.metadata.Property array is returned.
See also ndi.cloud.sync.syncoptions, ndi.cloud.sync.syncoptions/findobj, dynamicprops, matlab.metadata.Property
Help for ndi.cloud.sync.SyncOptions/findprop is inherited from superclass handle
ge - >= (GE) Greater than or equal relation for handles.
H1 >= H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise >= result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = GE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/EQ, NDI.CLOUD.SYNC.SYNCOPTIONS/GT, NDI.CLOUD.SYNC.SYNCOPTIONS/LE, NDI.CLOUD.SYNC.SYNCOPTIONS/LT, NDI.CLOUD.SYNC.SYNCOPTIONS/NE
Help for ndi.cloud.sync.SyncOptions/ge is inherited from superclass handle
get - GET Get MATLAB object properties.
V = GET(H, 'PropertyName') returns the value of the specified
property for the MATLAB object with handle H. If H is an array of
handles, GET returns an M-by-1 cell array of values, where M is equal
to length(H). If 'PropertyName' is replaced by a 1-by-N or N-by-1
cell array of strings containing property names, GET returns an M-by-N
cell array of values. For non-scalar H, if 'PropertyName' is a
dynamic property, GET returns a value only if the property exists in
all objects of the array.
V = GET(H, 'InexactPropertyName') returns the value of the specified
property for the MATLAB object with handle H. GET matches partial and
case-insensitive names that are not ambiguous. Inexact name matching
applies only to class properties. Dynamic properties require exact name matches.
V = GET(H) returns a structure in which each field name is the name of
a user-gettable property of H and each field contains the value of that
property. If H is non-scalar, GET returns a struct array with
dimensions M-by-1, where M = numel(H). If H is non-scalar, GET does
not return dynamic properties.
GET(H) displays the names of all user-gettable properties and their
current values for the MATLAB object with handle H. The class can
override the GETDISP method to control how this information is
displayed. H must be scalar.
See also GET, ndi.cloud.sync.SyncOptions, ndi.cloud.sync.SyncOptions/GETDISP, HANDLE
Help for ndi.cloud.sync.SyncOptions/get is inherited from superclass matlab.mixin.SetGet
gt - > (GT) Greater than relation for handles.
H1 > H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise > result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = GT(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/EQ, NDI.CLOUD.SYNC.SYNCOPTIONS/GE, NDI.CLOUD.SYNC.SYNCOPTIONS/LE, NDI.CLOUD.SYNC.SYNCOPTIONS/LT, NDI.CLOUD.SYNC.SYNCOPTIONS/NE
Help for ndi.cloud.sync.SyncOptions/gt is inherited from superclass handle
isvalid - ISVALID Test handle validity.
TF = ISVALID(H) performs an element-wise check for validity on the
handle elements of H. The result is a logical array of the same
dimensions as H, where each element is the element-wise validity
result.
A handle is invalid if it has been deleted or if it is an element
of a handle array and has not yet been initialized.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/DELETE
Help for ndi.cloud.sync.SyncOptions/isvalid is inherited from superclass handle
le - <= (LE) Less than or equal relation for handles.
Handles are equal if they are handles for the same object. All
comparisons use a number associated with each handle object. Nothing
can be assumed about the result of a handle comparison except that the
repeated comparison of two handles in the same MATLAB session will
yield the same result. The order of handle values is purely arbitrary
and has no connection to the state of the handle objects being
compared.
H1 <= H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise >= result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = LE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/EQ, NDI.CLOUD.SYNC.SYNCOPTIONS/GE, NDI.CLOUD.SYNC.SYNCOPTIONS/GT, NDI.CLOUD.SYNC.SYNCOPTIONS/LT, NDI.CLOUD.SYNC.SYNCOPTIONS/NE
Help for ndi.cloud.sync.SyncOptions/le is inherited from superclass handle
listener - listener Add listener for event without binding the listener to the source object.
el = listener(hSource, Eventname, callbackFcn) creates a listener
for the event named Eventname. The source of the event is the handle
object hSource. If hSource is an array of source handles, the listener
responds to the named event on any handle in the array. callbackFcn
is a function handle that is invoked when the event is triggered.
el = listener(hSource, PropName, Eventname, callback) adds a
listener for a property event. Eventname must be one of
'PreGet', 'PostGet', 'PreSet', or 'PostSet'. Eventname can be a
string sclar or character vector. PropName must be either a single
property name specified as a string scalar or character vector, or
a collection of property names specified as a cell array of character
vectors or a string array, or as an array of one ore more
matlab.metadata.Property objects. The properties must belong to the
class of hSource. If hSource is scalar, PropName can include dynamic
properties.
For all forms, listener returns an event.listener. To remove a
listener, delete the object returned by listener. For example,
delete(el) calls the handle class delete method to remove the listener
and delete it from the workspace. Calling delete(el) on the listener
object deletes the listener, which means the event no longer causes
the callback function to execute.
listener does not bind the listener's lifecycle to the object that is
the source of the event. Destroying the source object does not impact
the lifecycle of the listener object. A listener created with listener
must be destroyed independently of the source object. Calling
delete(el) explicitly destroys the listener. Redefining or clearing
the variable containing the listener can delete the listener if no
other references to it exist. To tie the lifecycle of the listener to
the lifecycle of the source object, use addlistener.
See also addlistener, event.listener, ndi.cloud.sync.syncoptions, matlab.metadata.Property, events
Help for ndi.cloud.sync.SyncOptions/listener is inherited from superclass handle
lt - < (LT) Less than relation for handles.
H1 < H2 performs element-wise comparisons between handle arrays H1 and
H2. H1 and H2 must be of the same dimensions unless one is a scalar.
The result is a logical array of the same dimensions, where each
element is an element-wise < result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = LT(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/EQ, NDI.CLOUD.SYNC.SYNCOPTIONS/GE, NDI.CLOUD.SYNC.SYNCOPTIONS/GT, NDI.CLOUD.SYNC.SYNCOPTIONS/LE, NDI.CLOUD.SYNC.SYNCOPTIONS/NE
Help for ndi.cloud.sync.SyncOptions/lt is inherited from superclass handle
ne - ~= (NE) Not equal relation for handles.
Handles are equal if they are handles for the same object and are
unequal otherwise.
H1 ~= H2 performs element-wise comparisons between handle arrays H1
and H2. H1 and H2 must be of the same dimensions unless one is a
scalar. The result is a logical array of the same dimensions, where
each element is an element-wise equality result.
If one of H1 or H2 is scalar, scalar expansion is performed and the
result will match the dimensions of the array that is not scalar.
TF = NE(H1, H2) stores the result in a logical array of the same
dimensions.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/EQ, NDI.CLOUD.SYNC.SYNCOPTIONS/GE, NDI.CLOUD.SYNC.SYNCOPTIONS/GT, NDI.CLOUD.SYNC.SYNCOPTIONS/LE, NDI.CLOUD.SYNC.SYNCOPTIONS/LT
Help for ndi.cloud.sync.SyncOptions/ne is inherited from superclass handle
notify - NOTIFY Notify listeners of event.
NOTIFY(H, eventname) notifies listeners added to the event named
eventname for handle object array H that the event is taking place.
eventname can be a string scalar or character vector.
H is the array of handles to the event source objects, and 'eventname'
must be a character vector.
NOTIFY(H,eventname,ed) provides a way of encapsulating information
about an event which can then be accessed by each registered listener.
ed must belong to the EVENT.EVENTDATA class.
See also NDI.CLOUD.SYNC.SYNCOPTIONS, NDI.CLOUD.SYNC.SYNCOPTIONS/ADDLISTENER, NDI.CLOUD.SYNC.SYNCOPTIONS/LISTENER, EVENT.EVENTDATA, EVENTS
Help for ndi.cloud.sync.SyncOptions/notify is inherited from superclass handle
set - SET Set MATLAB object property values.
SET(H,'PropertyName',PropertyValue) sets the value of the specified
property for the MATLAB object with handle H. If H is an array of
handles, the specified property's value is set for all objects in H.
SET(H,'InexactPropertyName',PropertyValue) sets the value of the specified
property for the MATLAB object with handle H. SET matches partial and
case-insensitive names that are not ambiguous. Inexact name matching
applies only to class properties. Dynamic properties require exact name matches.
SET(H,'PropertyName1',Value1,'PropertyName2',Value2,...) sets multiple
property values with a single statement.
SET(H,pn,pv) sets the named properties specified in the cell array of
strings pn to the corresponding values in the cell array pv for all
objects specified in H. The cell array pn must be 1-by-N, but the cell
array pv can be M-by-N where M is equal to length(H), so that each
object will be updated with a different set of values for the list of
property names contained in pn.
Given S a structure whose field names are object property names,
SET(H,S) sets the properties identified by each field name of S with
the values contained in the structure.
Note that it is permissible to use property/value string pairs,
structures, and property/value cell array pairs in the same call to
SET.
A = SET(H, 'PropertyName') returns the possible values for the
specified property of the object with handle H. The returned array
is a cell array of possible value strings or an empty cell array if
the property does not have a finite set of possible string values.
SET(H,'PropertyName') displays the possible values for the specified
property of object with handle H.
A = SET(H) returns the names of the user-settable properties and their
possible values for the object with handle H. H must be scalar.
The return value is a structure whose field names are the names of the
user-settable properties of H, and whose values are cell arrays of
possible property values or empty cell arrays.
SET(H) displays the names and possible values for all user-settable
properties of scalar object H. The class can override the SETDISP
method to control how this information is displayed.
See also SET, ndi.cloud.sync.SyncOptions, ndi.cloud.sync.SyncOptions/SETDISP, HANDLE
Help for ndi.cloud.sync.SyncOptions/set is inherited from superclass matlab.mixin.SetGet
toCell - value pairs
nvPairs = obj.toCell() returns a 1-by-2N cell array containing
the property names and values of the object, suitable for use
as name-value pair arguments in other functions.
Example:
args = opts.toCell();
someFunction(args{:});