ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSortFileNames Class Reference

vtkSortFileNames - Group and sort a set of filenames More...

Inheritance diagram for Kitware.VTK.vtkSortFileNames:
[legend]
Collaboration diagram for Kitware.VTK.vtkSortFileNames:
[legend]

List of all members.

Public Member Functions

 vtkSortFileNames (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSortFileNames ()
 Undocumented Block.
virtual vtkStringArray GetFileNames ()
 Get the full list of sorted filenames.
virtual int GetGrouping ()
 Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.
virtual int GetIgnoreCase ()
 Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.
virtual vtkStringArray GetInputFileNames ()
 Set a list of file names to group and sort.
virtual vtkStringArray GetNthGroup (int i)
 Get the Nth group of file names. This method should only be used if grouping is on. If grouping is off, it will always return null.
virtual int GetNumberOfGroups ()
 Get the number of groups that the names were split into, if grouping is on. The filenames are automatically split into groups, where the filenames in each group will be identical except for their series numbers. If grouping is not on, this method will return zero.
virtual int GetNumericSort ()
 Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.
virtual int GetSkipDirectories ()
 Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.
virtual void GroupingOff ()
 Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.
virtual void GroupingOn ()
 Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.
virtual void IgnoreCaseOff ()
 Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.
virtual void IgnoreCaseOn ()
 Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.
override int IsA (string type)
 Undocumented Block.
new vtkSortFileNames NewInstance ()
 Undocumented Block.
virtual void NumericSortOff ()
 Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.
virtual void NumericSortOn ()
 Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.
virtual void SetGrouping (int _arg)
 Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.
virtual void SetIgnoreCase (int _arg)
 Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.
void SetInputFileNames (vtkStringArray input)
 Set a list of file names to group and sort.
virtual void SetNumericSort (int _arg)
 Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.
virtual void SetSkipDirectories (int _arg)
 Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.
virtual void SkipDirectoriesOff ()
 Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.
virtual void SkipDirectoriesOn ()
 Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.
virtual void Update ()
 Update the output filenames from the input filenames. This method is called automatically by GetFileNames() and GetNumberOfGroups() if the input names have changed.

Static Public Member Functions

static new vtkSortFileNames New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSortFileNames SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSortFileNames"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkSortFileNames"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkSortFileNames_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSortFileNames_GetFileNames_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkSortFileNames_GetGrouping_02 (HandleRef pThis)
static internal int vtkSortFileNames_GetIgnoreCase_03 (HandleRef pThis)
static internal IntPtr vtkSortFileNames_GetInputFileNames_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSortFileNames_GetNthGroup_05 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkSortFileNames_GetNumberOfGroups_06 (HandleRef pThis)
static internal int vtkSortFileNames_GetNumericSort_07 (HandleRef pThis)
static internal int vtkSortFileNames_GetSkipDirectories_08 (HandleRef pThis)
static internal void vtkSortFileNames_GroupingOff_09 (HandleRef pThis)
static internal void vtkSortFileNames_GroupingOn_10 (HandleRef pThis)
static internal void vtkSortFileNames_IgnoreCaseOff_11 (HandleRef pThis)
static internal void vtkSortFileNames_IgnoreCaseOn_12 (HandleRef pThis)
static internal int vtkSortFileNames_IsA_13 (HandleRef pThis, string type)
static internal int vtkSortFileNames_IsTypeOf_14 (string type)
static internal IntPtr vtkSortFileNames_NewInstance_16 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSortFileNames_NumericSortOff_17 (HandleRef pThis)
static internal void vtkSortFileNames_NumericSortOn_18 (HandleRef pThis)
static internal IntPtr vtkSortFileNames_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSortFileNames_SetGrouping_20 (HandleRef pThis, int _arg)
static internal void vtkSortFileNames_SetIgnoreCase_21 (HandleRef pThis, int _arg)
static internal void vtkSortFileNames_SetInputFileNames_22 (HandleRef pThis, HandleRef input)
static internal void vtkSortFileNames_SetNumericSort_23 (HandleRef pThis, int _arg)
static internal void vtkSortFileNames_SetSkipDirectories_24 (HandleRef pThis, int _arg)
static internal void vtkSortFileNames_SkipDirectoriesOff_25 (HandleRef pThis)
static internal void vtkSortFileNames_SkipDirectoriesOn_26 (HandleRef pThis)
static internal void vtkSortFileNames_Update_27 (HandleRef pThis)

Static Private Member Functions

static vtkSortFileNames ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSortFileNames - Group and sort a set of filenames

Description vtkSortFileNames will take a list of filenames (e.g. from a file load dialog) and sort them into one or more series. If the input list of filenames contains any directories, these can be removed before sorting using the SkipDirectories flag. This class should be used where information about the series groupings can be determined by the filenames, but it might not be successful in cases where the information about the series groupings is stored in the files themselves (e.g DICOM).

vtkImageReader2


Constructor & Destructor Documentation

static Kitware.VTK.vtkSortFileNames.vtkSortFileNames ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSortFileNames.vtkSortFileNames ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkSortFileNames.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Get the full list of sorted filenames.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkSortFileNames.GetGrouping ( ) [virtual]

Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.

virtual int Kitware.VTK.vtkSortFileNames.GetIgnoreCase ( ) [virtual]

Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.

Set a list of file names to group and sort.

Here is the call graph for this function:

Get the Nth group of file names. This method should only be used if grouping is on. If grouping is off, it will always return null.

Here is the call graph for this function:

Get the number of groups that the names were split into, if grouping is on. The filenames are automatically split into groups, where the filenames in each group will be identical except for their series numbers. If grouping is not on, this method will return zero.

Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.

Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.GroupingOff ( ) [virtual]

Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.GroupingOn ( ) [virtual]

Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.IgnoreCaseOff ( ) [virtual]

Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.IgnoreCaseOn ( ) [virtual]

Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.

override int Kitware.VTK.vtkSortFileNames.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkSortFileNames.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

virtual void Kitware.VTK.vtkSortFileNames.NumericSortOff ( ) [virtual]

Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.

virtual void Kitware.VTK.vtkSortFileNames.NumericSortOn ( ) [virtual]

Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSortFileNames.SetGrouping ( int  _arg) [virtual]

Sort the file names into groups, according to similarity in filename name and path. Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.SetIgnoreCase ( int  _arg) [virtual]

Ignore case when sorting. This flag is honored by both the sorting and the grouping. This is off by default.

Set a list of file names to group and sort.

virtual void Kitware.VTK.vtkSortFileNames.SetNumericSort ( int  _arg) [virtual]

Sort the files numerically, rather than lexicographically. For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.

virtual void Kitware.VTK.vtkSortFileNames.SetSkipDirectories ( int  _arg) [virtual]

Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.

Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.

Skip directories. If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.

virtual void Kitware.VTK.vtkSortFileNames.Update ( ) [virtual]

Update the output filenames from the input filenames. This method is called automatically by GetFileNames() and GetNumberOfGroups() if the input names have changed.

static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetFileNames_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetGrouping_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetIgnoreCase_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetInputFileNames_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetNthGroup_05 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetNumberOfGroups_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetNumericSort_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GetSkipDirectories_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GroupingOff_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_GroupingOn_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_IgnoreCaseOff_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_IgnoreCaseOn_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_IsA_13 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSortFileNames.vtkSortFileNames_IsTypeOf_14 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_NewInstance_16 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_NumericSortOff_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_NumericSortOn_18 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SetGrouping_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SetIgnoreCase_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SetInputFileNames_22 ( HandleRef  pThis,
HandleRef  input 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SetNumericSort_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SetSkipDirectories_24 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SkipDirectoriesOff_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_SkipDirectoriesOn_26 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSortFileNames.vtkSortFileNames_Update_27 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSortFileNames.MRClassNameKey = "16vtkSortFileNames" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkSortFileNames.MRFullTypeName = "Kitware.VTK.vtkSortFileNames"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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