class P1::ImageSdk::MetaObject

Overview

#include <P1ImageCommonMetaData.hpp>

class MetaObject: public P1::ImageSdkC::P1MetaObject
{
public:
    // construction

    MetaObject();
    MetaObject(P1::ImageSdkC::P1MetaObject& o);

    // methods

    bool IsValid();
    uint32_t GetType() const;
    uint32_t GetCount() const;
    uint8_t GetUByte(bool& error);
    uint16_t GetUWord(bool& error);
    uint32_t GetULong(bool& error);
    uint8_t GetSByte(bool& error);
    uint16_t GetSWord(bool& error);
    uint32_t GetSLong(bool& error);
    float GetFloat(bool& error);
    double GetDouble(bool& error);
    P1::ImageSdkC::CURational GetURational(bool& error);
    P1::ImageSdkC::CSRational GetSRational(bool& error);
    std::string GetRawString(bool& error);
    std::string GetString(bool& error);
    std::vector<uint8_t> GetUBytes(bool& error);
    std::vector<uint16_t> GetUWords(bool& error);
    std::vector<uint32_t> GetULongs(bool& error);
    std::vector<int8_t> GetSBytes(bool& error);
    std::vector<int16_t> GetSWords(bool& error);
    std::vector<int32_t> GetSLongs(bool& error);
    std::vector<float> GetFloats(bool& error);
    std::vector<double> GetDoubles(bool& error);
    bool SetUByte(uint8_t value);
    bool SetUWord(uint16_t value);
    bool SetULong(uint32_t value);
    bool SetSByte(uint8_t value);
    bool SetSWord(uint16_t value);
    bool SetSLong(uint32_t value);
    bool SetFloat(float value);
    bool SetDouble(double value);
    bool SetURational(P1::ImageSdkC::CURational value);
    bool SetSRational(P1::ImageSdkC::CSRational value);
    bool SetString(std::string buffer);
    bool SetUBytes(uint8_t* values, uint32_t count);
    bool SetUWords(uint16_t* values, uint32_t count);
    bool SetULongs(uint32_t* values, uint32_t count);
    bool SetSBytes(int8_t* values, uint32_t count);
    bool SetSWords(int16_t* values, uint32_t count);
    bool SetSLongs(int32_t* values, uint32_t count);
    bool SetFloats(float* values, uint32_t count);
    bool SetDoubles(double* values, uint32_t count);
    bool IsReadOnly();
    bool IsWritable();
    void SetWritable(bool state);
    bool IsDisabled();
    void SetDisabled(bool state);
    bool IsModifiable();
};

Inherited Members

public:
    // methods

    bool IsValid();
    uint32_t GetType() const;
    uint32_t GetCount() const;
    uint8_t GetUByte(bool& error);
    uint16_t GetUWord(bool& error);
    uint32_t GetULong(bool& error);
    uint8_t GetSByte(bool& error);
    uint16_t GetSWord(bool& error);
    uint32_t GetSLong(bool& error);
    float GetFloat(bool& error);
    double GetDouble(bool& error);
    CURational GetURational(bool& error);
    CSRational GetSRational(bool& error);
    std::string GetRawString(bool& error);
    std::string GetString(bool& error);
    std::vector<uint8_t> GetUBytes(bool& error);
    std::vector<uint16_t> GetUWords(bool& error);
    std::vector<uint32_t> GetULongs(bool& error);
    std::vector<int8_t> GetSBytes(bool& error);
    std::vector<int16_t> GetSWords(bool& error);
    std::vector<int32_t> GetSLongs(bool& error);
    std::vector<float> GetFloats(bool& error);
    std::vector<double> GetDoubles(bool& error);
    bool SetUByte(uint8_t value);
    bool SetUWord(uint16_t value);
    bool SetULong(uint32_t value);
    bool SetSByte(uint8_t value);
    bool SetSWord(uint16_t value);
    bool SetSLong(uint32_t value);
    bool SetFloat(float value);
    bool SetDouble(double value);
    bool SetURational(CURational value);
    bool SetSRational(CSRational value);
    bool SetString(std::string buffer);
    bool SetUBytes(uint8_t* values, uint32_t count);
    bool SetUWords(uint16_t* values, uint32_t count);
    bool SetULongs(uint32_t* values, uint32_t count);
    bool SetSBytes(int8_t* values, uint32_t count);
    bool SetSWords(int16_t* values, uint32_t count);
    bool SetSLongs(int32_t* values, uint32_t count);
    bool SetFloats(float* values, uint32_t count);
    bool SetDoubles(double* values, uint32_t count);
    bool IsReadOnly();
    bool IsWritable();
    void SetWritable(bool state);
    bool IsDisabled();
    void SetDisabled(bool state);
    bool IsModifiable();
    P1MetaData* GetPtr();

Detailed Documentation

Methods

bool IsValid()

Is meta object valid.

Returns:

A boolean flag that indicates if object is valid. True means it is valid

uint32_t GetType() const

Return the type of the object. <dni!> where to find the types.

Returns:

The type of the object is returned.

uint32_t GetCount() const

Return the number of elements in the object.

Use this function to get the number of elements in an array type metaobject. An object that contains a string will return the value 1.

Returns:

Return the number of elements of the object.

uint8_t GetUByte(bool& error)

Get scalar unsigned byte from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

uint16_t GetUWord(bool& error)

Get scalar unsigned word from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

uint32_t GetULong(bool& error)

Get scalar unsigned long from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

uint8_t GetSByte(bool& error)

Get scalar signed byte from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

uint16_t GetSWord(bool& error)

Get scalar signed word from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

uint32_t GetSLong(bool& error)

Get scalar signed long from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

float GetFloat(bool& error)

Get scalar float from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

double GetDouble(bool& error)

Get scalar double from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0 is returned.

P1::ImageSdkC::CURational GetURational(bool& error)

Get scalar unsigned rational from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata. A rational is value represented as a fraction (nom/denom) instead of a float or double. nom and denon is of type unsigned long

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0/0 is returned.

P1::ImageSdkC::CSRational GetSRational(bool& error)

Get scalar unsigned rational from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata. A rational is value represented as a fraction (nom/denom) instead of a float or double. nom and denon is of type signed long

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and 0/0 is returned.

std::string GetRawString(bool& error)

Get Raw string from object (including zero padding). Can be used on both binary and textual metaobjects. textual metaobject is e.g. an xmp value.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and “” is returned.

std::string GetString(bool& error)

Get string from object (removes padding). Can be used on both binary and textual metaobjects. textual metaobject is e.g. an xmp value.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

The value of the object. If it was not successfull the error flag will be set and “” is returned.

std::vector<uint8_t> GetUBytes(bool& error)

Get array of unsigned bytes from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<uint16_t> GetUWords(bool& error)

Get array of unsigned words from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<uint32_t> GetULongs(bool& error)

Get array of unsigned longs from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<int8_t> GetSBytes(bool& error)

Get array of signed bytes from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<int16_t> GetSWords(bool& error)

Get array of signed words from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<int32_t> GetSLongs(bool& error)

Get array of signed longs from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<float> GetFloats(bool& error)

Get array of floats from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

std::vector<double> GetDoubles(bool& error)

Get array of doubles from object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. The GetCount() method returns the number of array elements, but is not needed, since function itself returns all elements If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

error

This parameter refers to a variable where function can store the error state.

Returns:

A vector with values of the object. If it was not successfull the error flag will be set and empty vector is returned.

bool SetUByte(uint8_t value)

Set scalar unsigned byte value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetUWord(uint16_t value)

Set scalar unsigned word value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetULong(uint32_t value)

Set scalar unsigned long value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSByte(uint8_t value)

Set scalar signed byte value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSWord(uint16_t value)

Set scalar signed word value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSLong(uint32_t value)

Set scalar signed long value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetFloat(float value)

Set scalar float value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetDouble(double value)

Set scalar double value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetURational(P1::ImageSdkC::CURational value)

Set scalar unsigned rational value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata. A rational is value represented as a fraction (nom/denom) instead of a float or double. nom and denon is of type unsigned long

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSRational(P1::ImageSdkC::CSRational value)

Set scalar signed rational value of object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata. A rational is value represented as a fraction (nom/denom) instead of a float or double. nom and denon is of type signed long

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetString(std::string buffer)

Set string value of object. Can be used on both binary and textual metaobjects. textual metaobject is e.g. an xmp value.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag.

Parameters:

value

This parameter is the value to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetUBytes(uint8_t* values, uint32_t count)

Set array of unsigned bytes to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetUWords(uint16_t* values, uint32_t count)

Set array of unsigned words to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetULongs(uint32_t* values, uint32_t count)

Set array of unsigned longs to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSBytes(int8_t* values, uint32_t count)

Set array of signed bytes to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSWords(int16_t* values, uint32_t count)

Set array of signed words to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetSLongs(int32_t* values, uint32_t count)

Set array of signed longs to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetFloats(float* values, uint32_t count)

Set array of floats to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool SetDoubles(double* values, uint32_t count)

Set array of doubles to object. Can only be used on binary metaobjects with the correct type.

It is the users responsability to use this function correctly. The type of the object can be retrieved by using the GetType() method. If function is used on a wrong kind of object the function will set the error flag. A binary metaobject is eg. exif, gps and geotiff kind of metadata.

Parameters:

values

Points to array of values to be set.

count

The number of values in the array to be set

Returns:

true is returned it setting the value was successfull, on error false is returned.

bool IsReadOnly()

Get state of readonly atttribute. If metaobject is readonly then it can only be read (using a getter function)

Its the underlying system that determines if a value is readonly. The user cannot set this. The corresponding user functions is SetDisabled(bool state)

Returns:

true is returned if it is readonly. otherwise false is returned.

bool IsWritable()

Get state of writable atttribute. If metaobject writable then it will be written to output files, otherwise it will not.

This is a way to control if a metaobject should be written to an output image file.

Returns:

true is returned if it is writable. otherwise false is returned.

void SetWritable(bool state)

Set state of writable atttribute.

With this method the user can decide if a metaobject is allowed to be written to an output image file.

Parameters:

state

Set the writable state of the metaobject. True means it is writable.

bool IsDisabled()

Get state of disabled atttribute. If metaobject disabled then it cannot be changed.

This is a user way of controlling access to the metaobject. it cannot overrule the readonly attribute.

Returns:

true is returned if it is writable. otherwise false is returned.

void SetDisabled(bool state)

Set state of disabled atttribute.

With this method the user can protect the value in an object from being changed.

Parameters:

state

Set the disabled state of the metaobject. True means it is disabled.

bool IsModifiable()

Is the metaobject modifiable. Use this function to check if its possible to modify the value of the metaobject.

It is just a convinience function to check if the readonly or disabled attribute has been set

Returns:

true is returned if the value of the metaobject can be changed. otherwise false is returned.