Share via

class PropertyCollection

  • Article

Class to retrieve or set a property value from a property collection.

Members

~PropertyCollection

Syntax: public inline ~PropertyCollection ( );

Destructor.

SetProperty

Syntax: public inline void SetProperty ( PropertyId propertyID , const std::string & value );

Set value of a property.

Parameters

  • propertyID The id of the property. See PropertyId

  • value value to set

SetProperty

Syntax: public inline void SetProperty ( const std::string & propertyName , const std::string & value );

Set value of a property.

Parameters

  • propertyName The name of property.

  • value value to set

GetProperty

Syntax: public inline std::string GetProperty ( PropertyId propertyID , const std::string & defaultValue ) const;

Returns value of a property. If the property value is not defined, the specified default value is returned.

Parameters

  • propertyID The id of the property. See PropertyId

  • defaultValue The default value which is returned if no value is defined for the property (empty string by default).

Returns

value of the property.

GetProperty

Syntax: public inline std::string GetProperty ( const std::string & propertyName , const std::string & defaultValue ) const;

Returns value of a property. If the property value is not defined, the specified default value is returned.

Parameters

  • propertyName The name of the property.

  • defaultValue The default value which is returned if no value is defined for the property (empty string by default).

Returns

value of the property.