Class PropertyMap

A property map offers quick access to known properties as well as functions to enumerate all features through the category tree.

There is a plethora of overloaded functions to access properties with a known name and type. For example, to find a known integer property, use:

• Find(PropIdInteger)
• FindInteger(string)
• TryFind(PropIdInteger, out PropInteger)
• TryFindInteger(string, out PropInteger)

• Find(string)
• TryFind(string, out Property)

• SetValue(string, long)
• SetValue(string, double)
• SetValue(PropIdBoolean, bool)
• SetValue(PropIdEnumeration, string)

To get a flat list of all properties in the property map's category tree, enumerate All.

The current values of all properties in a property map can be saved to a file or a memory buffer using Serialize() or one of its overloads. To restore the settings at a later time, call DeSerialize(byte[]).

An image buffer containing chunk data can be connected to a property map using ConnectChunkData(ImageBuffer). Doing so lets the property map uses the image buffer as the data source for chunk property read operations.

This is a shortcut for calling Find(string)

If there is no property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(string, out Property).

This is a shortcut for calling Find(PropIdBoolean)

If there is no boolean property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdBoolean, out PropBoolean).

This is a shortcut for calling Find(PropIdCommand)

If there is no command property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdCommand, out PropCommand).

This is a shortcut for calling Find(PropIdEnumeration)

If there is no enumeration property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdEnumeration, out PropEnumeration).

This is a shortcut for calling Find(PropIdFloat)

If there is no float property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdFloat, out PropFloat).

This is a shortcut for calling Find(PropIdInteger)

If there is no integer property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdInteger, out PropInteger).

This is a shortcut for calling Find(PropIdRegister)

If there is no register property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdRegister, out PropRegister).

This is a shortcut for calling Find(PropIdString)

If there is no string property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdString, out PropString).

The property map takes a reference to the passed image buffer, extending its lifetime and preventing automatic reuse. The reference is released when a new image buffer is connected to the property map, or null is passed in the buffer argument.

If there is no property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(string, out Property).

If there is no boolean property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdBoolean, out PropBoolean).

If there is no command property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdCommand, out PropCommand).

If there is no enumeration property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdEnumeration, out PropEnumeration).

If there is no float property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdFloat, out PropFloat).

If there is no integer property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdInteger, out PropInteger).

If there is no register property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdRegister, out PropRegister).

If there is no string property matching the identifier in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFind(PropIdString, out PropString).

If there is no boolean property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindBoolean(string, out PropBoolean).

If there is no category property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindCategory(string, out PropCategory).

If there is no command property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindCommand(string, out PropCommand).

If there is no enumeration property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindEnumeration(string, out PropEnumeration).

If there is no float property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindFloat(string, out PropFloat).

If there is no integer property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindInteger(string, out PropInteger).

If there is no register property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindRegister(string, out PropRegister).

If there is no string property with the the given name in this property map, an IC4Exception is thrown.

To avoid an exception being thrown in case the property is not found, use TryFindString(string, out PropString).

The behavior depends on the type of the property:

• For boolean properties, the value is returned directly.
• For enumeration properties, a value is returned if the name of the currently selected entry unambiguously suggests to represent true or false.
• For all other property types, the call results in an error. (IC4Exception with ErrorCode set to GenICamTypeMismatch.)

A value is returned if the name of the currently selected entry unambiguously suggests to represent true or false.

The behavior depends on the type of the property:

• For float properties, the value is returned directly.
• For integer properties, the value is converted to double.
• For all other property types, the call results in an error. (IC4Exception with ErrorCode set to GenICamTypeMismatch.)

The behavior depends on the type of the property:

• For integer properties, the value is returned directly.
• For boolean properties, the value returned is 1 or 0.
• For all other property types, the call results in an error. (IC4Exception with ErrorCode set to GenICamTypeMismatch.)

The behavior depends on the type of the property:

• For integer properties, the value is converted to a string.
• For float properties, the value is converted to a string.
• For boolean properties, the returned value is "true" or "false".
• For enumeration properties, the name of the currently selected entry is returned.
• For string properties, the value is returned directly.
• For all other property types, the call results in an error. (IC4Exception with ErrorCode set to GenICamTypeMismatch.)

To restore the state of the properties at a later time, use DeSerialize(byte[]).

To restore the state of the properties at a later time, use DeSerialize(Stream).

To restore the state of the properties at a later time, use DeSerialize(string).

The behavior depends on the type of the property:

• For boolean properties, the value is set directly.
• For enumeration properties, it selects the entry with a name that unambiguously suggests to represent true or false, if available.
• For command properties, the command is executed if value is true.
• For all other property types, the call results in an error.

The behavior depends on the type of the property:

• For integer properties, the value is rounded to the nearest integer.
• For float properties, the value is set directly.
• For all other property types, the call results in an error.

The behavior depends on the type of the property:

• For integer properties, the value is set directly.
• For float properties, the value is set directly.
• For boolean properties, if the value is 1 or 0, it is set to true or false respectively. Other values result in an error.
• For enumeration properties, the value is set directly.
• For command properties, the command is executed if the value is 1.
• For all other property types, the call results in an error.

The behavior depends on the type of property:

• For integer properties, the string is parsed, and the found integer value is set.
• For float properties, the string is parsed, and the found floating-point value is set.
• For boolean properties, a value is set if the string can be unambiguously identified to represent true or false.
• For enumeration properties, the entry with a naming matching the value is set.
• For string properties, the value is set directly.
• For command properties, the command is executed if value is "1", "true" or "execute".
• For all other property types, the call results in an error.

The value is set if the string can be unambiguously identified to represent @c true or @c false.

An entry is only selected if there is an entry with a name that unambiguously suggests to represent @c true or @c false.

This overload exists to avoid a cast when configuring the pixelformat.

Use this function instead of Find(string) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdBoolean) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdCommand) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdEnumeration) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdFloat) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdInteger) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdRegister) to avoid an exception being thrown if an error occurs.

Use this function instead of Find(PropIdString) to avoid an exception being thrown if an error occurs.

Use this function instead of FindBoolean(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindCategory(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindCommand(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindEnumeration(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindFloat(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindInteger(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindRegister(string) to avoid an exception being thrown if an error occurs.

Use this function instead of FindString(string) to avoid an exception being thrown if an error occurs.