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

Schedule Class Reference

A schedule for parameters that vary over time

See for more info: Wiki Docs For: Schedule

 #include <Schedule>

defined at: /mnt/ssd/grey/local/include/Emergent/Schedule.h :57-80

Inherits From: taList, taList_impl, taNBase, taOBase, taBase, taPtrList_base, taPtrList_impl

Inherited By: Schedule*, Schedule&, const Schedule

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

Member Category: taList

Methods

Method Category: Access

Method Category: ControlPanel

Method Category: Copy

Method Category: Display

Method Category: File

Method Category: ListMgmt

Method Category: Modify

Method Category: ObjectMgmt

Method Category: Order

Method Category: UserData

Method Category: _NoCategory

Method Category: taList


Member Documentation

Member Category: _NoCategory

Schedule::default_val : float

the default if group is empty

Schedule::interpolate : bool

use linear interpolation between points

Schedule::last_ctr : int

the last counter index called

Member Category: taBase

taNBase::name : taString

name of the object

Member Category: taList

taList_impl::el_typ : TypeDef*

Default type for objects in group

Schedule::size : int

number of elements in the list


Method Documentation

Method Category: Access

SchedItem* taList_SchedItem_::DefaultEl ( )

returns the element specified as the default for this list

Show Source Code

SchedItem* taList_SchedItem_::Edit_El ( SchedItem* item )

Edit given list item

Show Source Code

Variant taList_impl::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* taList_impl::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

SchedItem* taList_SchedItem_::FastEl ( int i )

fast element (no range checking) -- if index is negative, access is from the back of the list (-1 = last item, -2 = second to last, etc)

Show Source Code

int taList_impl::FindEl ( taBase* item )

find element in list (-1 if not there)

Show Source Code

SchedItem* taList_SchedItem_::FindName ( taString& item_nm )

Find element with given name (item_nm)

Show Source Code

SchedItem* taList_SchedItem_::FindNameContains ( taString& item_nm )

Find element whose name contains given name sub-string

Show Source Code

int taList_impl::FindNameContainsIdx ( taString& item_nm )

Find index of (first) element whose name contains given name sub-string (-1 = nonot found)

Show Source Code

int taList_impl::FindNameIdx ( taString& it )

return the index of the item with given name on the list

Show Source Code

SchedItem* taList_SchedItem_::FindNameType ( taString& item_nm )

Find element with given object name or type name (item_nm)

Show Source Code

int taList_impl::FindNameTypeIdx ( taString& item_nm )

Find index of (first) element with given object name or type name (item_nm) (-1 if not found)

Show Source Code

SchedItem* taList_SchedItem_::FindType ( TypeDef* item_tp )

find given type element (NULL = not here), sets idx

Show Source Code

int taList_impl::FindTypeIdx ( TypeDef* item_tp )

find index of (first) element that inherits from given type (-1 = not found)

Show Source Code

SchedItem* taList_SchedItem_::First ( )

look at the first element; NULL if none

Show Source Code

bool taList_impl::IsContainer ( )

is this item a container object or not?

Show Source Code

bool taList_impl::IsEmpty ( )

is the list empty of elements (i.e., size == 0)

Show Source Code

int taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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

SchedItem* taList_SchedItem_::Peek ( )

peek at the last element on the stack, if any

Show Source Code

SchedItem* taList_SchedItem_::SafeEl ( int idx )

get element at index -- does safe range checking -- if index is negative, access is from the back of the list (-1 = last item, -2 = second to last, etc)

Show Source Code

int taList_impl::SetDefaultEl ( taBase* it )

set the default element to be given item

Show Source Code

int taList_impl::SetDefaultElName ( taString& nm )

set the default element to be item with given name

Show Source Code

int taList_impl::SetDefaultElType ( TypeDef* it )

set the default element to be item with given type

Show Source Code

Method Category: ControlPanel

bool taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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* taList_impl::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: Copy

void taList_impl::Borrow ( taPtrList_impl& cp )

borrow (link) elements of given list into this one

Show Source Code

void taList_impl::BorrowUniqNameNew ( taPtrList_impl& cp )

borrow so result is unique names, replacing with new ones where dupl

Show Source Code

void taList_impl::BorrowUniqNameOld ( taPtrList_impl& cp )

borrow so result is unique names, using old ones where dupl

Show Source Code

void taList_impl::BorrowUniqNameOldFirst ( taPtrList_impl& cp )

borrow so result is unique names, using old ones where dupl, inserting new ones first (in order) on the list

Show Source Code

void taList_impl::BorrowUnique ( taPtrList_impl& cp )

borrow so result is unique list

Show Source Code

void taList_impl::Copy_Borrow ( taPtrList_impl& cp )

apply copy operator to items, use borrow to add new ones from cp (if necc)

Show Source Code

void taList_impl::Copy_Common ( taPtrList_impl& cp )

apply copy operator to only those items in common between the two lists

Show Source Code

void taList_impl::Copy_Duplicate ( taPtrList_impl& cp )

apply copy operator to items, use duplicate to add new ones from cp (if necc)

Show Source Code

void taList_impl::Copy_Exact ( taPtrList_impl& cp )

makes us basically identical to cp, in number, and type

Show Source Code

void taList_impl::DupeUniqNameNew ( taPtrList_impl& cp )

duplicate so result is unique names, replacing with new ones where dupl

Show Source Code

void taList_impl::DupeUniqNameOld ( taPtrList_impl& cp )

duplicate so result is unique names, using old ones where dupl

Show Source Code

void taList_impl::Duplicate ( taPtrList_impl& cp )

duplicate (clone & add) elements of given list into this one

Show Source Code

void taList_impl::Stealth_Borrow ( taPtrList_impl& cp )

borrow without referencing the borrowed elements (i.e. use AddEl_())

Show Source Code

Method Category: Display

void taList_impl::BrowseMe ( )

show this object in its own browser

Show Source Code

bool taList_impl::BrowserCollapseAll ( )

collapse all sub-leaves under this item in the browser

Show Source Code

bool taList_impl::BrowserEditMe ( )

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

Show Source Code

bool taList_impl::BrowserExpandAll ( )

expand all sub-leaves under this item in the browser

Show Source Code

bool taList_impl::BrowserSelectMe ( )

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

Show Source Code

bool taList_impl::ChooseMe ( )

Display a chooser of whatever type this method is called on

Show Source Code

taString taList_impl::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 taList_impl::Edit ( )

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

Show Source Code

bool taList_impl::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* taList_impl::GetMyBrowser ( )

get the project browser for this object's project owner

Show Source Code

bool taList_impl::GuiFindFromMe ( taString& find_str )

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

Show Source Code

void taList_impl::Help ( )

get help on using this object

Show Source Code

bool taList_impl::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& taList_impl::Print ( taString& strm, int indent = 0 )

print the value of the object to given string

Show Source Code

taString taList_impl::PrintStr ( int indent = 0 )

print the value of the object to a string

Show Source Code

void taList_impl::RebuildAllViews ( )

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

Show Source Code

void taList_impl::UpdateAllViews ( )

called after data changes, to update views

Show Source Code

Method Category: File

taString taList_impl::GetFileName ( )

get file name object was last saved with

Show Source Code

taString taList_impl::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 taList_impl::GetProjDir ( )

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

Show Source Code

int taList_impl::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 taList_impl::Save ( )

saves the object to a file using current file name

Show Source Code

int taList_impl::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 taList_impl::SetFileName ( taString& val )

set file name for object

Show Source Code

Method Category: ListMgmt

taBase* taList_impl::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* taList_impl::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: Modify

void taList_impl::Add ( taBase* item )

add element to the list and 'own' item

Show Source Code

void taList_impl::AddOnly ( taBase* item )

append a new pointer to end of list -- does not own

Show Source Code

bool taList_impl::AddUniqNameNew ( taBase* item )

add so that name is unique, true if unique, new replaces existing

Show Source Code

SchedItem* taList_SchedItem_::AddUniqNameOld ( SchedItem* item )

add so that name is unique, old used if dupl, returns one used

Show Source Code

bool taList_impl::AddUnique ( taBase* item )

add so that object is unique, true if unique

Show Source Code

void taList_impl::BuildHashTable ( int n_buckets, taPtrList_impl::KeyType key_typ = KT_NAME )

build a hash table with given number of buckets and key type (not dynamic, so make it big)

Show Source Code

bool taList_impl::ChangeType ( taBase* itm, TypeDef* new_type )

change type of item to new type, copying current info

Show Source Code

taBase* taList_impl::DuplicateEl ( taBase* item )

Duplicate given list item and Add to list

Show Source Code

void taList_impl::EnforceSameStru ( taList_impl& cp )

make the two lists identical in terms of size and types of objects

Show Source Code

void taList_impl::EnforceType ( )

enforce current type (all elements have to be of this type)

Show Source Code

SchedItem* taList_SchedItem_::FindMakeNameType ( taString& item_nm, TypeDef* td, bool& made_new )

find an object with the given name and type (if not NULL) -- if not found or type was different, makes a new one and sets made_new = true -- in any case returns object

Show Source Code

bool taList_impl::Insert ( taBase* item, int where )

insert element at index (-1 for end)

Show Source Code

bool taList_impl::InsertLink ( taBase* item, int idx = -1 )

Insert a link at index (-1 for end)

Show Source Code

void taList_impl::Link ( taBase* item )

Link an item to list without owning it

Show Source Code

bool taList_impl::LinkUniqNameNew ( taBase* item )

link so that name is unique, true if unique, new replaces existing

Show Source Code

SchedItem* taList_SchedItem_::LinkUniqNameOld ( SchedItem* item )

link so that name is unique, old used if dupl, returns one used

Show Source Code

bool taList_impl::LinkUnique ( taBase* item )

link so that object is unique, true if unique

Show Source Code

bool taList_impl::MoveAfter ( taBase* trg, taBase* item )

move item so that it appears just after the target item trg in the list

Show Source Code

bool taList_impl::MoveBefore ( taBase* trg, taBase* item )

move item so that it appears just before the target item trg in the list

Show Source Code

bool taList_impl::MoveBeforeIdx ( int from, int to )

Move element from index (from) to just before position (to) in list; for end, use to=-1 or size

Show Source Code

bool taList_impl::MoveEl ( taBase* from, taBase* to )

Move item (from) to position of (to)

Show Source Code

bool taList_impl::MoveIdx ( int from, int to )

Move element from index (from) to position (to) in list

Show Source Code

taBase* taList_impl::New_gui ( int n_objs = 1, TypeDef* typ = __null, taString& name = (default name) )

create n_objs new objects of given type in list (typ=NULL: default type, el_typ;)

Show Source Code

SchedItem* taList_SchedItem_::Pop ( )

pop the last element off the stack

Show Source Code

void taList_impl::PopAll ( )

pop all elements off the stack

Show Source Code

void taList_impl::Push ( taBase* item )

push item on stack (for temporary use, not 'owned')

Show Source Code

void taList_impl::ReBuildHashTable ( )

re-build existing hash table for all items on the list

Show Source Code

void taList_impl::RemoveAll ( )

Remove all elements on the list

Show Source Code

bool taList_impl::RemoveEl ( taBase* item )

Remove given item from list

Show Source Code

void taList_impl::RemoveHashTable ( )

remove any existing hash table

Show Source Code

bool taList_impl::RemoveIdx ( int idx )

remove (and delete) element from list at index

Show Source Code

bool taList_impl::RemoveLast ( )

remove the last element on the list

Show Source Code

bool taList_impl::RemoveName ( taString& item_nm )

remove (and delete) named element from list

Show Source Code

bool taList_impl::ReplaceEl ( taBase* old_it, taBase* new_it )

replace given element with the new one

Show Source Code

bool taList_impl::ReplaceIdx ( int old_idx, taBase* new_it )

replace element at index with the new one

Show Source Code

bool taList_impl::ReplaceLinkEl ( taBase* old_it, taBase* new_it )

replace given element (if on list) with the new one

Show Source Code

bool taList_impl::ReplaceLinkIdx ( int old_idx, taBase* new_it )

replace element with a link to the new one

Show Source Code

bool taList_impl::ReplaceLinkName ( taString& old_nm, taBase* new_it )

replace given named element (if on list) with the new one

Show Source Code

bool taList_impl::ReplaceName ( taString& old_nm, taBase* new_it )

replace named element with the new one

Show Source Code

int taList_impl::ReplaceType ( TypeDef* old_type, TypeDef* new_type )

replace all items of old type with new type (returns number changed)

Show Source Code

void taList_impl::Reset ( )

reset the list (remove all elements)

Show Source Code

void taList_impl::SetBaseType ( TypeDef* it )

set base (and default) type to given td

Show Source Code

void taList_impl::SetSize ( int sz )

add or remove elements to force list to be of given size

Show Source Code

bool taList_impl::SwapIdx ( int pos1, int pos2 )

Swap the elements in the two given positions on the list

Show Source Code

Method Category: ObjectMgmt

void taList_impl::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 taList_impl::ChangeBaseFlag ( int flag, bool set )

sets or clears the flag(s)

Show Source Code

bool taList_impl::ChangeMyType ( TypeDef* new_type )

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

Show Source Code

bool taList_impl::CheckConfig ( bool quiet = false )

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

Show Source Code

bool taList_impl::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 taList_impl::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 taList_impl::ClearBaseFlag ( int flag )

clears the flag(s)

Show Source Code

void taList_impl::CloseLater ( )

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

Show Source Code

bool taList_impl::CopyFrom ( taBase* cpy_from )

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

Show Source Code

bool taList_impl::CopyTo ( taBase* cpy_to )

Copy to given object from this object

Show Source Code

void taList_impl::DataUpdate ( bool begin )

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

Show Source Code

void taList_impl::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 taList_impl::DerivesFromName ( taString& nm )

does this derive from given type name?

Show Source Code

bool taList_impl::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 taList_impl::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* taList_impl::DuplicateMe ( )

Make another copy of myself (done through owner)

Show Source Code

taBase* taList_impl::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* taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::GetIndex ( )

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

Show Source Code

taBase* taList_impl::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 taList_impl::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* taList_impl::GetMyProj ( )

get the project object that owns this object

Show Source Code

taString taList_impl::GetName ( )

Get the name of the object

Show Source Code

taBase* taList_impl::GetParent ( )

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

Show Source Code

taString taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::HasBaseFlag ( int flag )

true if flag set, or if multiple, any set

Show Source Code

bool taList_impl::HasName ( )

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

Show Source Code

bool taList_impl::InStructUpdate ( )

is object currently within a struct update already?

Show Source Code

bool taList_impl::InheritsFrom ( TypeDef* it )

does this inherit from given type

Show Source Code

bool taList_impl::InheritsFromName ( taString& nm )

does this inherit from given type name?

Show Source Code

bool taList_impl::IsChildOf ( taBase* obj )

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

Show Source Code

bool taList_impl::IsParentOf ( taBase* obj )

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

Show Source Code

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

list all the data clients for this object to string

Show Source Code

void taList_impl::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* taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::SetBaseFlag ( int flag )

sets the flag(s)

Show Source Code

void taList_impl::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 taList_impl::SetName ( taString& nm )

Set the object's name

Show Source Code

void taList_impl::SigEmitUpdated ( )

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

Show Source Code

void taList_impl::StructUpdate ( bool begin )

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

Show Source Code

void taList_impl::UpdateAfterEdit ( )

(aka UAE) called after editing, or any user change to members (eg. in the interface, script) we skip the taOBase version, and inherit only taBase (DPF: what does that mean?)

Show Source Code

void taList_impl::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 taList_impl::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 taList_impl::setDirty ( bool value )

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

Show Source Code

void taList_impl::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: Order

void taList_impl::Permute ( int thr_no = -1 )

permute the items in the list into a random order -- (0 <= thr_no < 100) specifies thread or dmem proc number for parallel safe random sequences (-1 = taMisc::dmem_proc for auto-safe dmem)

Show Source Code

void taList_impl::Sort ( bool descending = false )

sort the items in the list in alpha order according to name (or El_Compare_)

Show Source Code

Method Category: UserData

void taList_impl::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 taList_impl::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 taList_impl::HasUserData ( taString& key )

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

Show Source Code

void taList_impl::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 taList_impl::RemoveUserData ( taString& key )

removes data for indicated key; returns true if it existed

Show Source Code

void taList_impl::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* taList_impl::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 taList_impl::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

bool taList_impl::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* taList_impl::GetOwner ( )

Show Source Code

taBase* taList_impl::GetOwnerOfType ( TypeDef* td )

Show Source Code

TypeDef* Schedule::GetTypeDef ( )

Show Source Code

float Schedule::GetVal ( int ctr )

get current schedule val, based on counter

Show Source Code

bool taList_impl::IsAcceptable ( taBase* candidate )

is this candidate item acceptable for this list - subclasses can implement for list specific use - ProgEl_List does

Show Source Code

void Schedule::SortItems ( )

sorts the items according to start_ctr -- called automatically in UAE

Show Source Code

bool taList_impl::Transfer ( taBase* item )

Show Source Code

void Schedule::UpdateDurations ( )

update the durations based on counter intervals -- called automatically in UAE

Show Source Code

void taList_impl::UpdatePointersAfterCopy_ ( taBase& cp )

Show Source Code

void taList_impl::UpdatePointersAfterCopy_impl ( taBase& cp )

Show Source Code

taSigLink** taList_impl::addr_sig_link ( )

Show Source Code

Method Category: taList

bool taList_impl::MakeElNameUnique ( taBase* itm )

make sure name of given item on this list is unique -- will change only the name of this item to ensure uniqueness (does not check other items against other items)

Show Source Code

bool taList_impl::MakeElNamesUnique ( )

make all of the element names in the list unique -- returns true if all unique already

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods

Static Method Category: ObjectMgmt


Static Method Documentation

Static Method Category: ObjectMgmt

void taList_impl::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 taList_impl::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 taList_impl::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: _NoCategory

Expert Member Category: taBase

Expert Member Category: taList

Expert Methods

Expert Method Category: Access

Expert Method Category: Display

Expert Method Category: File

Expert Method Category: Modify

Expert Method Category: ObjectMgmt

Expert Method Category: UserData


Expert Member Documentation

Expert Member Category: _NoCategory

Schedule::cur_val : float

the current val

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 Member Category: taList

Schedule::alloc_size : int

allocation size

taList_impl::el_base : TypeDef*

Base type for objects in group

taList_impl::el_def : int

Index of default element in group

taList_impl::el_view : taBasePtr

matrix with indicies providing view into items in this list, if set -- determines the items and the order in which they are presented for the iteration operations -- otherwise ignored in other contexts

taList_impl::el_view_mode : taBase::IndexMode

what kind of information is present in el_view to determine view mode -- only valid cases are IDX_COORDS and IDX_MASK

Schedule::hash_table : taHashTable*

a hash table (NULL if not used)

Schedule::is_transfer : bool

set to true at start of transfer, false when done - allows list to differentiate delete from transfer to another list


Expert Method Documentation

Expert Method Category: Access

taMatrix* taList_impl::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 taList_impl::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 taList_impl::ElemCount ( )

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

Show Source Code

taBase* taList_impl::ElemLeaf ( int leaf_idx )

return a terminal (leaf) element of the list -- this is interface used for iteration and elem generic accessor functionality

Show Source Code

void* taList_impl::FirstEl ( int& itr )

get the first item on the list, initialize iterator

Show Source Code

bool taList_impl::InRange ( int idx )

is the specified index within range of 0 >= idx < size

Show Source Code

int taList_impl::Index ( int idx )

get actual index from index value that can also be negative, meaning access from end of list

Show Source Code

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

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

Show Source Code

bool taList_impl::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

taList_impl* taList_impl::NewElView ( taMatrix* view_mat, taBase::IndexMode md = IDX_COORDS )

make a new view of this list -- returns a new pointer list with view set

Show Source Code

void* taList_impl::NextEl ( int& itr )

get the next item on the list according to iterator

Show Source Code

bool taList_impl::SetElView ( taMatrix* view_mat, taBase::IndexMode md = IDX_COORDS )

set el view to given new case -- just sets the members

Show Source Code

Variant taList_impl::VarEl ( int idx )

get element at index as a Variant -- does safe range checking -- if index is negative, access is from the back of the list (-1 = last item, -2 = second to last, etc) - this uses LeafElem interface and is thus fully generic

Show Source Code

Expert Method Category: Display

void taList_impl::WindowHideHook ( )

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

Show Source Code

void taList_impl::WindowShowHook ( )

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

Show Source Code

Expert Method Category: File

int taList_impl::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 taList_impl::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 taList_impl::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 taList_impl::Save_strm ( ostream& strm, taBase* par = __null, int indent = 0 )

Save object data to a file stream

Show Source Code

Expert Method Category: Modify

bool taList_impl::Alloc ( int sz )

allocate a list big enough for given number of elements (or current size) -- uses optimized memory allocation policies and generally allocates more than currently needed

Show Source Code

bool taList_impl::AllocExact ( int sz )

allocate exact number specified

Show Source Code

Expert Method Category: ObjectMgmt

void taList_impl::LinkCopyLeaves ( taList_impl& cp )

create links in this list to all terminal leaf items in source list (i.e., Borrow) -- this is used for creating shallow container copies with different views -- does NOT copy full hierarchical substructure or anything -- just links leaves for accessor routines

Show Source Code

Expert Method Category: UserData

taDoc* taList_impl::GetDocLink ( )

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

Show Source Code

bool taList_impl::GetUserDataAsBool ( taString& key )

get specified user data as bool (see GetUserData)

Show Source Code

double taList_impl::GetUserDataAsDouble ( taString& key )

get specified user data as double (see GetUserData)

Show Source Code

float taList_impl::GetUserDataAsFloat ( taString& key )

get specified user data as float (see GetUserData)

Show Source Code

int taList_impl::GetUserDataAsInt ( taString& key )

get specified user data as int (see GetUserData)

Show Source Code

const taString taList_impl::GetUserDataAsString ( taString& key )

get specified user data as String (see GetUserData)

Show Source Code

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

return value if exists, or default if doesn't

Show Source Code

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

gets the userdatalist for this class

Show Source Code

UserDataItemBase* taList_impl::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 taList_impl::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