lib60870.NET  2.2.0
IEC 60870-5-101/104 Protocol Source Code Library for C#/.NET
lib60870.CS101.IFileProvider Interface Reference
Inheritance diagram for lib60870.CS101.IFileProvider:

Public Member Functions

int GetCA ()
 Returns the CA (Comman address) of the file More...
 
int GetIOA ()
 Returns the IOA (information object address of the file) More...
 
NameOfFile GetNameOfFile ()
 
DateTime GetFileDate ()
 
int GetFileSize ()
 Gets the size of the file in bytes More...
 
int GetSectionSize (int sectionNumber)
 Gets the size of a section in byzes More...
 
bool GetSegmentData (int sectionNumber, int offset, int segmentSize, byte[] segmentData)
 Gets the segment data. More...
 
void TransferComplete (bool success)
 Indicates that the transfer is complete. When success equals true the file data can be deleted More...
 

Member Function Documentation

◆ GetCA()

int lib60870.CS101.IFileProvider.GetCA ( )

Returns the CA (Comman address) of the file

Returns
The CA

Implemented in lib60870.CS101.TransparentFile.

◆ GetFileSize()

int lib60870.CS101.IFileProvider.GetFileSize ( )

Gets the size of the file in bytes

Returns
The file size in bytes

Implemented in lib60870.CS101.TransparentFile.

◆ GetIOA()

int lib60870.CS101.IFileProvider.GetIOA ( )

Returns the IOA (information object address of the file)

Returns
The IOA

Implemented in lib60870.CS101.TransparentFile.

◆ GetSectionSize()

int lib60870.CS101.IFileProvider.GetSectionSize ( int  sectionNumber)

Gets the size of a section in byzes

Returns
The section size in bytes or -1 if the section does not exist
Parameters
sectionNumberNumber of section (starting with 0)

Implemented in lib60870.CS101.TransparentFile.

◆ GetSegmentData()

bool lib60870.CS101.IFileProvider.GetSegmentData ( int  sectionNumber,
int  offset,
int  segmentSize,
byte []  segmentData 
)

Gets the segment data.

Returns
true, if segment data was gotten, false otherwise.
Parameters
sectionNumberSection number.
offsetOffset.
segmentSizeSegment size.
segmentDataSegment data.

Implemented in lib60870.CS101.TransparentFile.

◆ TransferComplete()

void lib60870.CS101.IFileProvider.TransferComplete ( bool  success)

Indicates that the transfer is complete. When success equals true the file data can be deleted

Parameters
successIf set to true success.

Implemented in lib60870.CS101.TransparentFile.


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