ics.h File Reference

#include <pom/pom/pom.h>
#include <sa/sa.h>
#include <ics/ics_enquiry.h>
#include <ics/ics_errors.h>
#include <ics/libics_exports.h>
#include <ics/iman_ics.h>
#include <ics/libics_undef.h>

Go to the source code of this file.

Typedefs
typedef enum ICS_objectType_s *	ICS_ObjectType_p_t
typedef enum ICS_objectType_s	ICS_objectType_t

Enumerations
enum	ICS_objectType_s {   ICS_ObjectType_unknown = 0, ICS_ObjectType_keylov = ( 1 << 0 ), ICS_ObjectType_attribute = ( 1 << 1 ), ICS_ObjectType_class = ( 1 << 2 ),   ICS_ObjectType_view = ( 1 << 3 ), ICS_ObjectType_instance = ( 1 << 4 ), ICS_ObjectType_userclass = ( 1 << 5 ), ICS_ObjectType_all,   ICS_ObjectType_max }
enum	ICS_type_t {   ICS_type_unknown, ICS_type_group, ICS_type_class, ICS_type_class_attr,   ICS_type_view, ICS_type_view_attr, ICS_type_unctdict, ICS_type_stxt,   ICS_type_data, ICS_type_abstract_class, ICS_type_storrage_class }

Functions
ICS_API int	ICS_ask_image (tag_t groupOrClassOrView, tag_t *datasetTag)
ICS_API int	ICS_ask_instances_by_id (const char *theIcoId, int *theCount, tag_t **theInstanceTags)
ICS_API int	ICS_cancel_ico_by_rtico (tag_t objTag)
ICS_API int	ICS_classid_is_valid (char *cid, char *sid, logical *valid)
ICS_API int	ICS_exit_module ()
ICS_API int	ICS_format_value (int howToFormat, int theFormat, const char *theMinValue, const char *theMaxValue, const char *theValue, char **theFormattedValue)
ICS_API int	ICS_init_hooks ()
ICS_API int	ICS_init_module ()
ICS_API int	ICS_is_tag_ics_runtime_obj (tag_t obj, logical *is_an_ics_rt_obj)
ICS_API int	ICS_receive_obj_created_from_nxmgr (tag_t item_tag, tag_t itemrev_tag, tag_t dataset_tag, int creation_type)
ICS_API int	ICS_resolve_attribute_id (tag_t wso, int attr_id, int vla_pos, tag_t *prop_tag, tag_t *type_tag)
ICS_API int	ICS_resolve_ico_id (tag_t wso, int ico_index, tag_t *prop_tag, tag_t *type_tag)
ICS_API int	ICS_save_ico_by_rtico (tag_t attrSyncTag)
ICS_API int	ICS_share_pending (int theSitesCount, const char **theSites, int theverbosity)
Group/Class/View Functions
Common Return Values: ICS_invalid_class Class tag passed is not a valid tag ICS_invalid_class_id Id passed is not a valid Id. ICS_invalid_tag Tag passed is not a valid tag ICS_invalid_view View tag passed is not a valid tag ICS_invalid_view_id View id passed is not a valid ID
ICS_API int	ICS_ask_top_class (tag_t *topClass)
ICS_API int	ICS_find_class (const char *groupOrClassId, tag_t *groupOrClass)
ICS_API int	ICS_ask_id_name (tag_t groupOrClassOrView, char **id, char **name)
ICS_API int	ICS_find_view (tag_t theClass, const char *viewId, tag_t *view)
ICS_API int	ICS_ask_children (tag_t groupOrClass, int *nChildren, tag_t **children)
ICS_API int	ICS_ask_parent (tag_t theChid, tag_t *theParent)
ICS_API int	ICS_ask_instances (tag_t theClass, tag_t view, int *nInstances, tag_t **instances)
ICS_API int	ICS_ask_instance_count (const char *ClassOrViewId, int *nInstances)
ICS_API int	ICS_search_instances (tag_t theClass, tag_t view, int nAttributes, int *attributeUncts, char **queries, int *nInstances, tag_t **instances)
ICS_API int	ICS_search_object_ids (tag_t theClass, tag_t view, char *query, int *nInstances, tag_t **instances)
ICS_API int	ICS_ask_attributes (tag_t classOrView, int *nAttributes, tag_t **attributeList)
ICS_API int	ICS_describe_view (tag_t view, int *nAttributes, int **theAttrIDs, int **theAttrFormats, char ***theAttrAnnotations, char ***theAttrNames, char ***theAttrShortNames, char ***theAttrUnits, char ***theUserData1, char ***configField, char ***theUserData2, int **theFlags)
ICS_API int	ICS_describe_config_field (const char *configFieldString, int *multiField, logical *horizontal, logical *vertical, logical *separator, logical *arrow, logical *button, logical *wide, logical *mandatoryFlag, logical *protectedFlag, logical *uniqueFlag)
ICS_API int	ICS_create_view_attributes (tag_t view, int nAttributes, const char **attributeNames, tag_t **attributes)
ICS_API int	ICS_create_class_attributes (tag_t theClass, int nAttributes, int *unctNumbers, tag_t **attributes)
ICS_API int	ICS_create_view (tag_t theClass, const char *viewId, const char *viewName, tag_t *newView)
ICS_API int	ICS_ask_attribute_name (tag_t classOrView, tag_t attribute, char **attributeName)
ICS_API int	ICS_ask_attribute (tag_t classOrView, const char *attributeName, tag_t *attribute)
ICS_API int	ICS_describe_attribute (tag_t classOrView, tag_t attribute, int *unctNo, int *format, char **unit)
Attribute Functions
Common Return Values: ICS_invalid_attribute UNCT name cannot be NULL. ICS_invalid_format Invalid format (cannot be 0). ICS_invalid_attribute_id Invalid UNCT number (cannot be 0).
ICS_API int	ICS_create_unct (int unctNo, const char *unctName, const char *shortName, const char *unctUnit, int unctFormat)
ICS_API int	ICS_describe_unct (int unctNo, char **unctName, char **shortName, char **unctUnit, int *unctFormat)
ICS_API int	ICS_describe_format (int format, int *formatType, int *modifier1, int *modifier2, int *length)
ICS_API int	ICS_get_popup_definition (int format, int *count, char ***optionIds, char ***optionValues)
ICO Functions
Common Return Values: ICS_cannot_classify_wso The workspace object cannot be classified ICS_empty_resource_id Object id (Resource Id) cannot be empty ICS_find_relation_failed Given workspace object does not have any objects associated with it by the relation IMAN_classification. ICS_ico_does_not_exist No classification object exists for the given workspace object or the classification object has been deleted for this workspace object. ICS_invalid_class Invalid class (cannot be NULLTAG) ICS_invalid_ico Invalid classification object (cannot be NULLTAG) ICS_invalid_view Invalid view (cannot be NULLTAG) ICS_invalid_wso Invalid workspace object (cannot be NULLTAG) ICS_relation_type_does_not_exist Relation type (IMAN_classification) does not exist ICS_wso_already_classified The workspace object has already been classified ICS_wso_does_not_exist The given classification object is not associated with any workspace object ICS_wso_not_classified The given workspace object has not been classified
ICS_API int	ICS_is_wsobject_classified (tag_t wsObject, logical *isClassified)
ICS_API int	ICS_is_wsobject_classifiable (tag_t wsObject, logical *isClassifiable)
ICS_API int	ICS_classify_wsobject (tag_t wsObject, tag_t classificationObject)
ICS_API int	ICS_remove_classification (tag_t wsObject)
ICS_API int	ICS_delete_reference_to_wsobject (tag_t wsObject)
ICS_API int	ICS_delete_reference_to_ico (tag_t classificationObject)
ICS_API int	ICS_delete_classification_object (tag_t classificationObject)
ICS_API int	ICS_ask_classified_wsobject (tag_t classificationObject, tag_t *classifiedWSObject)
ICS_API int	ICS_ask_classification_object (tag_t wsObject, tag_t *classificationObject)
ICS_API int	ICS_create_classification_object (tag_t ws_object, const char *object_id, tag_t view_or_class_tag, tag_t *classification_object)
ICS_API int	ICS_ask_class_of_classification_obj (tag_t classificationObject, tag_t *theClass)
ICS_API int	ICS_ask_view_of_classification_obj (tag_t classificationObject, tag_t *view)
ICS_API int	ICS_ask_classification_object_id (tag_t classificationObject, char **objectId)
ICS_API int	ICS_ask_classification_instance_tag (tag_t theClass, tag_t theView, char *classificationObjectId, tag_t *classificationInstance)
ICS_API int	ICS_ask_cid_sid_of_classification_obj (tag_t classificationObject, char **classId, char **viewId)
ICS_API int	ICS_ask_attributes_of_classification_obj (tag_t classificationObject, int *nAttributes, char ***attributeNames, char ***attributeValues)
ICS_API int	ICS_ask_attribute_value (tag_t classificationObject, const char *attributeName, char **attributeValue)
ICS_API int	ICS_describe_classification_object (tag_t classificationObject, tag_t *view, int *nAttributes, int **unctNumbers, int **unctFormats, char ***attributeNames, char ***attributeValues, char ***units)
ICS_API int	ICS_set_values_for_classification_obj (tag_t classificationObject, int nAttributes, const char **attributeNames, const char **attributeValues)
ICS_API int	ICS_ask_type (tag_t object, int *objectType)

XML Import/Export Functions
The following ITK functions are used to support the XML import and export of Classification data.
#define	ICS_xml_hook_cancel_object   1
#define	ICS_xml_cancel   2
enum	ICS_xmlExport_Option_t {   ICS_xmlexport_this = 0, ICS_xmlexport_parent = ( 1 << 1 ), ICS_xmlexport_parentview = ( 1 << 2 ), ICS_xmlexport_subclass = ( 1 << 3 ),   ICS_xmlexport_subclassview = ( 1 << 4 ), ICS_xmlexport_Hierarchy = ( 1 << 5 ), ICS_xmlexport_parentinstance = ( 1 << 6 ), ICS_xmlexport_subclassinstance = ( 1 << 7 ),   ICS_xmlexport_instancexml = ( 1 << 8 ), ICS_xmlexport_instanceschema = ( 1 << 9 ), ICS_xmlexport_usermode = ( 1 << 10 ) }
enum	ICS_xml_hook_id_t { ICS_xml_hook_create = 1, ICS_xml_hook_update = 2, ICS_xml_hook_export = 3 }
enum	ICS_xml_hook_type_t { ICS_xml_hook_pre = 1, ICS_xml_hook_post = 2, ICS_xml_hook_cancel = 3 }
typedef enum ICS_xml_hook_id_t *	ICS_xml_hook_id_p_t
typedef enum ICS_xml_hook_type_t *	ICS_xml_hook_type_p_t
typedef int(*	ICS_xml_hook_t )(ICS_xml_hook_id_t theHookId, ICS_xml_hook_type_t preOrPost, int theObjectType, const char *theObjectId)
ICS_API int	ICS_xml_register_hook (ICS_xml_hook_id_t theHookId, ICS_xml_hook_t theHook)
ICS_API int	ICS_xml_import (const char *theXMLFileName, int theObjectTypeFilter, logical theUpdateFlag, logical theRelatedCreationFlag)
ICS_API int	ICS_xml_export (const char *theXMLFileName, ICS_objectType_t nObjType, const char *theId, int theObjectTypeFilter, int theExportOptions)
ICS_API int	ICS_xml_ask_children (const char *theParentId, int theLevelCount, logical theAdminMode, int theSortOption, logical theXMLOption, char **theChildren)

Detailed Description

This file contains the ITK Function declarations for the ICS Module

Definition in file ics.h.