UF_NCGEOM_create (view source)
 
Defined in: uf_ncgroup.h
 
Overview
Create a new UF_NCGROUP object which is a UF_NCGEOM Group object.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGEOM_create
(
char * type_name,
char * subtype_name,
tag_t * new_object
)
char *type_nameInput- the type name of the object to create
char *subtype_nameInput- the subtype name of the object to create
tag_t *new_objectOutput- the newly created object

 

 
UF_NCGROUP_accept_member (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function adds 'member' to the member list of 'parent'. It will become
the last object in the member list. If 'parent' can not accept 'member' as
a member and error will be returned.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_accept_member
(
tag_t parent,
tag_t member
)
tag_tparentInput- see above
tag_tmemberInput- see above

 

 
UF_NCGROUP_ask_member_in_list (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function returns the object which is the 'index'th member of 'parent's
member list. The object is returned in 'member'.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_ask_member_in_list
(
tag_t parent,
int index,
tag_t * member
)
tag_tparentInput- see above
intindexInput- see above
tag_t *memberOutput- see above

 

 
UF_NCGROUP_ask_member_list (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function returns the list of objects which are contained in the specified
group.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_ask_member_list
(
tag_t obj_tag,
int * count,
tag_t * * list
)
tag_tobj_tagInput- the group
int *countOutput- the number of objects in the group
tag_t * *listOutput to UF_*free*- the list of objects in the group. This should
be freed by calling UF_free.

 

 
UF_NCGROUP_ask_object_of_name (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function searches the member list of 'obj_tag' for an object with name
'name'. If one is found, it's tag is returned in 'obj_with_name'. If no such
object is found then NULL is returned in 'obj_with_name'.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_ask_object_of_name
(
tag_t obj_tag,
char * name,
tag_t * obj_with_name
)
tag_tobj_tagInput- see above
char *nameInput- see above
tag_t *obj_with_nameOutput- see above

 

 
UF_NCGROUP_ask_root_of_object (view source)
 
Defined in: uf_ncgroup.h
 
Overview
For the group 'obj_tag' this function returns the tag of the object which
is the root object of it's view. This will be either a UF_NCGEOM, UF_NCPROG,
UF_NCMCT or UF_MCMTHD object.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_ask_root_of_object
(
tag_t obj_tag,
tag_t * root_tag
)
tag_tobj_tagInput- see above
tag_t *root_tagOutput- see above

 

 
UF_NCGROUP_can_accept_member (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function returns TRUE if the group 'obj1' can accept 'obj2' as a
member. If the answer is FALSE the reason may be found in 'reason'.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_can_accept_member
(
tag_t obj1,
tag_t obj2,
logical * answer,
char reason [ UF_NCGROUP_MAX_REASON_BUFSIZE ]
)
tag_tobj1Input- the group
tag_tobj2Input- can this object be placed into the group
logical *answerOutput- see above
charreason [ UF_NCGROUP_MAX_REASON_BUFSIZE ] Output- see above

 

 
UF_NCGROUP_cycle_members (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function iterates the members of group 'group'. For every object which
is a member of 'group's member list it makes the call:

continue = cb( tag of member object, data );

See the documentation for UF_NCGROUP_cycle_cb_f_t in this file for more
information on the callback 'cb'.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_cycle_members
(
tag_t group,
UF_NCGROUP_cycle_cb_f_t cb,
void * data
)
tag_tgroupInput- see above
UF_NCGROUP_cycle_cb_f_tcbInput- see above
void *dataInput- see above

 

 
UF_NCGROUP_insert_member (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function adds 'member' to the member list of 'parent'. If 'sibling' is
NULL then add 'member' as the last member of 'parent's member list. If
'sibling' is not NULL then if 'where' is UF_NCGROUP_POSITION_BEFORE it adds
'member' to 'parent's member list immediately before 'sibling'.
If 'sibling' is not NULL then if 'where' is UF_NCGROUP_POSITION_AFTER it adds
'member' to 'parent's member list immediately after 'sibling'.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_insert_member
(
tag_t parent,
tag_t member,
tag_t sibling,
UF_NCGROUP_position_t where
)
tag_tparentInput- see above
tag_tmemberInput- see above
tag_tsiblingInput- see above
UF_NCGROUP_position_twhereInput- see above

 

 
UF_NCGROUP_is_a_member (view source)
 
Defined in: uf_ncgroup.h
 
Overview
This function returns TRUE if object 'member' is part of the group 'group'.
If the answer is TRUE then 'index' is the index of 'member' in group. The
index is the position of 'member' in the group's member list. Indices go
from 0 to n-1 where n is the number of objects in the member list.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_is_a_member
(
tag_t group,
tag_t member,
logical * answer,
int * index
)
tag_tgroupInput- see above
tag_tmemberInput- see above
logical *answerOutput- see above
int *indexOutput- see above

 

 
UF_NCGROUP_is_group (view source)
 
Defined in: uf_ncgroup.h
 
Overview
Given an object tag, this function reports if it is a UF_NCGROUP object.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCGROUP_is_group
(
tag_t obj_tag,
logical * answer
)
tag_tobj_tagInput- the object being asked about
logical *answerOutput- TRUE if object is a UF_NCGROUP object, FALSE
otherwise

 

 
UF_NCMTHD_create (view source)
 
Defined in: uf_ncgroup.h
 
Overview
Create a new UF_NCGROUP object which is a UF_NCMTHD Group object.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCMTHD_create
(
char * type_name,
char * subtype_name,
tag_t * new_object
)
char *type_nameInput- the type name of the object to create
char *subtype_nameInput- the subtype name of the object to create
tag_t *new_objectOutput- the newly created object

 

 
UF_NCPROG_create (view source)
 
Defined in: uf_ncgroup.h
 
Overview
Create a new UF_NCGROUP object which is a UF_NCPROG Group object.

Environment
Internal and External

History
Originally released in V16.0

 
int UF_NCPROG_create
(
char * type_name,
char * subtype_name,
tag_t * new_object
)
char *type_nameInput- the type name of the object to create
char *subtype_nameInput- the subtype name of the object to create
tag_t *new_objectOutput- the newly created object