Ixian SDK
DLT.Wordlist Class Reference

Public Member Functions

 Wordlist (String[] words, char space, string name)
 Constructor used by inheritence only More...
 
bool WordExists (string word, out int index)
 Method to determine if word exists in word list, great for auto language detection More...
 
string GetWordAtIndex (int index)
 Returns a string containing the word at the specified index of the wordlist More...
 
string [] Split (string mnemonic)
 
override string ToString ()
 
string [] GetWords (int[] indices)
 
string GetSentence (int[] indices)
 
int [] ToIndices (string[] words)
 
int [] ToIndices (string sentence)
 
BitArray ToBits (string sentence)
 
string [] GetWords (string sentence)
 

Static Public Member Functions

static Task< WordlistLoadWordList (Language language)
 
static async Task< WordlistLoadWordList (string name)
 
static Task< WordlistAutoDetectAsync (string sentence)
 
static Wordlist AutoDetect (string sentence)
 
static Language AutoDetectLanguage (string[] words)
 
static Language AutoDetectLanguage (string sentence)
 
static BitArray ToBits (int[] values)
 
static int [] ToIntegers (BitArray bits)
 

Properties

static Wordlist Japanese [get]
 
static Wordlist ChineseSimplified [get]
 
static Wordlist ChineseTraditional [get]
 
static Wordlist Spanish [get]
 
static Wordlist English [get]
 
static Wordlist French [get]
 
static IWordlistSource WordlistSource [get, set]
 
string Name [get]
 
char Space [get]
 
int WordCount [get]
 The number of all the words in the wordlist More...
 

Detailed Description

Definition at line 22 of file Wordlist.cs.

Constructor & Destructor Documentation

◆ Wordlist()

DLT.Wordlist.Wordlist ( String []  words,
char  space,
string  name 
)

Constructor used by inheritence only

Parameters
wordsThe words to be used in the wordlist

Definition at line 167 of file Wordlist.cs.

Member Function Documentation

◆ AutoDetect()

static Wordlist DLT.Wordlist.AutoDetect ( string  sentence)
static

Definition at line 238 of file Wordlist.cs.

◆ AutoDetectAsync()

static Task<Wordlist> DLT.Wordlist.AutoDetectAsync ( string  sentence)
static

Definition at line 234 of file Wordlist.cs.

◆ AutoDetectLanguage() [1/2]

static Language DLT.Wordlist.AutoDetectLanguage ( string []  words)
static

Definition at line 242 of file Wordlist.cs.

◆ AutoDetectLanguage() [2/2]

static Language DLT.Wordlist.AutoDetectLanguage ( string  sentence)
static

Definition at line 322 of file Wordlist.cs.

◆ GetSentence()

string DLT.Wordlist.GetSentence ( int []  indices)

Definition at line 347 of file Wordlist.cs.

◆ GetWordAtIndex()

string DLT.Wordlist.GetWordAtIndex ( int  index)

Returns a string containing the word at the specified index of the wordlist

Parameters
indexIndex of word to return
Returns
Word

Definition at line 217 of file Wordlist.cs.

◆ GetWords() [1/2]

string [] DLT.Wordlist.GetWords ( int []  indices)

Definition at line 339 of file Wordlist.cs.

◆ GetWords() [2/2]

string [] DLT.Wordlist.GetWords ( string  sentence)

Definition at line 411 of file Wordlist.cs.

◆ LoadWordList() [1/2]

static Task<Wordlist> DLT.Wordlist.LoadWordList ( Language  language)
static

Definition at line 95 of file Wordlist.cs.

◆ LoadWordList() [2/2]

static async Task<Wordlist> DLT.Wordlist.LoadWordList ( string  name)
static

Definition at line 131 of file Wordlist.cs.

◆ Split()

string [] DLT.Wordlist.Split ( string  mnemonic)

Definition at line 329 of file Wordlist.cs.

◆ ToBits() [1/2]

static BitArray DLT.Wordlist.ToBits ( int []  values)
static

Definition at line 374 of file Wordlist.cs.

◆ ToBits() [2/2]

BitArray DLT.Wordlist.ToBits ( string  sentence)

Definition at line 406 of file Wordlist.cs.

◆ ToIndices() [1/2]

int [] DLT.Wordlist.ToIndices ( string []  words)

Definition at line 353 of file Wordlist.cs.

◆ ToIndices() [2/2]

int [] DLT.Wordlist.ToIndices ( string  sentence)

Definition at line 369 of file Wordlist.cs.

◆ ToIntegers()

static int [] DLT.Wordlist.ToIntegers ( BitArray  bits)
static

Definition at line 391 of file Wordlist.cs.

◆ ToString()

override string DLT.Wordlist.ToString ( )

Definition at line 334 of file Wordlist.cs.

◆ WordExists()

bool DLT.Wordlist.WordExists ( string  word,
out int  index 
)

Method to determine if word exists in word list, great for auto language detection

Parameters
wordThe word to check for existence
Returns
Exists (true/false)

Definition at line 198 of file Wordlist.cs.

Property Documentation

◆ ChineseSimplified

Wordlist DLT.Wordlist.ChineseSimplified
staticget

Definition at line 42 of file Wordlist.cs.

◆ ChineseTraditional

Wordlist DLT.Wordlist.ChineseTraditional
staticget

Definition at line 53 of file Wordlist.cs.

◆ English

Wordlist DLT.Wordlist.English
staticget

Definition at line 75 of file Wordlist.cs.

◆ French

Wordlist DLT.Wordlist.French
staticget

Definition at line 86 of file Wordlist.cs.

◆ Japanese

Wordlist DLT.Wordlist.Japanese
staticget

Definition at line 31 of file Wordlist.cs.

◆ Name

string DLT.Wordlist.Name
get

Definition at line 178 of file Wordlist.cs.

◆ Space

char DLT.Wordlist.Space
get

Definition at line 186 of file Wordlist.cs.

◆ Spanish

Wordlist DLT.Wordlist.Spanish
staticget

Definition at line 64 of file Wordlist.cs.

◆ WordCount

int DLT.Wordlist.WordCount
get

The number of all the words in the wordlist

Definition at line 226 of file Wordlist.cs.

◆ WordlistSource

IWordlistSource DLT.Wordlist.WordlistSource
staticgetset

Definition at line 156 of file Wordlist.cs.


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