BGC.Study.Protocol Class Reference

Inheritance diagram for BGC.Study.Protocol:

Collaboration diagram for BGC.Study.Protocol:

Public Member Functions
	Protocol ()
	Protocol (string name)
	Protocol (int id)
void	Add (Session session)
void	AddRange (IEnumerable< Session > sessions)

Static Public Member Functions
static void	HardClear ()

Data Fields
readonly int	id
string	name
List< SessionID >	sessions
JsonObject	envVals
int	Count => sessions.Count
Session	this[int i] => sessions[i].Session

Private Member Functions
IEnumerator< SessionID > IEnumerable< SessionID >.	GetEnumerator ()
IEnumerator IEnumerable.	GetEnumerator ()

Static Private Attributes
static int	nextProtocolID = 1

Detailed Description

Definition at line 9 of file Protocol.cs.

Constructor & Destructor Documentation

Protocol() [1/3]

BGC.Study.Protocol.Protocol ( )

inline

Definition at line 19 of file Protocol.cs.

References BGC.Study.ProtocolManager.protocolDictionary.

        {
            id = nextProtocolID++;
            sessions = new List<SessionID>();
            envVals = new JsonObject();

            ProtocolManager.protocolDictionary.Add(id, this);
        }

Protocol() [2/3]

BGC.Study.Protocol.Protocol ( string  name )

inline

Definition at line 29 of file Protocol.cs.

            : this()
        {
            this.name = name;
        }

Protocol() [3/3]

BGC.Study.Protocol.Protocol ( int  id )

inline

Definition at line 36 of file Protocol.cs.

        {
            this.id = id;
            if (nextProtocolID <= id)
            {
                nextProtocolID = id + 1;
            }

            //Should be assigned by constructing caller
            envVals = null;
        }

Member Function Documentation

Add()

void BGC.Study.Protocol.Add

(

Session

session

)

AddRange()

void BGC.Study.Protocol.AddRange ( IEnumerable< Session >  sessions )

inline

Definition at line 54 of file Protocol.cs.

        {
            foreach (Session session in sessions)
            {
                this.sessions.Add(session);
            }
        }

GetEnumerator() [1/2]

IEnumerator<SessionID> IEnumerable<SessionID>. BGC.Study.Protocol.GetEnumerator ( )

private

GetEnumerator() [2/2]

IEnumerator IEnumerable. BGC.Study.Protocol.GetEnumerator ( )

private

HardClear()

static void BGC.Study.Protocol.HardClear ( )

inlinestatic

Definition at line 62 of file Protocol.cs.

Referenced by BGC.Study.ProtocolManager.HardClearAll().

        {
            nextProtocolID = 1;
        }

Here is the caller graph for this function:

Field Documentation

Count

int BGC.Study.Protocol.Count => sessions.Count

Definition at line 48 of file Protocol.cs.

Referenced by BGC.Study.ProtocolManager.SetSession().

envVals

JsonObject BGC.Study.Protocol.envVals

Definition at line 16 of file Protocol.cs.

Referenced by BGC.Study.ProtocolManager.GetEnvValue(), and BGC.Study.ProtocolManager.SerializeProtocols().

id

readonly int BGC.Study.Protocol.id

Definition at line 12 of file Protocol.cs.

Referenced by BGC.Study.ProtocolID.ProtocolID(), BGC.Study.ProtocolManager.SerializeProtocols(), and BGC.Study.ProtocolManager.SetSession().

name

string BGC.Study.Protocol.name

Definition at line 14 of file Protocol.cs.

Referenced by BGC.Study.ProtocolManager.SerializeProtocols().

nextProtocolID

int BGC.Study.Protocol.nextProtocolID = 1

staticprivate

Definition at line 11 of file Protocol.cs.

sessions

List<SessionID> BGC.Study.Protocol.sessions

Definition at line 15 of file Protocol.cs.

Referenced by BGC.Study.ProtocolManager.SerializeProtocols().

this[int i]

Session BGC.Study.Protocol.this[int i] => sessions[i].Session

Definition at line 50 of file Protocol.cs.

---

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

• Study/Protocol.cs