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

taBase Class Reference

Base type for all type-aware classes

See for more info: Wiki Docs For: taBase

 #include <taBase>

defined at: /mnt/ssd/grey/local/include/Emergent/taBase.h :514-1664

Inherited By: taBase*, taBase&, const taBase, taBaseItr, taOBase, MatrixIndex, MatrixGeom, ValIdx, taTime, DMemComm, DMemShareVar, DMemAggVars, taVector2i, taVector2f, taQuaternion, taTransform, MinMaxInt, FixedMinMax, ClustLink, FlatTreeEl, ObjDiffRec, taColor, taColorPhong, ColorScaleColor

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

Sub Types


SubType Documentation

enum taBase::Orientation

must be same values as Qt::Orientation

ConstantValueDescription
taBase::Horizontal0x00000001
taBase::Vertical0x00000002

enum taBase::ValType

the basic data types widely supported by data-handling api's, esp. matrices

ConstantValueDescription
taBase::VT_STRING0x00000000an ANSI string of any length
taBase::VT_DOUBLE0x00000001a 8-byte floating point value (aprox 15 sig decimal digits)
taBase::VT_FLOAT0x00000002a 4-byte floating point value (aprox 7 sig decimal digits)
taBase::VT_INT0x00000003a signed integer in machine native size (32 or 64 bit)
taBase::VT_BYTE0x00000004an unsigned 8-bit integer; used mostly for image components (rgb)
taBase::VT_VARIANT0x00000005a Variant, which can hold scalars, strings, matrices, and objects
taBase::VT_VOIDPTR0x00000006a generic pointer (void*)
taBase::VT_BOOL0x00000007a boolean value

enum taBase::IndexMode

what kind of index is specified in the Elem access function

ConstantValueDescription
taBase::IDX_UNK0x00000000unknown -- use the argument to figure it out based on the specs for each index type (string defaults to IDX_NAME, IDX_SLICE favored over IDX_COORDS where ambiguous)
taBase::IDX_IDX0x00000001single scalar numerical index (flat index) -- negative numbers count from the back of the list, initial index is 0 -- ignores any existing view filtering on container and uses original dimensions
taBase::IDX_NAME0x00000002single string value -- find element object by name or string value (if applicable) -- simple wildcard expressions are supported (*, ? [..]) -- returns single value of first match or NULL if none -- obeys any existing view filtering on container
taBase::IDX_NAMES0x00000003String_Matrix -- find element objects by name or string value (if applicable) -- simple wildcard expressions are supported (*, ? [..]) -- returns container of items that match any of the names in the matrix (empty if none) -- obeys any existing view filtering on container
taBase::IDX_COORD0x000000041D int_Matrix with size = number of dims in container -- get item from an explicit coordinate along each dimension, any of which can be negative to get from the end (for multidimensional containers) -- returns a single item -- ignores any existing view filtering on container and uses original dimensions
taBase::IDX_COORDS0x000000051D or 2D int_Matrix with first (inner) dim = number of dims in container specifying coordinates of items in container (if container is 1D then int_Matrix can be 1D), second (outer) dim of arbitrary size (< size of container) to hold any number of elements to select -- returns container of items (could be the original container with a selector filter set to access only these items, depending on the container type) -- ignores any existing view filtering on container and uses original dimensions
taBase::IDX_FRAMES0x00000006for matrix objects, 1D int_Matrix that specifies indexes of frames to access for matrix -- used for datatable rows
taBase::IDX_SLICE0x000000072D slice_Matrix or int_Matrix with first (inner) dim of size 3 = start:stop:skip slice ranges for each dimension (any of which can be negative = start from end or iterate backward), outer dim = number of dims of container (one slice spec per dimension) -- ignores any existing view filtering on container and uses original dimensions
taBase::IDX_MASK0x00000008byte_Matrix with same shape as container = bool mask of items to include (0 = don't include, 1 = include) -- any existing mask is logical AND'd to produce intersection
taBase::IDX_MISC0x00000009miscellaneous case-specific indexing format, typically taking a Variant_Matrix and doing things like typedef matching or other specific cases

enum taBase::BaseFlags

control flags

ConstantValueDescription
taBase::THIS_INVALID0x00000001CheckThisConfig_impl has detected a problem
taBase::CHILD_INVALID0x00000002CheckChildConfig_impl returns issue with a child
taBase::COPYING0x00000004this object is currently within a Copy function
taBase::USE_STALE0x00000008calls setStale on appropriate changes; usually set in Initialize
taBase::BF_READ_ONLY0x00000010this object should be considered readonly by most code (except controlling objs) and by CSS -- note that ro is a property -- use that to query the ro status
taBase::BF_GUI_READ_ONLY0x00000020a less restrictive form of ro intended to prevent users from modifying an object, but still permit programmatic access; RO ==> GRO
taBase::DESTROYING0x00000040Set in Destroying at the very beginning of destroy
taBase::DESTROYED0x00000080set in base destroy (DEBUG only); lets us detect multi destroys
taBase::NAME_READONLY0x00000100set to disable editing of name
taBase::REGISTERED0x00000200set when registered (must unreg)
taBase::BF_MISC10x00001000miscellaneous user flag -- useful for internal temp flags that user does not need to see (e.g., marking an object as used or not in a given context)
taBase::BF_MISC20x00002000miscellaneous user flag -- useful for internal temp flags that user does not need to see (e.g., marking an object as used or not in a given context)
taBase::BF_MISC30x00004000miscellaneous user flag -- useful for internal temp flags that user does not need to see (e.g., marking an object as used or not in a given context)
taBase::BF_MISC40x00008000miscellaneous user flag -- useful for internal temp flags that user does not need to see (e.g., marking an object as used or not in a given context)
taBase::INVALID_MASK0x00000003
taBase::COPY_MASK0x00000103flags to copy when doing an object copy
taBase::EDITABLE_MASK0x00000030flags in the Editable group

enum taBase::DumpQueryResult

Dump_QuerySaveMember response

ConstantValueDescription
taBase::DQR_NO_SAVE0x00000000definitely do not save
taBase::DQR_SAVE0x00000001definitely save
taBase::DQR_DEFAULT0x00000002do default for this member (this is the base result)


Regular (preferred) Member and Method Documentation

Members

Methods

Method Category: Access

Method Category: ControlPanel

Method Category: Display

Method Category: File

Method Category: ListMgmt

Method Category: ObjectMgmt

Method Category: UserData

Method Category: _NoCategory


Method Documentation

Method Category: Access

Variant taBase::Elem ( Variant& idx, taBase::IndexMode mode = IDX_UNK )

get element(s) from container -- return can be a single item or a Matrix of multiple items, depending on the index -- see IndexMode for all the possible indexing modes and associated return values (some of which are not applicable to some containers, as documented for that container)

Show Source Code

taBase* taBase::ElemPath ( taString& path, TypeDef* expect_type = __null, bool err_msg = true )

returns taBase item at given path under this object -- path can skip over steps -- a search is conducted to find items -- this provides the same kind of flexibility that css provides in accessing elements of the structural hierarchy -- also allows for type checking of result -- it is just a wrapper around FindFromPath with optional error checking

Show Source Code

bool taBase::IsContainer ( )

is this item a container object or not?

Show Source Code

int taBase::IterCount ( )

how many items will be iterated over if we iterate through this container -- this is fast for no view and IDX_COORDS views and slow (requiring summing over mask) for IDX_MASK views

Show Source Code

Variant taBase::IterFirst ( taBaseItr& itr )

get iterator for this container and start it at the first item for iterating through items in this container -- if no valid first item, iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterFirst(itr); itr.More(); itm = cont.IterNext(itr)) { ... } -- see also TA_FOREACH macro

Show Source Code

int taBase::IterFirstIndex ( taBaseItr& itr )

get iterator for this container and start index at the first item for iterating through items in this container, returns index if iterator was set to a valid index, -1 if not, in which case iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterFirstIndex(itr); itr.More(); itm = cont.IterNextIndex(itr)) { ... } -- see also TA_FOREACH_INDEX macro

Show Source Code

Variant taBase::IterLast ( taBaseItr& itr )

get reverse iterator for this container and start it at the last item for iterating through items in this container -- if no valid last item, iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterLast(itr); itr.More(); itm = cont.IterNextRev(itr)) { ... } -- see also TA_FOREACH_REV macro

Show Source Code

int taBase::IterLastIndex ( taBaseItr& itr )

get iterator for this container and start index at the last item for iterating through items in this container in reverse, returns index if iterator was set to a valid index, -1 if not, in which case iterator is deleted: e.g., taBaseItr itr; for(Variant itm = cont.IterLastIndex(itr); itr.More(); itm = cont.IterPrevIndex(itr)) { ... } -- see also TA_FOREACH_INDEX_REV macro

Show Source Code

Variant taBase::IterNext ( taBaseItr& itr )

iterate to next item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a next item -- see IterFirst() for more docs

Show Source Code

int taBase::IterNextIndex ( taBaseItr& itr )

iterate to index of next item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a next item -- see IterFirstIndex() for more docs

Show Source Code

Variant taBase::IterPrev ( taBaseItr& itr )

iterate to previous item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a prev item -- see IterLast() for more docs

Show Source Code

int taBase::IterPrevIndex ( taBaseItr& itr )

iterate to index of previous item in container using given iterator -- when the end is reached, the iterator pointer is automatically deleted and the pointer is set to NULL (and returns _nilVariant) -- use itr as test to see if there is a prev item -- see IterLastIndex() for more docs

Show Source Code

Method Category: ControlPanel

bool taBase::AddFunToControlPanel ( MethodDef* function, ControlPanel* ctrl_panel, taString& extra_label )

select a function (method) for calling from a project control_panel - a panel that is a user chosen collection of members and methods from one or more objects (if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if method was already selected. extra_label is prepended to function name if present

Show Source Code

bool taBase::AddFunToControlPanelNm ( taString& function_nm, ControlPanel* ctrl_panel, taString& extra_label = taString(), taString& sub_gp_nm = taString(), taString& desc = taString() )

select a method (by name) for use in a control_panel that is a collection of selected members and methods from different objects (if ctrl_panel is NULL, a new one is created in .crtl_panels) returns false if method was already selected. desc is a custom description -- will show up as tooltip for user (default is info from method)

Show Source Code

bool taBase::AddToControlPanel ( MemberDef* member, ControlPanel* ctrl_panel )

select an object member to be added to a given control_panel (a user-chosen collection of members and methods from one or more objects -- if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if member was already selected. prompts user for final specification of label to use

Show Source Code

bool taBase::AddToControlPanelNm ( taString& memb_nm, ControlPanel* ctrl_panel, taString& extra_label = taString(), taString& sub_gp_nm = taString(), taString& desc = taString(), bool short_label = false )

add given member (by name) given control_panel (a user-chosen collection of members and methods from one or more objects -- if ctrl_panel is NULL, a new one is created in .ctrl_panels). returns false if member was already selected. extra_label is prepended to member name if present, otherwise owner obj name and path to member is prepended, and if sub_gp_nm is specified, item will be put in this sub-group (new one will be made if it does not yet exist). desc is a custom description -- will show up as tooltip for user (default is info from member). short_label omits prepending owner name to label

Show Source Code

ControlPanel* taBase::MemberControlPanel ( taString& member_name, TypeDef* panel_type = __null )

if a given member name (must be direct member of object) is on a control panel, this returns the first such control panel that it is on, else NULL -- if panel_type is non-null, it ONLY looks for panels of a given type (e.g., ParamSet, etc) -- otherwise looks for any kind of ControlPanel (excluding archives -- only active)

Show Source Code

Method Category: Display

void taBase::BrowseMe ( )

show this object in its own browser

Show Source Code

bool taBase::BrowserCollapseAll ( )

collapse all sub-leaves under this item in the browser

Show Source Code

bool taBase::BrowserEditMe ( )

select this item and open for edit (only works if gui is active, etc) -- returns success

Show Source Code

bool taBase::BrowserExpandAll ( )

expand all sub-leaves under this item in the browser

Show Source Code

bool taBase::BrowserSelectMe ( )

select this item in the main project browser (only works if gui is active, etc) -- returns success

Show Source Code

bool taBase::ChooseMe ( )

Display a chooser of whatever type this method is called on

Show Source Code

taString taBase::DiffCompareString ( taBase* cmp_obj, taDoc*& doc )

compare this object with selected comparison object using a diff operation on their save file representations -- more robust to large differences than the select-for-edit version (if doc is NULL, a new one is created in .docs). returns diff string as well.

Show Source Code

bool taBase::Edit ( )

Edit this object using the gui -- this will be an edit dialog or an edit panel depending on ...???

Show Source Code

bool taBase::EditPanel ( bool new_tab = false, bool pin_tab = false )

Edit this object in a panel in the gui browser (if new_tab == true, then a new edit panel tab is opened for it, if pin_tab == true then the new tab is pinned in place (option ignored for new_tab == false))

Show Source Code

MainWindowViewer* taBase::GetMyBrowser ( )

get the project browser for this object's project owner

Show Source Code

bool taBase::GuiFindFromMe ( taString& find_str )

activate the gui find dialog starting from this object, with given find string

Show Source Code

void taBase::Help ( )

get help on using this object

Show Source Code

bool taBase::OpenInWindow ( bool modal = false )

Edit this object in a popup dialog using the gui (if modal == true, the edit dialog blocks all other gui operations until the user closes it)

Show Source Code

taString& taBase::Print ( taString& strm, int indent = 0 )

print the value of the object to given string

Show Source Code

taString taBase::PrintStr ( int indent = 0 )

print the value of the object to a string

Show Source Code

void taBase::RebuildAllViews ( )

call after data changes, to rebuild views, typically when a child is added

Show Source Code

void taBase::UpdateAllViews ( )

called after data changes, to update views

Show Source Code

Method Category: File

taString taBase::GetFileName ( )

get file name object was last saved with

Show Source Code

taString taBase::GetFileNameFmProject ( taString& ext, taString& tag, taString& subdir, bool dmem_proc_no = false )

get file name from project file name -- useful for saving files associated with the project; ext = extension; tag = additional tag; subdir = additional directory after any existing in project name; fname = proj->base_name (subdir) + tag + ext; if dmem_proc_no, add dmem proc no to file name. empty if project not found

Show Source Code

taString taBase::GetProjDir ( )

get the directory path associated with the project that this object lives within

Show Source Code

int taBase::Load ( taString& fname, taBase** loaded_obj_ptr = __null )

Load object data from given file name (if empty, prompt user for a name) -- sets pointer to loaded obj if non-null: could actually load a different object than this (e.g. if this is a list or group)

Show Source Code

int taBase::Save ( )

saves the object to a file using current file name

Show Source Code

int taBase::SaveAs ( taString& fname )

Saves object data to a new file -- if fname is empty, the user is prompted with a file dialog

Show Source Code

bool taBase::SetFileName ( taString& val )

set file name for object

Show Source Code

Method Category: ListMgmt

taBase* taBase::CopyChildBefore ( taBase* src, taBase* child_pos )

implemented by container (list) objects: make a copy of the src object and insert it at the position of the child_pos object within this list -- copies the name of the object too

Show Source Code

taBase* taBase::CopyChildBeforeIndex ( taBase* src, int child_pos )

implemented by container (list) objects: make a copy of the src object and insert it at the position of the child_pos object within this list -- copies the name of the object too

Show Source Code

Method Category: ObjectMgmt

void taBase::CallFun ( taString& fun_name, taString& args_str )

call function (method) of given name on this object, using args as comma-separated simple literal expressions for argument values, or prompting for args using gui interface otherwise if needed

Show Source Code

void taBase::ChangeBaseFlag ( int flag, bool set )

sets or clears the flag(s)

Show Source Code

bool taBase::ChangeMyType ( TypeDef* new_type )

Change me into a different type of object, copying current info (done through owner)

Show Source Code

bool taBase::CheckConfig ( bool quiet = false )

check the configuration of this object and all its children (defaults to no confirm of success)

Show Source Code

bool taBase::CheckConfig_Gui ( bool confirm_success = true, bool quiet = false )

check the configuration of this object and all its children -- failed items highlighted in red, items with failed children in yellow

Show Source Code

bool taBase::CheckError ( bool test, bool quiet, bool& rval, taString& a, taString& b, taString& c, taString& d, taString& e, taString& f, taString& g, taString& h )

for CheckConfig routines: if test, then report config error, including object name, type, and path information; returns test & sets rval to false if test is true -- use e.g. CheckError((condition), quiet, rval, 'msg'));

Show Source Code

void taBase::ClearBaseFlag ( int flag )

clears the flag(s)

Show Source Code

void taBase::CloseLater ( )

PERMANENTLY Destroy this object! This is not Iconify or close window..

Show Source Code

bool taBase::CopyFrom ( taBase* cpy_from )

Copy from given object into this object (this is a safe interface to UnSafeCopy)

Show Source Code

bool taBase::CopyTo ( taBase* cpy_to )

Copy to given object from this object

Show Source Code

void taBase::DataUpdate ( bool begin )

bracket data value changes with (nestable) true/false calls;

Show Source Code

void taBase::DebugInfo ( taString& fun_name, taString& a, taString& b, taString& c, taString& d, taString& e, taString& f, taString& g, taString& h )

reports object identity in addition to the error message -- use this for any debug messages that get logged in reference to this object

Show Source Code

bool taBase::DerivesFromName ( taString& nm )

does this derive from given type name?

Show Source Code

bool taBase::DiffCompare ( taBase* cmp_obj )

compare this object with selected comparison object using a structured hierarchical diff operation -- pulls up a diff editor display to allow the user to view and merge the differences between objects

Show Source Code

taString taBase::DisplayPath ( )

get the path to this object for display purposes -- uses GetPathNames -- if under a program then that is used as starting point, otherwise returns a project relative path using GetPathFromProj -- other special cases may optimize as needed

Show Source Code

taBase* taBase::DuplicateMe ( )

Make another copy of myself (done through owner)

Show Source Code

taBase* taBase::FindFromPath ( taString& path, MemberDef*& ret_md, int start = 0 )

find object from path (starting from this object), and position to start (in characters) in the path string -- ret_md is return member def: if NULL and return is !NULL, then it is a member of a list or group, not a member in object

Show Source Code

void* taBase::FindMembeR ( taString& nm, MemberDef*& ret_md )

find member based on name or type, recursive -- does breadth-first then depth search -- returns pointer of member item, and ret_md is filled in if avail -- if NULL it indicates that it is an item in a list of type taBase and not a proper member

Show Source Code

taString taBase::GetEnumString ( taString& enum_tp_nm, int enum_val )

get the name corresponding to given enum value in enum type enum_tp_nm

Show Source Code

int taBase::GetEnumVal ( taString& enum_nm, taString& enum_tp_nm )

get the enum value corresponding to the given enum name (-1 if not found), and sets enum_tp_nm to name of type this enum belongs in (empty if not found)

Show Source Code

int taBase::GetIndex ( )

object's index within an owner list. cached by some objs.

Show Source Code

taBase* taBase::GetMemberOwner ( bool highest = false )

get the object that owns this object as a member -- if this object is not a member of its Owner (or has no owner) then it returns NULL -- if highest then it proceeds recursively up to the highest member owner and returns that -- i.e., if this is a member of a member (which is an object) of larger object, this will return the largest such object that contains this as a member at some level

Show Source Code

taString taBase::GetMemberStrVal ( taString& member )

get a string representation of the current value of given member of this object -- member_name can be a sub-path as well to a value within a member class

Show Source Code

taProject* taBase::GetMyProj ( )

get the project object that owns this object

Show Source Code

taString taBase::GetName ( )

Get the name of the object

Show Source Code

taBase* taBase::GetOwner ( TypeDef* td )

Show Source Code

taBase* taBase::GetParent ( )

typically the first non-list/group owner above this one

Show Source Code

taString taBase::GetPath ( taBase* par_stop = __null )

get path without name information, stop at parent given by par_stop if non-null (resulting path will NOT include the parent info -- it will start with a . and be findable from that parent using FindFromPath)

Show Source Code

taString taBase::GetPathFromProj ( )

call GetPathNames relative to owning project -- this is the best path to use for saving and setting paths within a project -- tabMisc::RootFindFromPath can use these project-relative paths in conjunction with the current project to find the relevant objects -- is robust to renaming of the project

Show Source Code

taString taBase::GetPathNames ( taBase* par_stop = __null )

get paths using string names instead of indexes, which is good for portability, stop at parent given by par_stop if non-null (resulting path will NOT include the parent info -- it will start with a . and be findable from that parent using FindFromPath)

Show Source Code

Variant taBase::GetValFromPath ( taString& path, MemberDef*& ret_md, bool warn_not_found = false )

get a member value from given path -- only follows direct members (of members) of this object -- does not look into items in lists or groups

Show Source Code

bool taBase::HasBaseFlag ( int flag )

true if flag set, or if multiple, any set

Show Source Code

bool taBase::HasName ( )

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

Show Source Code

bool taBase::InStructUpdate ( )

is object currently within a struct update already?

Show Source Code

bool taBase::InheritsFrom ( TypeDef* it )

does this inherit from given type

Show Source Code

bool taBase::InheritsFromName ( taString& nm )

does this inherit from given type name?

Show Source Code

bool taBase::IsChildOf ( taBase* obj )

true if this object is a direct or indirect child of the obj (or is the obj)

Show Source Code

bool taBase::IsParentOf ( taBase* obj )

true if this object is a direct or indirect parent of the obj (or is the obj)

Show Source Code

taString& taBase::ListSigClients ( taString& strm, int indent = 0 )

list all the data clients for this object to string

Show Source Code

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

taBase* taBase::New ( int n_objs = 1, TypeDef* type = __null, taString& name = (default name) )

Create n_objs objects of given type (type is optional)

Show Source Code

void taBase::OwnTempObj ( )

call own on this object with tabMisc::root as the owner -- this is important for temporary objects that don't otherwise live within the main structural hierarchy -- especially for DataTables, objects may not behave properly without being Own'd, as this then sets the owner pointers within the temporary object and calls InitLinks

Show Source Code

void taBase::PrintMyPath ( )

print out the path to this object to the css console -- can then be copied for use in a program or other such things

Show Source Code

void taBase::Search ( taString& srch, taBase_PtrList& items, taBase_PtrList* owners = __null, bool text_only = true, bool contains = true, bool case_sensitive = false, bool obj_name = true, bool obj_type = true, bool obj_desc = true, bool obj_val = true, bool mbr_name = true, bool type_desc = false )

search for objects using srch string (which is split by whitespace into separate terms if applicable -- all terms must match), from this point down the structural hierarchy (my members, and their members and objects in lists, etc). items are linked into items list, and all owners of items found are linked into owners list (if present -- can be used as a lookup table for expanding owners to browse found items). contains = use 'contains' for all matches instead of exact match, rest are values to search in (obj_desc includes DisplayName as well as any explicit description), obj_val is only for value members and inline members

Show Source Code

void taBase::SetBaseFlag ( int flag )

sets the flag(s)

Show Source Code

void taBase::SetMember ( taString& member, taString& value )

Set member to value for each of the selected objects. Member will be the member name or will be object_name.member_name, e.g. input_size.retina_size.x, replace any space with '_'

Show Source Code

bool taBase::SetName ( taString& nm )

Set the object's name

Show Source Code

void taBase::SigEmitUpdated ( )

send the ITEM_UPDATED data changed signal to indicate to gui elements etc that this item has been updated

Show Source Code

void taBase::StructUpdate ( bool begin )

bracket structural changes with (nestable) true/false calls;

Show Source Code

void taBase::UpdateAfterEdit ( )

(aka UAE) called after editing, or any user change to members (eg. in the interface, script)

Show Source Code

void taBase::UpdateAfterEdit_NoGui ( )

does any object-related updates based on changes, but does NOT trigger any gui updates -- use this for updating members inside of an object's UAE

Show Source Code

void taBase::UpdateAll ( )

call UpdateAfterEdit on this object and all of its members and sub-objects, recursively, unless the class has the NO_UPDATE_AFTER flag set

Show Source Code

void taBase::setDirty ( bool value )

set the dirty flag indicating a change in object values; 'true' gets forwarded up; 'false' does nothing

Show Source Code

void taBase::setStale ( )

set the stale flag indicating a change in object values; gets forwarded up ('true' is implied, only the impl obj defines when it is cleared)

Show Source Code

Method Category: UserData

void taBase::CopyUserData ( taBase& cp )

copy our user data from the user data on another object (replaces any of our existing user data with the copy)

Show Source Code

const Variant taBase::GetUserData ( taString& key )

get specified user data; returns class default value if not present, or nilVariant if no default user data or class doesn't support UserData

Show Source Code

bool taBase::HasUserData ( taString& key )

returns true if UserData exists for this key (case sens)

Show Source Code

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

bool taBase::RemoveUserData ( taString& key )

removes data for indicated key; returns true if it existed

Show Source Code

void taBase::SetDocLink ( taDoc* doc )

set a link to a doc from the .docs collection -- the doc will then show up automatically in a panel for this obj -- set to NULL to remove it

Show Source Code

UserDataItem* taBase::SetUserData ( taString& key, Variant& value, bool gui_notify_signal = true )

make new (or change existing) simple user data entry with given name and value; returns item, which can be ignored -- emits a gui notification signal which can be suppressed if needed for speed or other reasons

Show Source Code

void taBase::SetUserData_Gui ( taString& key, Variant& value, taString& desc )

make new (or change existing) simple user data entry with given name and value (desc optional) -- this is how to get User Data editor panel to show up the first time

Show Source Code

Method Category: _NoCategory

taBase* taBase::GetOwnerOfType ( TypeDef* td )

Show Source Code

TypeDef* taBase::GetTypeDef ( )

Show Source Code

void taBase::UpdatePointersAfterCopy_ ( taBase& cp )

Show Source Code

void taBase::UpdatePointersAfterCopy_impl ( taBase& cp )

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods

Static Method Category: ObjectMgmt


Static Method Documentation

Static Method Category: ObjectMgmt

void taBase::CallObjFun ( taBase* obj, taString& fun_name )   [static]

call function (method) of given name on given object, prompting for args using gui interface

Show Source Code

void taBase::SetMemberStr ( taBase* obj, taString& memb_name, taString& str )   [static]

set member value based on string value -- memb_name can be an arbitrary full path below the obj

Show Source Code

void taBase::SetMemberVar ( taBase* obj, taString& memb_name, Variant& val )   [static]

set member value based on variant -- memb_name can be an arbitrary full path below the obj

Show Source Code

Expert Member and Method Documentation

Expert Members

Expert Member Category: taBase

Expert Methods

Expert Method Category: Access

Expert Method Category: Display

Expert Method Category: File

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: taBase

taBase::base_flags : taBase::BaseFlags

base_flags for ta system


Expert Method Documentation

Expert Method Category: Access

taMatrix* taBase::ElView ( )

View of list -- matrix that specifies a subset of items to view, for display and other kinds of functions

Show Source Code

taBase::IndexMode taBase::ElViewMode ( )

View mode for view of list -- specifies what kind of view data there is, for display and other kinds of functions -- only valid cases are IDX_COORDS or IDX_MASK, or IDX_UNK if no view specified

Show Source Code

int taBase::ElemCount ( )

number of elements in the container -- used for iteration control

Show Source Code

taBase::IndexMode taBase::IndexModeDecode ( Variant& idx, int cont_dims )

decode index mode from variant index, and number of dimensions in the container object

Show Source Code

bool taBase::IndexModeValidate ( Variant& idx, taBase::IndexMode md, int cont_dims )

validate that the index is of an appopriate configuration for given index mode -- issues appropriate error messages if not good

Show Source Code

Expert Method Category: Display

void taBase::WindowHideHook ( )

this is called when a top-level window that represents this object becomes invisible

Show Source Code

void taBase::WindowShowHook ( )

this is called when a top-level window that represents this object becomes visible

Show Source Code

Expert Method Category: File

int taBase::Load_String ( taString& load_str, taBase* par = __null, taBase** loaded_obj_ptr = __null )

load full object information from a string, which should have been generated through a corresponding Save_String call -- must contain the exact information that would be saved to a file for Save_strm -- just a string-stream (sstream) wrapper around Load_strm

Show Source Code

int taBase::Load_strm ( istream& strm, taBase* par = __null, taBase** loaded_obj_ptr = __null )

Load object data from a file -- sets pointer to loaded obj if non-null: could actually load a different object than this (e.g. if this is a list or group)

Show Source Code

int taBase::Save_String ( taString& save_str, taBase* par = __null, int indent = 0 )

dump full object save information to a string, which contains the exact information that would be saved to a file for Save_strm -- just a string-stream (sstream) wrapper around Save_strm

Show Source Code

int taBase::Save_strm ( ostream& strm, taBase* par = __null, int indent = 0 )

Save object data to a file stream

Show Source Code

Expert Method Category: UserData

taDoc* taBase::GetDocLink ( )

gets a linked Doc, if any; you can use this to test for existence

Show Source Code

bool taBase::GetUserDataAsBool ( taString& key )

get specified user data as bool (see GetUserData)

Show Source Code

double taBase::GetUserDataAsDouble ( taString& key )

get specified user data as double (see GetUserData)

Show Source Code

float taBase::GetUserDataAsFloat ( taString& key )

get specified user data as float (see GetUserData)

Show Source Code

int taBase::GetUserDataAsInt ( taString& key )

get specified user data as int (see GetUserData)

Show Source Code

const taString taBase::GetUserDataAsString ( taString& key )

get specified user data as String (see GetUserData)

Show Source Code

const Variant taBase::GetUserDataDef ( taString& key, Variant& def )

return value if exists, or default if doesn't

Show Source Code

UserDataItem_List* taBase::GetUserDataList ( bool force_create = false )

gets the userdatalist for this class

Show Source Code

UserDataItemBase* taBase::GetUserDataOfType ( TypeDef* typ, taString& key, bool force_create )

gets specified user data of given type, making one if doesn't exist and fc=true

Show Source Code

bool taBase::HasUserDataList ( )

returns true if UserData exists at al

Show Source Code


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