Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.Syncable.BaseContext Class Reference

Base context for encoding and decoding More...

Inheritance diagram for pluginbase.Objects.Syncable.BaseContext:
pluginbase.Objects.Syncable.DecodeContext pluginbase.Objects.Syncable.EncodeContext

Public Member Functions

void Increment ()
 Increment reads of a context More...
 
void Fail ()
 Failed a context More...
 
void Reset ()
 Reset this instance to make it reusable More...
 

Public Attributes

readonly SyncableEndpoint Endpoint
 The mode in which to decode content More...
 
readonly IFrameTimeState TimeState
 The time state of this frame More...
 

Protected Member Functions

 BaseContext (SyncableEndpoint endpoint, IFrameTimeState timeState)
 Creates an instance of the context More...
 

Protected Attributes

const int SIMULATE_FREQUENCY_PER_SECOND = 15
 The default frequency per-second More...
 

Properties

int ReadCount [get]
 How many reads ocurred in this context More...
 
bool Failed [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed. More...
 
bool EmptyOrFailed [get]
 Are we empty or a failure? More...
 

Detailed Description

Base context for encoding and decoding

Constructor & Destructor Documentation

pluginbase.Objects.Syncable.BaseContext.BaseContext ( SyncableEndpoint  endpoint,
IFrameTimeState  timeState 
)
protected

Creates an instance of the context

Parameters
endpointEndpoint.
timeStateTime state.
62  {
63  Endpoint = endpoint;
64  TimeState = timeState;
65  }
readonly IFrameTimeState TimeState
The time state of this frame
Definition: BaseContext.cs:24
readonly SyncableEndpoint Endpoint
The mode in which to decode content
Definition: BaseContext.cs:19

Member Function Documentation

void pluginbase.Objects.Syncable.BaseContext.Fail ( )

Failed a context

79  {
80  Failed = true;
81  }
bool Failed
Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed...
Definition: BaseContext.cs:40
void pluginbase.Objects.Syncable.BaseContext.Increment ( )

Increment reads of a context

71  {
72  ReadCount++;
73  }
int ReadCount
How many reads ocurred in this context
Definition: BaseContext.cs:32
void pluginbase.Objects.Syncable.BaseContext.Reset ( )

Reset this instance to make it reusable

87  {
88  ReadCount = 0;
89  Failed = false;
90  }
int ReadCount
How many reads ocurred in this context
Definition: BaseContext.cs:32
bool Failed
Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed...
Definition: BaseContext.cs:40

Member Data Documentation

readonly SyncableEndpoint pluginbase.Objects.Syncable.BaseContext.Endpoint

The mode in which to decode content

const int pluginbase.Objects.Syncable.BaseContext.SIMULATE_FREQUENCY_PER_SECOND = 15
protected

The default frequency per-second

readonly IFrameTimeState pluginbase.Objects.Syncable.BaseContext.TimeState

The time state of this frame

Property Documentation

bool pluginbase.Objects.Syncable.BaseContext.EmptyOrFailed
get

Are we empty or a failure?

true if valid not empty; otherwise, false.

bool pluginbase.Objects.Syncable.BaseContext.Failed
get

Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed.

true if failed; otherwise, false.

int pluginbase.Objects.Syncable.BaseContext.ReadCount
get

How many reads ocurred in this context

The read count.


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