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

SpecUser Class Reference

Base class of an object that uses specs -- something that a spec can be applied to -- this is sometimes not the object that the spec actually operates on (e.g., UnitSpec is applied to Layers but operates on Units -- the SpecUser is the Layer in this case)

See for more info: Wiki Docs For: SpecUser

 #include <SpecUser>

defined at: /mnt/ssd/grey/local/include/Emergent/SpecUser.h :30-42

Inherits From: taNBase, taOBase, taBase

Inherited By: SpecUser*, SpecUser&, const SpecUser, Projection, Layer

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: taBase

Methods

Method Category: ObjectMgmt

Method Category: UserData

Method Category: _NoCategory


Member Documentation

Member Category: taBase

taNBase::name : taString

name of the object


Method Documentation

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

bool SpecUser::ApplySpecToMe ( BaseSpec* spec )

this is the one key method that must be overwritten in each base case to call the proper method to apply the given spec to this object -- returns true upon success, false for failure

Show Source Code

taBase* taOBase::GetOwner ( )

Show Source Code

TypeDef* SpecUser::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: taBase

Expert Methods

Expert Method Category: UserData


Expert Member Documentation

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