cmlabs::ModuleSpec Class Reference

#include <Specs.h>

Inheritance diagram for cmlabs::ModuleSpec:

Inheritance graph
[legend]
Collaboration diagram for cmlabs::ModuleSpec:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ModuleSpec ()
 ModuleSpec (const JString &xml)
 ModuleSpec (XMLNode *node)
 ~ModuleSpec ()
virtual unsigned long getPayloadSize () const
 Get total size of payload.
Objectclone () const
bool fromXML (const JString &xml)
bool fromXML (XMLNode *node)
JString toXML ()
JString toHTML ()
JString toHTMLCurrent ()
bool switchPhase ()
bool setCurrentContexts (ObjectDictionary *newContexts)
bool isCurrentlyTriggeredBy (JString wb, JString type)
bool hasCranks ()
ObjectCollectiongetTriggersFor (JString wb, JString type)
ObjectCollectiongetActiveContexts ()
PhaseSpecgetFirstActivePhase ()
ObjectCollectiongetActivePhases ()
ObjectCollectiongetAllPhases ()
Collection getReferredWhiteboards ()
Collection getReferredStreams ()
Collection getContextNames ()
bool resetCache ()
long getBinarySize (int chunk)
 Get the size of binary data chunk, -1 for all chunks.
int getBinaryChunkCount ()
 Get the number of data chunks.
long toBinaryBuffer (int chunk, char *buffer, int maxlen)
 Write binary data to buffer at chunk number 'chunk'.
bool fromBinaryBuffer (int chunk, char *buffer, long len)
 Set the data after separate reception.

Public Attributes

ObjectDictionarycontexts
 Each contain a ContextSpec.
JString moduleName
JString description
JString type
JString remote
JString share
JString configXML
double priority
bool allowSelfTriggering
JString plugFunction
int verbose
JString recordStorage
bool recordOverwrite
ObjectDictionarygetTriggersCache
 Cache of lookups of context+whiteboard+type.
JString currentContextsCacheString
 Cache of lookups of the "context" above.
ObjectDictionarycurrentContexts
 Contains Current Contexts - do not delete!!!
ObjectDictionaryparameters
ExecutableSpecexec


Detailed Description

Definition at line 282 of file Specs.h.


Constructor & Destructor Documentation

cmlabs::ModuleSpec::ModuleSpec (  ) 

Definition at line 1618 of file Specs.cpp.

cmlabs::ModuleSpec::ModuleSpec ( const JString xml  ) 

Definition at line 1631 of file Specs.cpp.

cmlabs::ModuleSpec::ModuleSpec ( XMLNode node  ) 

Definition at line 1645 of file Specs.cpp.

cmlabs::ModuleSpec::~ModuleSpec (  ) 

Definition at line 1659 of file Specs.cpp.


Member Function Documentation

unsigned long cmlabs::ModuleSpec::getPayloadSize (  )  const [virtual]

Get total size of payload.

Reimplemented from cmlabs::Object.

Definition at line 1669 of file Specs.cpp.

Object * cmlabs::ModuleSpec::clone (  )  const [virtual]

Implements cmlabs::Object.

Definition at line 1682 of file Specs.cpp.

bool cmlabs::ModuleSpec::fromXML ( const JString xml  )  [virtual]

Reimplemented from cmlabs::Object.

Definition at line 1702 of file Specs.cpp.

bool cmlabs::ModuleSpec::fromXML ( XMLNode node  )  [virtual]

Reimplemented from cmlabs::Object.

Definition at line 1719 of file Specs.cpp.

JString cmlabs::ModuleSpec::toXML (  )  [virtual]

Reimplemented from cmlabs::Object.

Definition at line 1931 of file Specs.cpp.

JString cmlabs::ModuleSpec::toHTML (  )  [virtual]

Reimplemented from cmlabs::Object.

Definition at line 2287 of file Specs.cpp.

JString cmlabs::ModuleSpec::toHTMLCurrent (  ) 

Definition at line 2330 of file Specs.cpp.

bool cmlabs::ModuleSpec::switchPhase (  ) 

Definition at line 1988 of file Specs.cpp.

bool cmlabs::ModuleSpec::setCurrentContexts ( ObjectDictionary newContexts  ) 

Definition at line 2002 of file Specs.cpp.

bool cmlabs::ModuleSpec::isCurrentlyTriggeredBy ( JString  wb,
JString  type 
)

Definition at line 2017 of file Specs.cpp.

bool cmlabs::ModuleSpec::hasCranks (  ) 

Definition at line 1913 of file Specs.cpp.

ObjectCollection * cmlabs::ModuleSpec::getTriggersFor ( JString  wb,
JString  type 
)

Definition at line 2030 of file Specs.cpp.

ObjectCollection * cmlabs::ModuleSpec::getActiveContexts (  ) 

Definition at line 2103 of file Specs.cpp.

PhaseSpec * cmlabs::ModuleSpec::getFirstActivePhase (  ) 

Definition at line 2147 of file Specs.cpp.

ObjectCollection * cmlabs::ModuleSpec::getActivePhases (  ) 

Definition at line 2169 of file Specs.cpp.

ObjectCollection * cmlabs::ModuleSpec::getAllPhases (  ) 

Definition at line 2193 of file Specs.cpp.

Collection cmlabs::ModuleSpec::getReferredWhiteboards (  ) 

Definition at line 2217 of file Specs.cpp.

Collection cmlabs::ModuleSpec::getReferredStreams (  ) 

Definition at line 2260 of file Specs.cpp.

Collection cmlabs::ModuleSpec::getContextNames (  ) 

Definition at line 1901 of file Specs.cpp.

bool cmlabs::ModuleSpec::resetCache (  ) 

Definition at line 1714 of file Specs.cpp.

long cmlabs::ModuleSpec::getBinarySize ( int  chunk  )  [virtual]

Get the size of binary data chunk, -1 for all chunks.

Get the size of any binary data.

Reimplemented from cmlabs::Object.

Definition at line 2388 of file Specs.cpp.

int cmlabs::ModuleSpec::getBinaryChunkCount (  )  [virtual]

Get the number of data chunks.

Reimplemented from cmlabs::Object.

Definition at line 2395 of file Specs.cpp.

long cmlabs::ModuleSpec::toBinaryBuffer ( int  chunk,
char *  buffer,
int  maxlen 
) [virtual]

Write binary data to buffer at chunk number 'chunk'.

Get a pointer to the binary data at chunk number 'chunk'.

Reimplemented from cmlabs::Object.

Definition at line 2402 of file Specs.cpp.

bool cmlabs::ModuleSpec::fromBinaryBuffer ( int  chunk,
char *  buffer,
long  len 
) [virtual]

Set the data after separate reception.

Reimplemented from cmlabs::Object.

Definition at line 2409 of file Specs.cpp.


Member Data Documentation

Each contain a ContextSpec.

Definition at line 331 of file Specs.h.

Definition at line 333 of file Specs.h.

Definition at line 334 of file Specs.h.

Definition at line 335 of file Specs.h.

Definition at line 336 of file Specs.h.

Definition at line 337 of file Specs.h.

Definition at line 338 of file Specs.h.

Definition at line 339 of file Specs.h.

Definition at line 340 of file Specs.h.

Definition at line 341 of file Specs.h.

Definition at line 342 of file Specs.h.

Definition at line 343 of file Specs.h.

Definition at line 344 of file Specs.h.

Cache of lookups of context+whiteboard+type.

Definition at line 348 of file Specs.h.

Cache of lookups of the "context" above.

Definition at line 350 of file Specs.h.

Contains Current Contexts - do not delete!!!

Definition at line 353 of file Specs.h.

Definition at line 354 of file Specs.h.

Definition at line 356 of file Specs.h.


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

Generated on Tue Jul 7 16:23:54 2009 for CoreLibrary by  doxygen 1.5.6