81 lines
2.7 KiB
Markdown
81 lines
2.7 KiB
Markdown
# XCDataCollector
|
|
|
|
it is a module which used for Save and Retrieve Data in SaherElm's XTrade Framework.
|
|
this tool helps all required modules to save data for next usage and analytics.
|
|
we can implement Save To File and Read From File actions to all Structures and Classes and Modules.
|
|
|
|
## Dependencies
|
|
|
|
there is no Dependencies on this modules.
|
|
|
|
## Instancing
|
|
|
|
there is not any args in Constructor.
|
|
|
|
## Instructions
|
|
|
|
- using Path Action of instance for Setting File Path;
|
|
- using Save, Append, Read for File Manipulations;
|
|
|
|
## Actions
|
|
|
|
### Path
|
|
|
|
is a Property Setter and Getter Action for Setting Collector Path.
|
|
for setter it's have an input Parameters (string value) which Specified the File's Path.
|
|
|
|
### GetFilePath(string fileName)
|
|
|
|
retrieve Full path (including provided file name) based on Current Configured Path for instance.
|
|
|
|
### GetFileHandlerForWrite(string filePath)
|
|
|
|
retrieve File Handler by Write Access for Writing Data to File.
|
|
you have to provide Fully File Path for access Handler.
|
|
this for Use Implementing Custom Collecting Senarios out of Instance Box.
|
|
commonly it's used by built in Actions for Regular Saving Data.
|
|
|
|
### GetFileHandlerForRead(string filePath)
|
|
|
|
retrieve File Handler by Read Access for Reading Data from File.
|
|
you have to provide Fully File Path for access Handler.
|
|
this for Use Implementing Custom Retrieving Senarios out of Instance Box.
|
|
commonly it's used by built in Actions for Regular Reading Data.
|
|
|
|
### Save(string fileName, string content)
|
|
|
|
Save Specified Content to Specified File Nmae.
|
|
here the file name must Contains fully file path including file name.
|
|
it's only one time writing file. if it's file exists before overwrite it's content.
|
|
|
|
### Append(string fileName, string content)
|
|
|
|
Append Specified Contonet to end of Specified File.
|
|
here the file name must Contains fully file path including file name.
|
|
if file Exists, add to end of it. if not, Create file at Specified Provided path, then write content.
|
|
|
|
### Read(string fileName, string &content)
|
|
|
|
Read all of File Content at once from Specified File.
|
|
here the file name must Contains fully file path including file name.
|
|
content arg is a reference string variable to hold file content.
|
|
|
|
### Read(string fileName, string &content[])
|
|
|
|
Read all of File Content Lines at once from Specified File.
|
|
here the file name must Contains fully file path including file name.
|
|
content arg is a reference string array variable to hold file content lines.
|
|
|
|
### IsExists(string fileName)
|
|
|
|
Check Specified File Exists or not ...
|
|
here the file name must Contains fully file path including file name.
|
|
|
|
## Maintainer
|
|
|
|
Hadi Khazaee asl
|
|
|
|
[https://www.saherelm.ir](https://www.saherelm.ir)
|
|
|
|
[hadi_khazaee_asl@yahoo.com](mailto:hadi_khazaee_asl@yahoo.com)
|