FileArray
Last update: 16.07.2025public class FileArray : Array
A variable type class for ModelCenter
Author
jdaley, 7/2010
Functions
| Name | Summary |
|---|---|
| dependentLinks | public dependentLinks(): VariableLinks Returns a list of links that immediately depend on the value of this variable. |
| disableGC | public disableGC(gc: Boolean) If true, prevents releaseObjects from doing anything. |
| fromFile | public fromFile(fileName: String, index: String) public fromFile(fileName: String, d1: Long) public fromFile(fileName: String, d1: Long, d2: Long) reads data from a file public fromFile(fileName: String, d1: Long, d2: Long, d3: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long) public fromFile(fileName: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long) |
| fromString | public fromString(value: String, index: Long) sets the value for the variable from a string public fromString(str: String) Sets the value for the variable from a string. |
| getAutoSize | public getAutoSize(): Boolean gets the autoSize flag. |
| getDescription | public getDescription(id: Long): String gets the description text for the file array |
| getDimensions | public getDimensions(): Variant gets the dimensions of an array |
| getDirectDependents | public getDirectDependents(): Variables public getDirectDependents(followSuspended: Boolean): Variables Gets all the immediately linked outputs of this variable. |
| getDirectPrecedents | public getDirectPrecedents(): Variables public getDirectPrecedents(followSuspended: Boolean): Variables Gets all the immediately linked inputs of this variable. |
| getFileExtension | public getFileExtension(index: String): String public getFileExtension(d1: Long): String public getFileExtension(d1: Long, d2: Long): String gets the extension used for the file (used to associate the file with an application). public getFileExtension(d1: Long, d2: Long, d3: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long): String public getFileExtension(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long): String |
| getFullName | public getFullName(): String Gets the full name of the variable, e.g. |
| getHasChanged | public getHasChanged(): Boolean Boolean which indicates if the variable has changed since the last time the boolean was reset. |
| getHide | public getHide(): Boolean Gets whether the variable is hidden or not |
| getIsBinary | public getIsBinary(): Boolean gets a flag indicating if the file contents are binary |
| getLength | public getLength(): Long gets the size of the array. public getLength(dimension: Long): Long gets the size of a specific dimension in the array. |
| getMetadata | public getMetadata(name: String): Variant Get a metadata value. |
| getName | public getName(): String Gets the name of the variable, e.g. |
| getNumDimensions | public getNumDimensions(): Long gets the number of dimensions |
| getOwningComponent | public getOwningComponent(): Component Get the component which owns this variable. |
| getSaveWithModel | public getSaveWithModel(): Boolean Gets a flag indicating that the value of the file array should be saved with the model. |
| getSize | public getSize(): Long gets the size of the array. public getSize(dimension: Long): Long gets the size of a specific dimension in the array. |
| getType | public getType(): String Gets the type of the variable. |
| invalidate | public invalidate() Invalidates the variable |
| isInput | public Indicates whether the variable is an input or output |
| isInputToComponent | public isInputToComponent(): Boolean Indicates whether a variable is an input to a component |
| isInputToModel | public isInputToModel(): Boolean Indicates whether a variable is an input to the Model |
| isValid | public isValid(): Boolean Indicates whether the variable is currently valid or not |
| precedentLinks | public precedentLinks(): VariableLinks Returns a list of links that are immediate precedents to the value of this variable. |
| release | public release() Releases the COM reference to ModelCenter for this object. |
| releaseObjects | public releaseObjects() This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. |
| setAutoSize | public setAutoSize(flag: Boolean) sets the autoSize flag. |
| setDescription | public setDescription(desc: String) sets the description text for the file array |
| setDimensions | public setDimensions(d1: Long) public setDimensions(d1: Long, d2: Long) public setDimensions(d1: Long, d2: Long, d3: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long) public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long) sets the size of the dimensions of the array |
| setFileExtension | public setFileExtension(ext: String, index: String) public setFileExtension(ext: String, d1: Long) public setFileExtension(ext: String, d1: Long, d2: Long) sets the desired file extension for the file public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long) public setFileExtension(ext: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long) |
| setHasChanged | public setHasChanged(flag: Boolean) Boolean which indicates if the variable has changed since the last time the boolean was reset. |
| setHide | public setHide(flag: Boolean) Set whether the variable is hidden or not |
| setIsBinary | public setIsBinary(flag: Boolean) sets a flag indicating that this variable contains binary data |
| setLength | public setLength(size: Long) sets the size of the array. public setLength(size: Long, dimension: Long) sets the size of a specific dimension in the array. |
| setMetadata | public setMetadata(name: String, type: Variable.MetadataType, value: Any, access: Variable.MetadataAccess, archive: Boolean) Set a metadata value on a variable. |
| setNumDimensions | public setNumDimensions(num: Long) sets the number of dimensions |
| setReferenceDebugMode | public setReferenceDebugMode(on: Boolean) When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. |
| setSaveWithModel | public setSaveWithModel(flag: Boolean) Sets a flag indicating that the value of the file array should be saved with the model. |
| setSize | public setSize(size: Long) sets the size of the array. public setSize(size: Long, dimension: Long) sets the size of a specific dimension in the array. |
| toFile | public toFile(fileName: String, encoding: String, index: String) public toFile(fileName: String, encoding: String, d1: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long) writes out contents to a file public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long) public toFile(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long) |
| toFileAbsolute | public toFileAbsolute(fileName: String, encoding: String, index: String) public toFileAbsolute(fileName: String, encoding: String, d1: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long) writes out contents to a file without validating the variable public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long) public toFileAbsolute(fileName: String, encoding: String, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long) |
| toString | public toString(index: Long): String converts the variable value to a string representation. public toString(): String Converts the variable value to a string representation. |
| toStringAbsolute | public toStringAbsolute(index: Long): String converts the variable value to a string representation. public toStringAbsolute(): String Converts the variable value to a string representation. |
| validate | public validate() Causes the scheduler to get a valid value for this variable. |
