ITK Function Reference

(V10000.1.0.60_20160308.00)
Data Fields
WSO_get_info_entry_s Struct Reference

#include <workspaceobject.h>

Data Fields

void * client_data
 
char desc [32]
 
int entry_number
 
int m_flag
 
char name [WSO_name_size_c+1]
 
int number_of_entries
 
int p_flag
 
int size
 
char * value
 

Detailed Description

The get/set_info mechanism uses the data structure described below. A client should use the appropriate get_info call. In the ITK this would be a function named WSOM_get_info(WSO_descriptor_p_t *d) in C++ an instance of the class is used to access the member function get_info.

The client may change some values that are not protected. If this is done the client should set the m_flag of the corresponding WSO_get_info_entry_t.

The client must be sure not to overwrite the buffer provided for the value. The size of the buffer is provided in the entry.

When values are changed the client should call the appropriate set_info function. i.e. WSOM_set_info for C ITK and instance set_info for C++

Use of the get_info function will result in memory being allocated. Please call the appropriate free_info function to free the memory. Do not use any other means to free this memory.

WSOM_get_info - allocate memory and return data.
WSOM_set_info - change the values of appropriate attributes
WSOM_free_info - free memory allocated by WSOM_get_info

Definition at line 282 of file workspaceobject.h.

Field Documentation

void* WSO_get_info_entry_s::client_data
                #WSOM_get_info uses it for form entry id.

It is up the client to decide what use if any there is for it.

Definition at line 290 of file workspaceobject.h.

char WSO_get_info_entry_s::desc[32]

Description of the attribute value. e.g "bytes"

Definition at line 286 of file workspaceobject.h.

int WSO_get_info_entry_s::entry_number

Do not modify

Definition at line 292 of file workspaceobject.h.

int WSO_get_info_entry_s::m_flag

If the value is changed then this flag should be set to 1

Definition at line 289 of file workspaceobject.h.

char WSO_get_info_entry_s::name[WSO_name_size_c+1]

Applicable attribute name

Definition at line 283 of file workspaceobject.h.

int WSO_get_info_entry_s::number_of_entries

Do not modify

Definition at line 293 of file workspaceobject.h.

int WSO_get_info_entry_s::p_flag
                      If this value is set (i.e. p_flag != 0),

then the value of the attribute cannot be changed using set_info.

Definition at line 287 of file workspaceobject.h.

int WSO_get_info_entry_s::size

Length of the value string. Be sure not to overwrite it.

Definition at line 284 of file workspaceobject.h.

char* WSO_get_info_entry_s::value

Buffer containing the value of this attribute.

Definition at line 285 of file workspaceobject.h.


The documentation for this struct was generated from the following file: