CLASS ndi.dataset.dir

  ndi.dataset.dir - Create a new ndi.dataset.dir object

  D = ndi.dataset.dir(REFERENCE, PATH_NAME)

  Creates an ndi.dataset.dir object, that is, an ndi.dataset object
  with an associated directory.

  One can also create an existing ndi.dataset.dir object with

  D = ndi.dataset.dir(PATH_NAME)

Superclasses

ndi.dataset, handle

Properties

Property	Description
path	the file path of the session

Methods

Method	Description
addSessionInfoToDataset	Add a session_in_a_dataset document to the dataset
add_ingested_session	ingets an ndi.session into an ndi.dataset
add_linked_session	link an ndi.session to an ndi.dataset
addlistener	Create event listener bound to event source
database_add	Add an ndi.document to an ndi.dataset object
database_closebinarydoc	close an ndi.database.binarydoc
database_existbinarydoc	checks if an ndi.database.binarydoc exists for an ndi.document
database_openbinarydoc	open the ndi.database.binarydoc channel of an ndi.document
database_rm	Remove an ndi.document with a given document ID from a dataset
database_search	Search for an ndi.document in a database of an ndi.dataset object
dataset_erase	deletes the entire session database folder
delete	Delete handle object
deleteIngestedSession	delete an ingested session from the dataset
dir	Create a new ndi.dataset.dir object
document_session	DOCUMENT_SESSION return the ndi.session of an ndi.document object in an ndi.dataset
eq	Determine equality
findobj	Find handle objects
findprop	Find matlab.metadata.Property object
ge	Determine greater than or equal to
getpath	Return the path of the dataset
gt	Determine greater than
id	return the identifier of an ndi.dataset object
isvalid	Determine valid handles
le	Determine less than or equal to
listener	Create event listener without binding to event source
lt	Determine less than
ne	Determine inequality
notify	Notify listeners that event is occurring
open_session	open an ndi.session object from an ndi.dataset
reference	return the reference string for an ndi.dataset object
removeSessionInfoFromDataset	Remove session_in_a_dataset document(s) for a given session ID
repairDatasetSessionInfo	Break out dataset_session_info into individual session_in_a_dataset documents
session_list	return the session reference/identifier list for a dataset
unlink_session	unlink a session from an ndi.dataset

Methods help

addSessionInfoToDataset - Add a session_in_a_dataset document to the dataset

NEW_DOC = ndi.dataset.addSessionInfoToDataset(NDI_DATASET_OBJ, SESSION_INFO)

  Creates a new 'session_in_a_dataset' document based on the SESSION_INFO structure
  and adds it to the NDI_DATASET_OBJ's internal session database. The document's
  base.session_id is set to the dataset's ID.

Help for ndi.dataset.dir.addSessionInfoToDataset is inherited from superclass ndi.dataset

---

add_ingested_session - ingets an ndi.session into an ndi.dataset

NDI_DATASET_OBJ = ADD_INGESTED_SESSION(NDI_DATASET_OBJ, NDI_SESSION_OBJ)

  Add an ndi.session object to an ndi.dataset, by copying the session
  documents into the dataset.

Help for ndi.dataset.dir/add_ingested_session is inherited from superclass ndi.dataset

---

add_linked_session - link an ndi.session to an ndi.dataset

NDI_DATASET_OBJ = ADD_LINKED_SESSION(NDI_DATASET_OBJ, NDI_SESSION_OBJ)

  Add an ndi.session object to an ndi.dataset, without ingesting the session
  into the dataset. Instead, the ndi.session is linked to the dataset, but
  the session remains where it is.

Help for ndi.dataset.dir/add_linked_session is inherited from superclass ndi.dataset

---

addlistener - Create event listener bound to event source

This MATLAB function creates a listener for the event EventName.

    Syntax
      el = addlistener(hSource,EventName,callback)
      el = addlistener(hSource,PropertyName,EventName,callback)
      addlistener(___)

    Input Arguments
      hSource - Event source
        handle array
      EventName - Name of event
        character vector | string scalar
      PropertyName - Name of property
        character vector | string | matlab.metadata.Property object
      callback - Listener callback
        function handle

    Output Arguments
      el - Listener object
        event.listener or event.proplistener

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.addlistener.html#d126e729273

    See also notify, event.listener, listener

    Introduced in MATLAB in R2008a

Help for ndi.dataset.dir/addlistener is inherited from superclass handle

    Documentation for ndi.dataset.dir/addlistener
       doc addlistener

---

database_add - Add an ndi.document to an ndi.dataset object

NDI_DATASET_OBJ = DATABASE_ADD(NDI_DATASET_OBJ, NDI_DOCUMENT_OBJ)

  Adds the ndi.document NDI_DOCUMENT_OBJ to the ndi.dataset NDI_DATASET_OBJ.
  NDI_DOCUMENT_OBJ can also be a cell array of ndi.document objects, which will
  all be added in turn.

  If the base.session_id of each NDI_DOCUMENT_OBJ matches one of the sessions
  in the DATASET, the document will be added to that session. If the base.session_id of
  the document matches the id of the NDI_DATASET_OBJ, it will be added to the dataset
  instead of one of the invidiual sessions.

  The database can be queried by calling NDI_DATASET_OBJ/SEARCH

  See also: ndi.dataset.dir/database_search(), ndi.dataset.dir/database_rm()

Help for ndi.dataset.dir/database_add is inherited from superclass ndi.dataset

---

database_closebinarydoc - close an ndi.database.binarydoc

[NDI_BINARYDOC_OBJ] = DATABASE_CLOSEBINARYDOC(NDI_DATASET_OBJ, NDI_BINARYDOC_OBJ)

  Close and lock an NDI_BINARYDOC_OBJ. The NDI_BINARYDOC_OBJ must be unlocked in the
  database, which is why it is necessary to call this function through the dataset object.

Help for ndi.dataset.dir/database_closebinarydoc is inherited from superclass ndi.dataset

---

database_existbinarydoc - checks if an ndi.database.binarydoc exists for an ndi.document

[TF, FILE_PATH] = DATABASE_EXISTBINARYDOC(NDI_DATASET_OBJ, NDI_DOCUMENT_OR_ID, FILENAME)

   Return a boolean flag (TF) indicating if a binary document
   exists for an ndi.document and, if it exists, the full file
   path (FILE_PATH) to the file where the binary data is stored.

Help for ndi.dataset.dir/database_existbinarydoc is inherited from superclass ndi.dataset

---

database_openbinarydoc - open the ndi.database.binarydoc channel of an ndi.document

NDI_BINARYDOC_OBJ = DATABASE_OPENBINARYDOC(NDI_DATASET_OBJ, NDI_DOCUMENT_OR_ID, FILENAME, ...)

   Return the open ndi.database.binarydoc object that corresponds to an ndi.document and
   NDI_DOCUMENT_OR_ID can be either the document id of an ndi.document or an ndi.document object itself.
   The document is opened for reading only. Document binary streams may not be edited once the
   document is added to the database.

   Note that this NDI_BINARYDOC_OBJ must be closed with ndi.dataset/CLOSEBINARYDOC.

   This function takes name/value pairs that modify its behavior.
   Parameter (default)     | Description
   ------------------------------------------------------------------
   autoClose (true)       | Automatically close the file when the returned object goes out of scope.

Help for ndi.dataset.dir/database_openbinarydoc is inherited from superclass ndi.dataset

---

database_rm - Remove an ndi.document with a given document ID from a dataset

NDI_DATASET_OBJ = DATABASE_RM(NDI_DATASET_OBJ, DOC_UNIQUE_ID)
    or
  NDI_DATASET_OBJ = DATABASE_RM(NDI_DATASET_OBJ, DOC)

  Removes an ndi.document with document id DOC_UNIQUE_ID from the
  NDI_DATASET_OBJ database. In the second form, if an ndi.document or cell array
  of NDI_DOCUMENTS is passed for DOC, then the document unique ids are retrieved
  and they are removed in turn.  If DOC/DOC_UNIQUE_ID is empty, no action is
  taken.

  If the base.session_id of each NDI_DOCUMENT_OBJ matches one of the linked sessions
  in the DATASET, the document will be removed from the linked session. If the linked
  session is opened individually, the document will have been removed.

  This function also takes parameters as name/value pairs that modify its behavior:
  Parameter (default)        | Description
  --------------------------------------------------------------------------------
  ErrIfNotFound (false)      | Produce an error if an ID to be deleted is not found.

  See also: ndi.dataset.dir/database_add(), ndi.dataset.dir/database_search()

Help for ndi.dataset.dir/database_rm is inherited from superclass ndi.dataset

---

database_search - Search for an ndi.document in a database of an ndi.dataset object

NDI_DOCUMENT_OBJ = DATABASE_SEARCH(NDI_DATASET_OBJ, SEARCHPARAMETERS)T

  Given search parameters, which is an ndi.query object, the database associated
  with the ndi.dataset object NDI_DATASET_OBJ is searched.

  Matches are returned in a cell list NDI_DOCUMENT_OBJ.

  See also: ndi.dataset.dir/database_add(), ndi.dataset.dir/database_rm()

Help for ndi.dataset.dir/database_search is inherited from superclass ndi.dataset

---

dataset_erase - deletes the entire session database folder

DATABASE_ERASE(NDI_DATASET_DIR_OBJ, AREYOUSURE)

    Deletes the session in the database.

  Use with care. If AREYOUSURE is 'yes' then the
  function will proceed. Otherwise, it will not.

---

delete - Delete handle object

This MATLAB function deletes the handle object.

    Syntax
      delete(H)

    Input Arguments
      H - Handle object
        handle object or array of handle objects

    See also isvalid

Help for ndi.dataset.dir/delete is inherited from superclass handle

    Documentation for ndi.dataset.dir/delete
       doc handle/delete

---

deleteIngestedSession - delete an ingested session from the dataset

NDI_DATASET_OBJ = DELETEINGESTEDSESSION(NDI_DATASET_OBJ, SESSION_ID, 'areYouSure', false, 'askUserToConfirm', true)

  Removes an ingested session from the dataset.

  The function removes the session_in_a_dataset document corresponding to the session,
  and any document whose base.session_id matches the session_id to be deleted.

  WARNING: At present, this step is irreversible, because one cannot add back documents
  to a dataset that have the same IDs as a previously-deleted dataset. This is a known
  issue that may be solved in a future release but for now prevents deletion and
  re-adding of the same ingested session. This issue does not impact linked sessions.

  Inputs:
    SESSION_ID - The ID of the session to delete.
    'areYouSure' - (Optional) Logical, default false. Must be true for the function to work.
    'askUserToConfirm' - (Optional) Logical, default true. If true, a question dialog will confirm the choice.

Help for ndi.dataset.dir/deleteIngestedSession is inherited from superclass ndi.dataset

---

dir - Create a new ndi.dataset.dir object

D = ndi.dataset.dir(REFERENCE, PATH_NAME)

  Creates an ndi.dataset.dir object, that is, an ndi.dataset object
  with an associated directory.

  One can also create an existing ndi.dataset.dir object with

  D = ndi.dataset.dir(PATH_NAME)

    Documentation for ndi.dataset.dir/dir
       doc ndi.dataset.dir

---

document_session - DOCUMENT_SESSION return the ndi.session of an ndi.document object in an ndi.dataset

NDI_SESSION_OBJ = DOCUMENT_SESSION(NDI_DATASET_OBJ, NDI_DOCUMENT_OBJ)

  Given an ndi.document, return an open ndi.session object that contains the
  the document.

Help for ndi.dataset.dir/document_session is inherited from superclass ndi.dataset

---

eq - Determine equality

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where inputs A and B are
    equal; otherwise, the element is logical 0 (false).

    Syntax
      A == B
      eq(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/EqualityOfTwoVectorsExample')
      openExample('matlab/FindCharactersInStringExample')
      openExample('matlab/FindValuesInCategoricalArrayExample')
      openExample('matlab/CompareFloatingPointNumbersExample')
      openExample('matlab/CompareDatetimeValuesExample')
      openExample('matlab/CompareTablesExample')

    See also isapprox, ge, gt, le, lt, ne

    Introduced in MATLAB before R2006a
    Documentation for eq
       doc eq

---

findobj - Find handle objects

This MATLAB function returns the objects listed in H and all of their
    descendants.

    Syntax
      Hmatch = findobj(H)
      Hmatch = findobj(H,property,value,...,property,value)
      Hmatch = findobj(H,'-not',property,value)
      Hmatch = findobj(H,'-regexp',property,expression)
      Hmatch = findobj(H,property,value,logicaloperator,property,value)
      Hmatch = findobj(H,'-function',fh)
      Hmatch = findobj(H,'-function',property,fh)
      Hmatch = findobj(H,'-class',class)
      Hmatch = findobj(H,'-isa',class)
      Hmatch = findobj(H,'-property',property)
      Hmatch = findobj(H,'-method',methodname)
      Hmatch = findobj(H,'-event',eventname)
      Hmatch = findobj(H,'-depth',d,___)

    Input Arguments
      H - Objects to search from
        handle array
      property - Property name
        character vector | string scalar
      class - Class of object to find
        character vector | string scalar | string scalar |
        matlab.metadata.Class instance
      value - Property value
        any value
      methodname - Method name
        character vector | string scalar
      eventname - Event name
        character vector | string scalar
      d - Depth of search
        integer >= 0
      fh - Function handle
        function handle

    Output Arguments
      Hmatch - Objects found by search
        handle array

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.findobj.html#mw_17437b0f-a588-40bf-bae5-dcdd410a410e

    See also findprop

    Introduced in MATLAB in R2008a

Help for ndi.dataset.dir/findobj is inherited from superclass handle

    Documentation for ndi.dataset.dir/findobj
       doc handle/findobj

---

findprop - Find matlab.metadata.Property object

This MATLAB function returns the matlab.metadata.Property object
    associated with the named property of the object h.

    Syntax
      mp = findprop(h,property)

    Input Arguments
      h - handle object
        scalar handle
      property - Name of property
        character vector | string scalar

    Output Arguments
      mp - matlab.metadata.Property object
        matlab.metadata.Property | matlab.metadata.DynamicProperty

    Examples
      openExample('matlab/DisplayPropertyAttributesExample')

    See also matlab.metadata.Property, findobj,
      matlab.metadata.DynamicProperty

Help for ndi.dataset.dir/findprop is inherited from superclass handle

    Documentation for ndi.dataset.dir/findprop
       doc handle/findprop

---

ge - Determine greater than or equal to

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is greater than or
    equal to B; otherwise, the element is logical 0 (false).

    Syntax
      A >= B
      ge(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsExample')
      openExample('matlab/ReplaceElementsofMatrixExample')
      openExample('matlab/CompareValuesinCategoricalArrayExample')
      openExample('matlab/TestComplexNumbersExample')
      openExample('matlab/TestDurationValuesGeExample')
      openExample('matlab/CompareTablesGEExample')

    See also eq, lt, gt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for ge
       doc ge

---

getpath - Return the path of the dataset

P = GETPATH(NDI_DATASET_OBJ)

  Returns the path of an ndi.dataset object.

  The path is some sort of reference to the storage location of
  the dataset. This might be a URL, or a file directory, depending upon
  the subclass.

  In the ndi.dataset class, this returns empty.

  See also: ndidataset.

Help for ndi.dataset.dir/getpath is inherited from superclass ndi.dataset

---

gt - Determine greater than

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is greater than B;
    otherwise, the element is logical 0 (false).

    Syntax
      A > B
      gt(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsGreaterThanExample')
      openExample('matlab/ReplaceElementsofMatrixGreaterExample')
      openExample('matlab/CompareValuesinCategoricalArrayGreaterExample')
      openExample('matlab/TestComplexNumbersGreaterExample')
      openExample('matlab/CompareDatesExample')
      openExample('matlab/CompareTablesGTExample')

    See also eq, ge, lt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for gt
       doc gt

---

id - return the identifier of an ndi.dataset object

IDENTIFIER = ID(NDI_DATASET_OBJ)

  Returns the unique identifier of an ndi.dataset object.

Help for ndi.dataset.dir/id is inherited from superclass ndi.dataset

---

isvalid - Determine valid handles

This MATLAB function returns a logical array in which each element is
    true if the corresponding element in H is a valid handle.

    Syntax
      B = isvalid(H)

    Input Arguments
      H - Input array
        handle array

    Output Arguments
      B - Result of validity test
        logical

    See also delete

Help for ndi.dataset.dir/isvalid is inherited from superclass handle

    Documentation for ndi.dataset.dir/isvalid
       doc handle/isvalid

---

le - Determine less than or equal to

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is less than or
    equal to B; otherwise, the element is logical 0 (false).

    Syntax
      A <= B
      le(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsLessThanOrEqualExample')
      openExample('matlab/ReplaceElementsOfMatrixLessThanOrEqualExample')
      openExample('matlab/CompareValuesInCategoricalArrayLessThanOrEqualExample')
      openExample('matlab/TestComplexNumbersLessThanEqualExample')
      openExample('matlab/TestDurationValuesExample')
      openExample('matlab/CompareTablesLEExample')

    See also eq, ge, gt, lt, ne

    Introduced in MATLAB before R2006a
    Documentation for le
       doc le

---

listener - Create event listener without binding to event source

This MATLAB function creates a listener for the event EventName.

    Syntax
      eL = listener(hSource,EventName,callback)
      eL = listener(hSource,PropertyName,EventName,callback)

    Input Arguments
      hSource - Handle object that is the source of the event
        handle array
      EventName - Name of the event that is triggered on the source objects
        character vector or string scalar
      PropertyName - Name of property
        character vector | string | matlab.metadata.Property object
      callback - Listener callback
        function handle

    Output Arguments
      el - Listener object
        event.listener or event.proplistener

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.listener.html#d126e729602

    See also notify, event.listener

    Introduced in MATLAB in R2017b

Help for ndi.dataset.dir/listener is inherited from superclass handle

    Documentation for ndi.dataset.dir/listener
       doc handle/listener

---

lt - Determine less than

This MATLAB function returns an array or a table of logical values with
    elements set to logical 1 (true) where A is less than B; otherwise, the
    element is logical 0 (false).

    Syntax
      A < B
      lt(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsLessThanExample')
      openExample('matlab/ReplaceElementsofMatrixLessThanExample')
      openExample('matlab/CompareValuesinCategoricalArrayLessThanExample')
      openExample('matlab/TestComplexNumbersLessThanExample')
      openExample('matlab/CompareDatesLessThanExample')
      openExample('matlab/CompareTablesLTExample')

    See also eq, ge, gt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for lt
       doc lt

---

ne - Determine inequality

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where inputs A and B are
    not equal; otherwise, the element is logical 0 (false).

    Syntax
      A ~= B
      ne(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/InequalityOfTwoVectorsExample')
      openExample('matlab/FindCharactersInStringNotEqualExample')
      openExample('matlab/FindValuesInCategoricalArrayNotEqualExample')
      openExample('matlab/CompareFloatingPointNumbersNotEqualExample')
      openExample('matlab/InequalityOfTwoDatetimeArraysExample')
      openExample('matlab/CompareTablesNEExample')

    See also ge, gt, le, lt, eq

    Introduced in MATLAB before R2006a
    Documentation for ne
       doc ne

---

notify - Notify listeners that event is occurring

This MATLAB function notifies listeners that the named event is taking
    place on the handle objects in H.

    Syntax
      notify(H,EventName)
      notify(H,EventName,data)

    Input Arguments
      H - Event source
        handle array
      EventName - Name of event
        character vector | string scalar
      data - User-defined event data
        subclass of event.EventData

    See also addlistener, listener

    Introduced in MATLAB in R2008a

Help for ndi.dataset.dir/notify is inherited from superclass handle

    Documentation for ndi.dataset.dir/notify
       doc handle/notify

---

open_session - open an ndi.session object from an ndi.dataset

NDI_SESSION_OBJ = OPEN_SESSION(NDI_DATASET_OBJ, SESSION_ID)

  Open an ndi.session object with session identifier SESSION_ID that is stored
  in the ndi.dataset NDI_DATASET_OBJ.

  See also: ndi.session, ndi.dataset.dir/session_list()

Help for ndi.dataset.dir/open_session is inherited from superclass ndi.dataset

---

reference - return the reference string for an ndi.dataset object

REF_STRING = REFERENCE(NDI_DATASET_OBJ)

  Returns the reference string for an ndi.dataset object. This can be any
  string, it is not necessarily unique among datasets. The dataset identifier
  returned by ID is unique.

  See also: ndi.dataset.dir/ID

Help for ndi.dataset.dir/reference is inherited from superclass ndi.dataset

---

removeSessionInfoFromDataset - Remove session_in_a_dataset document(s) for a given session ID

ndi.dataset.removeSessionInfoFromDataset(NDI_DATASET_OBJ, SESSION_ID)

  Searches for 'session_in_a_dataset' documents that match the given SESSION_ID
  (and belong to the dataset's session ID) and removes them from the database.

Help for ndi.dataset.dir.removeSessionInfoFromDataset is inherited from superclass ndi.dataset

---

repairDatasetSessionInfo - Break out dataset_session_info into individual session_in_a_dataset documents

[NEW_DOCS] = ndi.dataset.repairDatasetSessionInfo(NDI_DATASET_OBJ, DOC, 'DryRun', [true|false])

  Checks to see if NDI_DATASET_OBJ has a dataset_session_info document. If so, it breaks
  the information out into new individual session_in_a_dataset documents.

  DOC should be an ndi.document of type 'dataset_session_info'.

  If 'DryRun' is false (default), it deletes the dataset_session_info document and adds
  the new session_in_a_dataset documents.

  If 'DryRun' is true, it only returns the new documents that would be added.

Help for ndi.dataset.dir.repairDatasetSessionInfo is inherited from superclass ndi.dataset

---

session_list - return the session reference/identifier list for a dataset

[REF_LIST, ID_LIST, SESSION_DOC_IDS, DATASET_SESSION_DOC_ID] = SESSION_LIST(NDI_DATASET_OBJ)

  Returns information about ndi.session objects contained in an ndi.dataset
  object NDI_DATASET_OBJ. REF_LIST is a cell array of reference strings, and
  ID_LIST is a cell array of unique identifier strings. The nth entry of
  REF_LIST corresponds to the Nth entry of ID_LIST (that is, REF_LIST{n} is the
  reference that corresponds to the ndi.session with unique identifier ID_LIST{n}.

  SESSION_DOC_IDS is a cell array of the document unique ids for the 'session_in_a_dataset'
  documents that describe the session in the dataset.

  DATASET_SESSION_DOC_ID is the document unique id for the 'session' document that
  describes the dataset's own session.

Help for ndi.dataset.dir/session_list is inherited from superclass ndi.dataset

---

unlink_session - unlink a session from an ndi.dataset

UNLINK_SESSION(NDI_DATASET_OBJ, NDI_SESSION_ID, 'areYouSure', false, ...)

  Unlinks a session from the dataset. The session must be a linked session (not ingested).

  Options:
   areYouSure (false) - must be true to proceed, unless confirmed by user
   askUserToConfirm (true) - if true, will ask user for confirmation via dialog (unless areYouSure is true)
   AlsoDeleteSessionAfterUnlinking (false) - if true, will also delete the session files
   DeleteSessionAskToConfirm (true) - passed to the session delete method

Help for ndi.dataset.dir/unlink_session is inherited from superclass ndi.dataset

---