|
VEngine Class |
Top level interface for Variable related machinery in Carbon.
Inheritance Hierarchy
SystemObject
RCS.Carbon.VariablesVEngine
RCS.Carbon.ExportExportEngine
RCS.Carbon.ImportImportEngine
RCS.Carbon.TablesCrossTabEngine
RCS.Carbon.VariablesVEngine
RCS.Carbon.ExportExportEngine
RCS.Carbon.ImportImportEngine
RCS.Carbon.TablesCrossTabEngine
Namespace: RCS.Carbon.Variables
Assembly: RCS.Carbon.Variables (in RCS.Carbon.Variables.dll) Version: 9.1.22
SyntaxC#
public class VEngine
The VEngine type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | VEngine(ILicensingProvider, String) | Creates a Carbon cross-tabulation engine using a custom licensing provider. |
| VEngine(String, Int32, String) | Creates a Carbon cross-tabulation engine using the Red Centre Software licensing provider via calls to the RCS licensing web service. |
Properties| Name | Description | |
|---|---|---|
 | BuildNote | Gets the build note of the Carbon library. |
| ID | Gets the ID of the currently open job. The ID is currently a string of random characters. |
| Job | Job context for casedata etc |
| JobName | Gets the name of the currently open job, or null if no job is open. |
| Licence | The authenticated Licence data that is being held in the VContext |
| Version | Gets the version number of the Carbon library (the .NET Assembly version). |
Methods| Name | Description | |
|---|---|---|
| CaseCount | Return number of cases in job |
| CodeCount | Returns the number of codes in a codeframe. |
| Construct | Construct a variable from it's MET information |
| ConstructAll | Construct all variables in the vartree |
| CopyVar | Copy an existing variable as a new variable |
 | DeleteCacheInfo | Deletes all or selected cached files. |
| DownloadAsync | Efficiently downloads all or selected blobs in a job's Azure container to a local folder. |
| Generate | Generate construct info from MET information |
| GetCacheInfo | Gets summary information about files in the cache directory. Meaningful results are currently only returned for Carbon running in Azure hosting with the Job.ini flag set to activate caching. |
| GetVarList | Return list of variables in a vartree branch |
| ListVartreeNames | Lists vartree (Variable Tree) names available in the currently open job. A vartree name can be passed into the GetVarTree methods to retrieve the contents of a specific vartree. |
| LoadVarTree | Loads a variable tree into the job. |
| OpenJob(String) | Opens a job stored in an existing local file-system directory. |
| OpenJob(String, String) | Opens a job stored in an Azure container. |
| ReadFileLines | Reads the lines in a file/blob in the job directory. |
| ReadZCD | Only called by the test form. |
| ReloadVar | Reload a variable , maybe to clear auto-arith/nets |
| SaveVarTree | Saves the current variable tree, possiubly under another name. |
| UploadAsync | Efficiently uploads all or selected contents of the local directory to a cloud job stored in an Azure Storage Account Blob Container. |
| ValidateExp | Only called by the test form. |
| VarFrame | Lists the codes, nets and arith in a codeframe. |
| VarFrameNames | Lists codeframe names in variable |
| VarInfo | Returns basic information on a variable. |
| VarTreeAsNodes | Return axis tree as GenNodes |
| VerbatimCoding | PENDING |
| WriteFileAllText | PUBLIC API -- Write a file under the job directories |
Fields| Name | Description | |
|---|---|---|
 | LicensingProvider | A reference to the licensing provider used by the engine. |
See Also