C# Class Lawo.EmberPlusSharp.S101.S101LogReader

Reads the information written by a S101Logger instance.
Mostra file Open project: Lawo/ember-plus-sharp Class Usage Examples

Private Properties

Property Type Description
AssertRead void
Clear void
GetLogPayload byte[]
ParseHex byte
ReadCore bool
ReadTime System.DateTime

Public Methods

Method Description
GetPayload ( ) : byte[]

Gets the payload of the current event.

Read ( ) : bool

Reads the next event.

When a S101LogReader is first created and initialized, there is no information available. You must call Read to read the first event.

S101LogReader ( EmberTypeBag types, XmlReader logReader ) : System

Initializes a new instance of the S101LogReader class.

Private Methods

Method Description
AssertRead ( ) : void
Clear ( ) : void
GetLogPayload ( ) : byte[]
ParseHex ( string str ) : byte
ReadCore ( ) : bool
ReadTime ( ) : System.DateTime

Method Details

GetPayload() public method

Gets the payload of the current event.
/// /// has never been called, or /// the last call to returned false or threw an exception. ///
public GetPayload ( ) : byte[]
return byte[]

Read() public method

Reads the next event.

When a S101LogReader is first created and initialized, there is no information available. You must call Read to read the first event.

An error occurred while parsing the XML-encoded data, see /// for more information.
public Read ( ) : bool
return bool

S101LogReader() public method

Initializes a new instance of the S101LogReader class.
and/or equal /// null.
public S101LogReader ( EmberTypeBag types, XmlReader logReader ) : System
types EmberTypeBag The types to pass to the internal , which is used to convert /// between XML payload and EmBER payload.
logReader System.Xml.XmlReader The to read the events from. The format needs to match the /// one written by .
return System