FreeImagePlus
- FreeImage 3.15.1
|
FreeImage Tag
More...
#include <FreeImagePlus.h>
Public Member Functions | |
operator FITAG * () | |
Returns a pointer to the FITAG data. More... | |
BOOL | isValid () const |
Returns TRUE if the tag is allocated, FALSE otherwise. More... | |
const char * | toString (FREE_IMAGE_MDMODEL model, char *Make=NULL) const |
Converts a FreeImage tag structure to a string that represents the interpreted tag value More... | |
Creation & Destruction | |
fipTag () | |
Constructor More... | |
virtual | ~fipTag () |
Destructor More... | |
BOOL | setKeyValue (const char *key, const char *value) |
Construct a FIDT_ASCII tag (ASCII string). More... | |
Copying | |
fipTag (const fipTag &tag) | |
Copy constructor More... | |
fipTag & | operator= (const fipTag &tag) |
Copy constructor More... | |
fipTag & | operator= (FITAG *tag) |
Assignement operator Copy the input pointer and manage its destruction More... | |
Tag accessors | |
const char * | getKey () const |
Returns the tag field name (unique inside a metadata model). More... | |
const char * | getDescription () const |
Returns the tag description if available, returns NULL otherwise More... | |
WORD | getID () const |
Returns the tag ID if available, returns 0 otherwise More... | |
FREE_IMAGE_MDTYPE | getType () const |
Returns the tag data type More... | |
DWORD | getCount () const |
Returns the number of components in the tag (in tag type units) More... | |
DWORD | getLength () const |
Returns the length of the tag value in bytes More... | |
const void * | getValue () const |
Returns the tag value More... | |
BOOL | setKey (const char *key) |
Set the tag field name More... | |
BOOL | setDescription (const char *description) |
Set the (usually optional) tag description More... | |
BOOL | setID (WORD id) |
Set the (usually optional) tad ID More... | |
BOOL | setType (FREE_IMAGE_MDTYPE type) |
Set the tag data type More... | |
BOOL | setCount (DWORD count) |
Set the number of data in the tag More... | |
BOOL | setLength (DWORD length) |
Set the length of the tag value, in bytes More... | |
BOOL | setValue (const void *value) |
Set the tag value More... | |
![]() | |
virtual | ~fipObject () |
Destructor. More... | |
Protected Attributes | |
FITAG * | _tag |
Pointer to a FreeImage tag. More... | |
FreeImage Tag
FreeImage uses this structure to store metadata information.
fipTag::fipTag | ( | ) |
Constructor
|
virtual |
Destructor
fipTag::fipTag | ( | const fipTag & | tag | ) |
Copy constructor
DWORD fipTag::getCount | ( | ) | const |
Returns the number of components in the tag (in tag type units)
const char* fipTag::getDescription | ( | ) | const |
Returns the tag description if available, returns NULL otherwise
WORD fipTag::getID | ( | ) | const |
Returns the tag ID if available, returns 0 otherwise
const char* fipTag::getKey | ( | ) | const |
Returns the tag field name (unique inside a metadata model).
DWORD fipTag::getLength | ( | ) | const |
Returns the length of the tag value in bytes
FREE_IMAGE_MDTYPE fipTag::getType | ( | ) | const |
Returns the tag data type
const void* fipTag::getValue | ( | ) | const |
Returns the tag value
|
virtual |
Returns TRUE if the tag is allocated, FALSE otherwise.
Implements fipObject.
|
inline |
Returns a pointer to the FITAG data.
Used for direct access from FREEIMAGE functions or from your own low level C functions.
fipTag& fipTag::operator= | ( | FITAG * | tag | ) |
Assignement operator
Copy the input pointer and manage its destruction
BOOL fipTag::setCount | ( | DWORD | count | ) |
Set the number of data in the tag
BOOL fipTag::setDescription | ( | const char * | description | ) |
Set the (usually optional) tag description
BOOL fipTag::setID | ( | WORD | id | ) |
Set the (usually optional) tad ID
BOOL fipTag::setKey | ( | const char * | key | ) |
Set the tag field name
BOOL fipTag::setKeyValue | ( | const char * | key, |
const char * | value | ||
) |
Construct a FIDT_ASCII tag (ASCII string).
This method is useful to store comments or IPTC tags.
name | Field name |
value | Field value |
BOOL fipTag::setLength | ( | DWORD | length | ) |
Set the length of the tag value, in bytes
BOOL fipTag::setType | ( | FREE_IMAGE_MDTYPE | type | ) |
Set the tag data type
BOOL fipTag::setValue | ( | const void * | value | ) |
Set the tag value
const char* fipTag::toString | ( | FREE_IMAGE_MDMODEL | model, |
char * | Make = NULL |
||
) | const |
Converts a FreeImage tag structure to a string that represents the interpreted tag value
model | Metadata model specification (metadata model from which the tag was extracted) |
Make | Camera model (not used yet) |
|
protected |
Pointer to a FreeImage tag.