emergent 8.2.2 NetMonitor Class Reference
emergent 8.2.2   Home · Wiki Docs For: NetMonitor · Emergent Help Browser 

NetMonitor Class Reference

monitors values from network (or other) objects and sends them to a data table/sink

See for more info: Wiki Docs For: NetMonitor

 #include <NetMonitor>

defined at: /mnt/ssd/grey/local/include/Emergent/NetMonitor.h :31-115

Inherits From: taNBase, taOBase, taBase

Inherited By: NetMonitor*, NetMonitor&, const NetMonitor

Index: SubTypes, Members, Methods, Static Members, Static Methods, Expert Members, Expert Methods

Sub Types


SubType Documentation


Regular (preferred) Member and Method Documentation

Members

Member Category: _NoCategory

Member Category: taBase

Methods

Method Category: Monitor

Method Category: ObjectMgmt

Method Category: UserData

Method Category: _NoCategory


Member Documentation

Member Category: _NoCategory

NetMonitor::all_specs : DataColSpec_List

specifications for all of the columns to be generated by this monitor

NetMonitor::data : DataTableRef

the data table that will be used to hold the monitor data

NetMonitor::network : NetworkRef

the overall network object that is being monitored -- if changed, any sub-objects will be updated based on path to new network

NetMonitor::rmv_orphan_cols : bool

remove orphan columns when updating table schema

Member Category: taBase

taNBase::name : taString

name of the object


Method Documentation

Method Category: Monitor

NetMonItem* NetMonitor::AddBlank ( )

add a new blank monitor to be filled in

Show Source Code

NetMonItem* NetMonitor::AddLayActAvg ( )

For Leabra only: add a monitor item to monitor the acts_p_avg variable at the network level (for all layers in the network), which is very useful in Leabra for tuning the network parameters -- this value tells you how much activity on average there is in each layer over time -- it should match the initial avg_act.init activity value relatively closely, for the netinput scaling and other calculations to be accurate

Show Source Code

NetMonItem* NetMonitor::AddLayer ( Layer* lay, taString& variable )

monitor a value in the Layer or its subobjects

Show Source Code

NetMonItem* NetMonitor::AddNetMax ( )

For Leabra only: add a monitor item to monitor the avg_netin.max variable at the network level (for all layers in the network), which is very useful in Leabra for tuning the network parameters to ensure a proper range of max netinput values -- must also turn on compute_rel_netin flags at the Trial and Epoch programs for this data to be computed in the first place

Show Source Code

NetMonItem* NetMonitor::AddNetRel ( )

add a monitor item to monitor the prjns.avg_netin_rel variable at the network level (for all layers and projections in the network), which is very useful in Leabra for tuning the network parameters to achieve desired relative netinput contributions across different projections -- must also turn on compute_rel_netin flags at the Trial and Epoch programs for this data to be computed in the first place

Show Source Code

NetMonItem* NetMonitor::AddNetwork ( Network* net, taString& variable )

monitor a value in the Network or its subobjects

Show Source Code

NetMonItem* NetMonitor::AddObject ( taBase* obj, taString& variable )

monitor a value in the object or its subobjects

Show Source Code

NetMonItem* NetMonitor::AddProjection ( Projection* prj, taString& variable )

monitor a value in the Projection or its subobjects

Show Source Code

void NetMonitor::GetMonVals ( )

get all the values and store in current row of data table -- call in program to get new data

Show Source Code

void NetMonitor::SetDataNetwork ( DataTable* dt, Network* net )

set both the data table and network -- convenient for programs -- calls ResetDataTableCols too -- don't call if columns are manually added or this is adding additional rows to a table

Show Source Code

void NetMonitor::SetDataTable ( DataTable* dt )

set the data table used

Show Source Code

void NetMonitor::SetNetwork ( Network* net )

set the overall network -- also will update any sub-objects to corresponding ones on this network

Show Source Code

void NetMonitor::UpdateDataTable ( bool reset_first = false )

update the datatable configuration to match current set of monitored items -- call this during Init. if reset_first, then existing data rows are removed first

Show Source Code

void NetMonitor::UpdateMonitors ( bool reset_first = false )

old name for UpdateDataTable

Show Source Code

Method Category: ObjectMgmt

taString taNBase::GetName ( )

Get the name of the object

Show Source Code

bool taNBase::HasName ( )

does the object have a name field that can be set?

Show Source Code

void taNBase::MakeNameUnique ( )

make sure my name is unique relative to names of objects associated with my owner (e.g., if it is a list object), typically because my name has changed, and owner needs to ensure that all names are unique

Show Source Code

bool taNBase::SetName ( taString& nm )

Set the object's name

Show Source Code

Method Category: UserData

void taOBase::RemoveAllUserData ( )

get rid of our user data list entirely -- this is done automatically when saving something that has no user data items, but you can also force it with this method -- deletes the whole list

Show Source Code

Method Category: _NoCategory

bool taNBase::AddFromTemplate ( taBase* obj, bool& is_acceptable )

handles drops from toolbar - when adding an object to a program, network, etc - e.g. dropping generic data table onto a program - set is_acceptable for objects 'not handled' but which are acceptable

Show Source Code

taBase* taOBase::GetOwner ( )

Show Source Code

TypeDef* NetMonitor::GetTypeDef ( )

Show Source Code

taSigLink** taOBase::addr_sig_link ( )

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods


Static Method Documentation


Expert Member and Method Documentation

Expert Members

Expert Member Category: _NoCategory

Expert Member Category: taBase

Expert Methods

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: _NoCategory

NetMonitor::items : NetMonItem_List

the list of items being monitored

Expert Member Category: taBase

taOBase::owner : taBase*

pointer to owner

taOBase::user_data_ : UserDataItem_List*

storage for user data (created if needed) DO NOT ACCESS this list directly -- use the GetUserData / SetUserData etc interface!


Expert Method Documentation

Expert Method Category: UserData

UserDataItem_List* taOBase::GetUserDataList ( bool force = false )

gets the userdatalist for this class

Show Source Code


Copyright © 2017Regents of the University of Colorado, Carnegie Mellon University, Princeton University.
emergent 8.2.2