6       Function definitions

6.1    Introduction

6.1.1    Table of contents

Table 6.1 -- Table of contents


6     Function definitions. 165

6.1   Introduction. 165

6.1.1         Table of contents 165

6.1.2         Notational conventions 166

6.2   API functions. 167

SE_AddAssociateRelationship. 167

SE_AddComponentRelationship. 167

SE_CloneObject 167

SE_CloseTransmittal 168

SE_CMYKToCMY.. 168

SE_CMYToCMYK.. 168

SE_ConvertColourToGivenModel 168

SE_CreateObject 168

SE_CreateSearchFilter 168

SE_CreateSpatialSearchBoundary. 169

SE_DetermineSpatialInclusion. 169

SE_FreeIterator 169

SE_FreeObject 169

SE_FreePackedHierarchy. 169

SE_FreeRemainingObjectsList 170

SE_FreeRemainingPackedHierarchiesList 170

SE_FreeSearchFilter 170

SE_FreeSpatialSearchBoundary. 170

SE_FreeTransmittal 170

SE_GetAggregate. 170

SE_GetAssociate. 170

SE_GetColourModel 171

SE_GetComponent 171

SE_GetContextTransformation. 171

SE_GetDataTable. 171

SE_GetDRMClass 172

SE_GetElementOfDataTable. 172

SE_GetErrorDescription. 172

SE_GetFields 172

SE_GetIDForObject 172

SE_GetImageData. 172

SE_GetImplementationIdentifier 173

SE_GetIterationLengthRemaining. 173

SE_GetNextObject 173

SE_GetNthAssociateOfDRMClass 173

SE_GetNthComponentOfDRMClass 173

SE_GetNumberOfPathsToTransmittalRoot 174

SE_GetObjectForID.. 174

SE_GetObjectReferenceCount 174

SE_GetPackedDataTable. 174

SE_GetPackedHierarchy. 174

SE_GetPublishedLabels 175

SE_GetPublishedObjectList 175

SE_GetReferencedTransmittalList 175

SE_GetRelationCounts 175

SE_GetRemainingObjectsList 175

SE_GetRemainingPackedHierarchies 176

SE_GetRootObject 176

SE_GetSortKey. 176

SE_GetSRFParameters 176

SE_GetTransmittalFromObject 176

SE_GetTransmittalLocation. 176

SE_GetTransmittalName. 177

SE_GetTransmittalVersionInformation. 177

SE_GetUniqueTransmittalID.. 177

SE_GetUnresolvedObjectFromPublishedLabel 177

SE_GetUserData. 178

SE_HasAggregates 178

SE_HasAssociations 178

SE_HasComponents 178

SE_InitializeAggregateIterator 178

SE_InitializeAssociateIterator 179

SE_InitializeComponentIterator 179

SE_InitializeInheritedComponentIterator 179

SE_ObjectIsPublished. 179

SE_ObjectIsResolved. 180

SE_ObjectsAreSame. 180

SE_OpenTransmittalByLocation. 180

SE_OpenTransmittalByName. 180

SE_PublishObject 180

SE_PutDataTable. 180

SE_PutDataTableExtent 181

SE_PutElementOfDataTable. 181

SE_PutElementOfDataTableExtent 181

SE_PutFields 181

SE_PutImageData. 181

SE_PutPackedDataTable. 182

SE_PutPackedDataTableExtent 182

SE_RemoveAssociateRelationship. 182

SE_RemoveComponentRelationship. 182

SE_RemoveFromTransmittal 182

SE_ResolveObject 183

SE_ResolveTransmittalName. 183

SE_SetColourModel 183

SE_SetFirstErrorMessage. 183

SE_SetGeneralCallback. 183

SE_SetGeneralCallbackForOneFunction. 183

SE_SetRootObject 183

SE_SetSecondErrorMessage. 184

SE_SetSpecificCallback. 184

SE_SetSRFParameters 184

SE_SetTransmittalName. 184

SE_SetUserData. 184

SE_TransmittalsAreSame. 184

SE_UnpublishObject 185

SE_UseDefaultColourModel 185

SE_UseDefaultSRFParameters 185


6.1.2    Notational conventions

The binding of each SEDRIS function utilitzes the following template:

SEDRIS C Binding Function Name

Abstract Function:                          SEDRIS Abstract Function Name

ReturnValueDataType SE_FunctionName (

Parameter0DataType   parameter_0_name, /* parameter 0 comment           */

Parameter1DataType   parameter_1_name, /* parameter 1 comment           */

. . .

ParameterNDataType   parameter_N_name  /* parameter N comment           */

);

The SEDRIS C binding function name is formed by a sentinal “SE_” followed by the name without spaces and with words capitalized. The SEDRIS abstract function name is the name used in ISO/IEC 1xxxx-1. 

The return value data type and parameter data types may be found in clause 5 of this standard or may be a standard C data type (e.g., void).

The parameter names are formed by using lower case words separated by underscores.

To the right of each parameter declaration is a C comment field which provides a brief description of the parameter. If the comment begins with “OUT”, it means the argument is used as an output parameter; the implementation returns data to the application through this argument. Arguments without “OUT” are input parameters.

6.2    API functions

The following functions provide comprise the SEDRIS application program interface.

SE_AddAssociateRelationship    

Abstract Function:                          AddAssociateRelationship

SE_Status_Code SE_AddAssociateRelationship (

const

SE_Object

from_object,

const

SE_Object

to_object,

const

SE_Object

link_object,

 

SE_Boolean

make_two_way

);

SE_AddComponentRelationship    

Abstract Function:                          AddComponentRelationship

SE_Status_Code SE_AddComponentRelationship (

const

SE_Object

component_object,

const

SE_Object

aggregate_object,

const

SE_Object

link_object

);

SE_CloneObject 

Abstract Function:                          CloneObject

SE_Status_Code SE_CloneObject (

const

SE_Object

object,

 

SE_Object

*duplicate_object

);

SE_CloseTransmittal

Abstract Function:                          CloseTransmittal

SE_Status_Code SE_CloseTransmittal (

SE_Transmittal

transmittal

);

SE_CMYKToCMY

Abstract Function:                          CMYKToCMY

SE_Status_Code SE_CMYKToCMY (

const

SE_CMYK_Data

*cmyk_colour,

 

SE_CMY_Data

*cmy_colour

);

SE_CMYToCMYK

Abstract Function:                          CMYToCMYK

SE_Status_Code SE_CMYToCMYK (

const

SE_CMY_Data

*cmy_colour,

 

SE_CMYK_Data

*cmyk_colour

);

SE_ConvertColourToGivenModel   

Abstract Function:                          ConvertColourToGivenModel

SE_Status_Code SE_ConvertColourToGivenModel (

const

SE_Object

original_colour,

 

SE_Colour_Model

new_colour_model,

 

SE_Object

*new_colour

);

SE_CreateObject

Abstract Function:                          CreateObject

SE_Status_Code SE_CreateObject (

const

SE_Transmittal

transmittal,

 

SE_DRM_Class

new_object_type,

 

SE_Object

*new_object

);

SE_CreateSearchFilter

Abstract Function:                          CreateSearchFilter

SE_Status_Code SE_CreateSearchFilter (

const

SE_String

*implementation_identifier,

const

SE_Search_Rule_1D

*rules,

 

SE_Store

store,

 

SE_Search_Filter

**search_filter

);

SE_CreateSpatialSearchBoundary

Abstract Function:                          CreateSpatialSearchBoundary

SE_Status_Code SE_CreateSpatialSearchBoundary (

const

SE_String

*implementation_identifier,

const

SE_Search_Bounds

*search_bounds,

 

SE_Search_Bounds_Closure

search_bounds_closure,

 

SE_Search_Quality

search_quality,

 

SE_Inclusion_Choice

inclusion,

 

SE_Search_Dimension

search_dimension,

 

SE_Store

store,

 

SE_Search_Boundary

**search_boundary

);

SE_DetermineSpatialInclusion

Abstract Function:                          DetermineSpatialInclusion

SE_Status_Code SE_DetermineSpatialInclusion (

const

SE_Object

*object,

const

SE_Search_Bounds

*search_bounds,

 

SE_Search_Bounds_Closure

search_bounds_closure,

 

SE_Search_Quality

search_quality,

 

SE_Search_Dimension

search_dimension,

 

SE_Boolean

*fully_included,

 

SE_Boolean

*partly_included,

 

SE_Boolean

*includes_search_bounds

);

SE_FreeIterator

Abstract Function:                          FreeIterator

SE_Status_Code SE_FreeIterator (

const

SE_Iterator

to_free

);

SE_FreeObject

Abstract Function:                          FreeObject

SE_Status_Code SE_FreeObject (

const

SE_Object

to_free

);

SE_FreePackedHierarchy

Abstract Function:                          FreePackedHierarchy

SE_Status_Code SE_FreePackedHierarchy (

const

SE_Packed_Hierarchy

to_free

);

SE_FreeRemainingObjectsList

Abstract Function:                          FreeRemainingObjectsList

SE_Status_Code SE_FreeRemainingObjectsList (

const

SE_Remaining_Objects_List

*to_free

);

SE_FreeRemainingPackedHierarchiesList

Abstract Function:                          FreeRemainingPackedHierarchiesList

SE_Status_Code SE_FreeRemainingPackedHierarchiesList (

const

SE_Remaining_Packed_Hierarchies_List

 *to_free

);

SE_FreeSearchFilter

Abstract Function:                          FreeSearchFilter

SE_Status_Code SE_FreeSearchFilter (

const

SE_Search_Filter

to_free

);

SE_FreeSpatialSearchBoundary

Abstract Function:                          FreeSpatialSearchBoundary

SE_Status_Code SE_FreeSpatialSearchBoundary (

const

SE_Search_Boundary

to_free

);

SE_FreeTransmittal

Abstract Function:                          FreeTransmittal

SE_Status_Code SE_FreeTransmittal (

const

SE_Transmittal

to_free

);

SE_GetAggregate

Abstract Function:                          GetAggregate

SE_Status_Code SE_GetAggregate (

const

SE_Object

object,

 

SE_DRM_Class

drm_class,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Object

*aggregate_object,

 

SE_Object

*link_class_object

);

SE_GetAssociate

Abstract Function:                          GetAssociate

SE_Status_Code SE_GetAssociate (

const

SE_Object

object,

 

SE_DRM_Class

drm_class,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Object

*associate_object,

 

SE_Object

*link_class_object

);

SE_GetColourModel

Abstract Function:                          GetColourModel

SE_Status_Code SE_GetColourModel (

const

SE_Transmittal

transmittal,

 

SE_Colour_Model

*colour_model

);

SE_GetComponent

Abstract Function:                          GetComponent

SE_Status_Code SE_GetComponent (

const

SE_Object

object,

 

SE_DRM_Class

drm_class,

 

SE_Boolean

directly_attach_table_components,

 

SE_Boolean

process_inheritance,

 

SE_Short_Integer_Unsigned

maximum_search_distance,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Object

*component_object,

 

SE_Object

*link_class_object,

);

SE_GetContextTransformation

Abstract Function:                          GetContextTransformation

SE_Status_Code SE_GetContextTransformation (

const

SE_Object

object,

 

SE_Matrix_4x4

*matrix

);

SE_GetDataTable

Abstract Function:                          GetDataTable

SE_Status_Code SE_GetDataTable (

const

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

const

SE_Integer_Positive_1D

*table_property_description_number,

 

SE_Store

store,

 

SE_Property_Data_Value_1D

**data

);

SE_GetDRMClass

Abstract Function:                          GetDRMClass

SE_Status_Code SE_GetDRMClass (

const

SE_Object

object,

 

SE_DRM_Class

*object_type

);

SE_GetElementOfDataTable

Abstract Function:                          GetElementOfDataTable

SE_Status_Code SE_GetElementOfDataTable (

const

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

 

SE_Integer_Positive

table_property_description_number,

 

SE_Store

store,

 

SE_Property_Data_Value

**results

);

SE_GetErrorDescription

Abstract Function:                          GetErrorDescription

SE_Status_Code SE_GetErrorDescription (

 

SE_Store

store,

 

SE_String

**error_description

);

SE_GetFields

Abstract Function:                          GetFields

SE_Status_Code SE_GetFields (

const

SE_Object

object,

 

SE_Store

store,

 

SE_DRM_Class_Fields

**fields

);

SE_GetIDForObject

Abstract Function:                          GetIDForObject

SE_Status_Code SE_GetIDForObject (

const

SE_Object

object,

 

SE_Store

store,

 

SE_String

**id

);

SE_GetImageData

Abstract Function:                          GetImageData     

SE_Status_Code SE_GetImageData (

const

SE_Object

image,

const

SE_Image_Texel_Location_3D

*start_texel,

const

SE_Image_Texel_Location_3D

*stop_texel,

 

SE_Short_Integer_Unsigned

mip_level,

 

SE_Store

store,

 

SE_Byte_Unsigned_1D

**data

);

SE_GetImplementationIdentifier

Abstract Function:                          GetImplementationIdentifier

SE_Status_Code SE_GetImplementationIdentifier (

const

SE_Object

object,

 

SE_Store

store,

 

SE_String

**implementation_identifier

);

SE_GetIterationLengthRemaining

Abstract Function:                          GetIterationLengthRemaining

SE_Status_Code SE_GetIterationLengthRemaining (

const

SE_Iterator

iterator,

 

SE_Integer_Unsigned

*count

);

SE_GetNextObject

Abstract Function:                          GetNextObject

SE_Status_Code SE_GetNextObject (

const

SE_Iterator

iterator,

 

SE_Store

store,

 

SE_Object

**next_object,

 

SE_Object

**link_class_object

);

SE_GetNthAssociateOfDRMClass

Abstract Function:                          GetNthAssociateOfDRMClass

SE_Status_Code SE_GetNthAssociateOfDRMClass (

const

SE_Object

from_object,

 

SE_DRM_Class

desired_component_type,

 

SE_Integer_Positive

n,

 

SE_Store

store,

 

SE_Object

**associate_object,

 

SE_Object

**link_class_object

);

SE_GetNthComponentOfDRMClass

Abstract Function:                          GetNthComponentOfDRMClass

SE_Status_Code SE_GetNthComponentOfDRMClass (

const

SE_Object

aggregate_object,

 

SE_DRM_Class

desired_component_type,

 

SE_Integer_Positive

n,

 

SE_Store

store,

 

SE_Object

**component_object,

 

SE_Object

**link_class_object

);

SE_GetNumberOfPathsToTransmittalRoot

Abstract Function:                          GetNumberOfPathsToTransmittalRoot

SE_Status_Code SE_GetNumberOfPathsToTransmittalRoot (

const

SE_Object

object,

 

SE_Integer_Unsigned

*number_of_paths

);

SE_GetObjectForID

Abstract Function:                          GetObjectForID

SE_Status_Code SE_GetObjectForID (

const

SE_String

*id,

 

SE_Store

store,

 

SE_Object

**object

);

SE_GetObjectReferenceCount

Abstract Function:                          GetObjectReferenceCount

SE_Status_Code SE_GetObjectReferenceCount (

const

SE_Object

object,

 

SE_Short_Integer_Unsigned

*reference_count

);

SE_GetPackedDataTable

Abstract Function:                          GetPackedDataTable

SE_Status_Code SE_GetPackedDataTable (

const

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

const

SE_Integer_Positive_1D

*table_property_description_number,

 

SE_Store

store,

 

SE_Byte_Unsigned_1D

**data_out

);

SE_GetPackedHierarchy

Abstract Function:                          GetPackedHierarchy

SE_Status_Code SE_GetPackedHierarchy (

const

SE_Object

root_object,

 

SE_Boolean

directly_attach_table_components,

 

SE_Boolean

process_inheritance,

 

SE_Integer_Unsigned

hierarchy_depth,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Packed_Hierarchy

**hierarchy

);

SE_GetPublishedLabels

Abstract Function:                          GetPublishedLabels

SE_Status_Code SE_GetPublishedLabels (

const

SE_Object

object,

 

SE_Store

store,

 

SE_String_1D

**label_list

);

SE_GetPublishedObjectList

Abstract Function:                          GetPublishedObjectList

SE_Status_Code SE_GetPublishedObjectList (

const

SE_Transmittal

transmittal,

 

SE_Store

store,

 

SE_Object_1D

**published_object_list

);

SE_GetReferencedTransmittalList

Abstract Function:                          GetReferencedTransmittalList

SE_Status_Code SE_GetReferencedTransmittalList (

const

SE_Transmittal

transmittal,

 

SE_Store

store,

 

SE_String_1D

**transmittal_name_list

);

SE_GetRelationCounts

Abstract Function:                          GetRelationCounts

SE_Status_Code SE_GetRelationCounts (

const

SE_Object

object,

 

SE_Integer_Unsigned

*component_count,

 

SE_Integer_Unsigned

*component_link_count,

 

SE_Integer_Unsigned

*aggregate_count,

 

SE_Integer_Unsigned

*aggregate_link_count,

 

SE_Integer_Unsigned

*associate_count,

 

SE_Integer_Unsigned

*associate_link_count

);

SE_GetRemainingObjectsList

Abstract Function:                          GetRemainingObjectsList

SE_Status_Code SE_GetRemainingObjectsList (

const

SE_Iterator

iterator,

 

SE_Store

store,

 

SE_Object_1D

**remaining_objects

);

SE_GetRemainingPackedHierarchies

Abstract Function:                          GetRemainingPackedHierarchies

SE_Status_Code SE_GetRemainingPackedHierarchies (

const

SE_Iterator

iterator,

 

SE_Integer_Unsigned

hierarchy_depth,

 

SE_Store

store,

 

SE_RemainingPacked_Hierarchies_List

**remaining_hierarchies

);

SE_GetRootObject

Abstract Function:                          GetRootObject

SE_Status_Code SE_GetRootObject (

const

SE_Transmittal

*transmittal,

 

SE_Store

store,

 

SE_Object

*root_object

);

SE_GetSortKey

Abstract Function:                          GetSortKey

SE_Status_Code SE_GetSortKey (

const

SE_Object

object,

 

SE_Integer_Unsigned

*sort_key

);

SE_GetSRFParameters

Abstract Function:                          GetSRFParameters

SE_Status_Code SE_GetSRFParameters (

const

SE_Object

object,

 

SRM_SRF_Parameters

*srf_parameters

);

SE_GetTransmittalFromObject

Abstract Function:                          GetTransmittalFromObject

SE_Status_Code SE_GetTransmittalFromObject (

const

SE_Object

object,

 

SE_Store

store,

 

SE_Transmittal

**transmittal

);

SE_GetTransmittalLocation

Abstract Function:                          GetTransmittalLocation

SE_Status_Code SE_GetTransmittalLocation (

const

SE_Transmittal

transmittal,

 

SE_Store

store,

 

SE_URN

**location

);

SE_GetTransmittalName

Abstract Function:                          GetTransmittalName

SE_Status_Code SE_GetTransmittalName (

const

SE_Transmittal

transmittal,

 

SE_Store

store,

 

SE_String

**name_out

);

SE_GetTransmittalVersionInformation

Abstract Function:                          GetTransmittalVersionInformation

SE_Status_Code SE_GetTransmittalVersionInformation (

const

SE_Transmittal

transmittal

 

SE_Short_Integer_Unsigned

*major_version,

 

SE_Byte_Unsigned

*minor_version,

 

SE_Character

*interim_version,

 

SE_Short_Integer_Unsigned

*major_EDCS_version,

 

SE_Byte_Unsigned

*minor_EDCS_version,

 

SE_Character

*interim_EDCS_version,

 

SE_Short_Integer_Unsigned

*major_SRM_version,

 

SE_Byte_Unsigned

*minor_SRM_version,

 

SE_Character

*interim_SRM_version

);

SE_GetUniqueTransmittalID

Abstract Function:                          GetUniqueTransmittalID

SE_Status_Code SE_GetUniqueTransmittalID (

const

SE_Transmittal

transmittal,

 

SE_Store

store,

 

SE_String

**identifier

);

SE_GetUnresolvedObjectFromPublishedLabel

Abstract Function:                          GetUnresolvedObjectFromPublishedLabel

SE_Status_Code SE_GetUnresolvedObjectFromPublishedLabel (

const

SE_URN

*transmittal_name,

 

const

SE_String

*object_label,

 

const

SE_String

*implementation_identifier,

 

 

SE_Store

store,

 

 

SE_Object

*object

 

);

SE_GetUserData

Abstract Function:                          GetUserData

SE_Status_Code SE_GetUserData (

const

SE_Object

object,

 

SE_Store

store,

 

SE_User_Data

**user_data

);

SE_HasAggregates

Abstract Function:                          HasAggregates

SE_Status_Code SE_HasAggregates (

const

SE_Object

object,

 

SE_DRM_Class

drm_class,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Boolean

*result

);

SE_HasAssociations

Abstract Function:                          HasAssociations

SE_Status_Code SE_HasAssociations (

const

SE_Object

object,

 

SE_DRM_Class

drm_class,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Boolean

*result

);

SE_HasComponents

Abstract Function:                          HasComponents

SE_Status_Code SE_HasComponents (

const

SE_Object

object

 

SE_DRM_Class

drm_class,

 

SE_Boolean

directly_attach_table_components,

 

SE_Boolean

process_inheritence,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Boolean

*result

);

SE_InitializeAggregateIterator

Abstract Function:                          InitializeAggregateIterator

SE_Status_Code SE_InitializeAggregateIterator (

const

SE_Object

start_object,

const

SE_Search_Filter

filter,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Iterator

*iterator

);

SE_InitializeAssociateIterator

Abstract Function:                          InitializeAssociateIterator

SE_Status_Code SE_InitializeAssociateIterator (

const

SE_Object

start_object,

const

SE_Search_Filter

filter,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Iterator

*iterator

);

SE_InitializeComponentIterator

Abstract Function:                          InitializeComponentIterator

SE_Status_Code SE_InitializeComponentIterator (

const

SE_Object

start_object,

const

SE_Search_Boundary

boundary,

const

SE_Search_Filter

filter,

 

SE_Boolean

directly_attach_table_components,

 

SE_Boolean

process_inheritence,

 

SE_Boolean

transform_locations,

 

SE_Boolean

follow_model_instances,

 

SE_Boolean

evaluate_static_control_links,

const

SE_Hierarchy_Select_Parameters

*select_parameters,

const

SE_Hierarchy_Order_Parameters

*traversal_order_parameters,

 

SE_Traversal_Order

general_traversal_pattern,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Iterator

*iterator

);

SE_InitializeInheritedComponentIterator

Abstract Function:                          InitializeInheritedComponentIterator

SE_Status_Code SE_InitializeInheritedComponentIterator (

const

SE_Object

start_object,

const

SE_Search_Filter

*filter,

 

SE_Boolean

directly_attach_table_components,

 

SE_ITR_Behaviour

itr_traversal,

 

SE_Store

store,

 

SE_Iterator

*iterator

);

SE_ObjectIsPublished

Abstract Function:                          ObjectIsPublished

SE_Status_Code SE_ObjectIsPublished (

const

SE_Object

object,

 

SE_Boolean

*result

);

SE_ObjectIsResolved

Abstract Function:                          ObjectIsResolved

SE_Status_Code SE_ObjectIsResolved (

const

SE_Object

object,

 

SE_Boolean

*result

);

SE_ObjectsAreSame

Abstract Function:                          ObjectsAreSame

SE_Status_Code SE_ObjectsAreSame (

const

SE_Object

object_1,

const

SE_Object

object_2,

 

SE_Boolean

*result

);

SE_OpenTransmittalByLocation

Abstract Function:                          OpenTransmittalByLocation

SE_Status_Code SE_OpenTransmittalByLocation (

const

SE_URN

*location,

const

SE_String

*implementation_identifier,

 

SE_Access_Mode

access_mode,

 

SE_Store

store,

 

SE_Transmittal

*transmittal

);

SE_OpenTransmittalByName

Abstract Function:                          OpenTransmittalByName

SE_Status_Code SE_OpenTransmittalByName (

const

SE_URN

*transmittal_name,

const

SE_String

*implementation_identifier,

 

SE_Access_Mode

access_mode,

 

SE_Store

store,

 

SE_Transmittal

*transmittal

);

SE_PublishObject

Abstract Function:                          PublishObject

SE_Status_Code SE_PublishObject (

const

SE_Object

object,

const

SE_String

*label

);

SE_PutDataTable

Abstract Function:                          PutDataTable

SE_Status_Code SE_PutDataTable (

 

SE_Object

data_table,

const

SE_Integer_Positive_1D

*table_property_description_number,

const

SE_Property_Data_Value_1D

*data

);

SE_PutDataTableExtent

Abstract Function:                          PutDataTableExtent

SE_Status_Code SE_PutDataTableExtent (

 

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

const

SE_Integer_Positive_1D

*table_property_description_number,

const

SE_Property_Data_Value_1D

*data

);

SE_PutElementOfDataTable

Abstract Function:                          PutElementOfDataTable

SE_Status_Code SE_PutElementOfDataTable (

 

SE_Object

data_table,

 

SE_Integer_Positive

table_property_description_number,

const

SE_Property_Data_Value

*data

);

SE_PutElementOfDataTableExtent

Abstract Function:                          PutElementOfDataTableExtent

SE_Status_Code SE_PutElementOfDataTableExtent (

 

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

 

SE_Integer_Positive

table_property_description_number,

const

SE_Property_Data_Value_1D

*data

);

SE_PutFields

Abstract Function:                          PutFields

SE_Status_Code SE_PutFields (

 

SE_Object

existing_object,

const

SE_DRM_Class_Fields

*new_fields

);

SE_PutImageData

Abstract Function:                          PutImageData

SE_Status_Code SE_PutImageData (

 

SE_Object

image,

 

SE_Integer_Unsigned

start_texel_horizontal,

 

SE_Integer_Unsigned

start_texel_vertical,

 

SE_Integer_Unsigned

start_texel_z,

 

SE_Integer_Unsigned

stop_texel_horizontal,

 

SE_Integer_Unsigned

stop_texel_vertical,

 

SE_Integer_Unsigned

stop_texel_z,

 

SE_Short_Integer_Unsigned

mip_level,

const

SE_Byte_Unsigned_1D

*data

);

SE_PutPackedDataTable

Abstract Function:                          PutPackedDataTable

SE_Status_Code SE_PutPackedDataTable (

 

SE_DRM_Data_Table

data_table,

const

SE_Integer_Positive_1D

*table_property_description_number,

const

SE_Byte_Unsigned_1D

*data

);

SE_PutPackedDataTableExtent

Abstract Function:                          PutPackedDataTableExtent

SE_Status_Code SE_PutPackedDataTableExtent (

 

SE_Object

data_table,

const

SE_Data_Table_Extents

*extents,

const

SE_Integer_Positive_1D

*table_property_description_number,

const

SE_Byte_Unsigned_1D

*data

);

SE_RemoveAssociateRelationship

Abstract Function:                          RemoveAssociateRelationship

SE_Status_Code SE_RemoveAssociateRelationship (

 

SE_Object

from_object,

 

SE_Object

to_object,

 

SE_Object

link_object,

 

SE_Boolean

remove_two_way

);

SE_RemoveComponentRelationship

Abstract Function:                          RemoveComponentRelationship

SE_Status_Code SE_RemoveComponentRelationship (

 

SE_Object

from_object,

 

SE_Object

to_object,

 

SE_Object

link_object

);

SE_RemoveFromTransmittal

Abstract Function:                          RemoveFromTransmittal

SE_Status_Code SE_RemoveFromTransmittal (

const

SE_Object

old_object,

 

SE_Transmittal

transmittal

);

SE_ResolveObject

Abstract Function:                          ResolveObject

SE_Status_Code SE_ResolveObject (

const

SE_Object

object

);

SE_ResolveTransmittalName

Abstract Function:                          ResolveTransmittalName

SE_Status_Code SE_ResolveTransmittalName (

const

SE_String

*transmittal_name,

 

SE_Store

store,

 

SE_URN

**location

);

SE_SetColourModel

Abstract Function:                          SetColoModel

SE_Status_Code SE_SetColourModel (

SE_Colour_Model

colour_model

);

SE_SetFirstErrorMessage

Abstract Function:                          SetFirstErrorMessage

void SE_SetFirstErrorMessage (

const

SE_String

*message

);

SE_SetGeneralCallback

Abstract Function:                          SetGeneralCallback

SE_Status_Code SE_SetGeneralCallback (

const SE_Status_Logger

*user_defined_function

);

SE_SetGeneralCallbackForOneFunction

Abstract Function:                          SetGeneralCallbackForOneFunction

SE_Status_Code SE_SetGeneralCallbackForOneFunction (

const

SE_Status_Logger

*user_defined_function,

 

SE_Transmittal_API_Function

function_to_catch

);

SE_SetRootObject

Abstract Function:                          SetRootObject

SE_Status_Code SE_SetRootObject (

const

SE_Transmittal

transmittal,

const

SE_Object

new_root_object,

 

SE_Store

store,

 

SE_Object

*old_root_object

);

SE_SetSecondErrorMessage

Abstract Function:                          SetSecondErrorMessage

void SE_SetSecondErrorMessage (

const

SE_String

*message

);

SE_SetSpecificCallback

Abstract Function:                          SetSpecificCallback

SE_Status_Code SE_SetSpecificCallback (

const

SE_Status_Logger

*user_defined_function,

 

SE_Transmittal_API_Function

function_to_catch,

 

SE_Status_Code

status_code_to_catch

);

SE_SetSRFParameters

Abstract Function:                          SetSRFParameters

void SE_SetSRFParameters (

const

SRM_SRF_Parameters

*new_srf_parameters

);

SE_SetTransmittalName

Abstract Function:                          SetTransmittalName

SE_Status_Code SE_SetTransmittalName (

 

SE_Transmittal

transmittal,

const

SE_String

*new_transmittal_name

);

SE_SetUserData

Abstract Function:                          SetUserData

SE_Status_Code SE_SetUserData (

 

SE_Object

object,

const

SE_ByteUnsigned_1D

*user_data

);

SE_TransmittalsAreSame

Abstract Function:                          TransmittalsAreSame

SE_Status_Code SE_TransmittalsAreSame (

const

SE_Transmittal

transmittal_a,

const

SE_Transmittal

transmittal_b,

 

SE_Boolean

*result

);

SE_UnpublishObject

Abstract Function:                          UnpublishObject

SE_Status_Code SE_UnpublishObject (

 

SE_Object

object,

const

SE_String

*label

);

SE_UseDefaultColourModel

Abstract Function:                          UseDefaultColourModel

void SE_UseDefaultColourModel (

void

);

SE_UseDefaultSRFParameters

Abstract Function:                          UseDefaultSRFParameters

void SE_UseDefaultSRFParameters (

void

);