class RED::FileHeader

This class stores the info read from a .red file header. More...

#include <REDIREDFile.h>

Inherits: Object.

Public functions:

	FileHeader ( )
	FileHeader ( const RED::String & iParentApplication, const RED::String & iAuthor, const RED::Version & iVersion, bool iEncrypted )
	~FileHeader ( )
virtual void *	As ( const RED::CID & iCID )
virtual const void *	As ( const RED::CID & iCID ) const
template< class T_As > const T_As *	As ( ) const
template< class T_As > T_As *	As ( )
const RED::String &	GetAuthorName ( ) const
const RED::String &	GetParentApplication ( ) const
Version	GetRedsdkVersion ( ) const
bool	IsEncrypted ( ) const

Public static functions:

static RED::CID

Public static variables:

static const unsigned int

Protected variables:

RED::String	_author
bool	_encrypted
RED::String	_parentapp
RED::Version	_version

Detailed description:

This class stores the info read from a .red file header.

After a successful reading of a .red file, you'll get access to its file header. It encodes some global information about the read file including:

the parent application (optional),
the version of REDsdk used to write the file,
the name of the file author (optional),
the encryption status of the file.

Functions documentation

public RED::FileHeader::FileHeader

(

)

FileHeader default construction method.

public RED::FileHeader::FileHeader	(	const RED::String &	iParentApplication,
		const RED::String &	iAuthor,
		const RED::Version &	iVersion,
		bool	iEncrypted
	)

Construction method.

Parameters:

iParentApplication:	Name of the application source of the file.
iAuthor:	File author's name.
iVersion:	REDsdk version used to create the file.
iEncrypted:	Is the file encrypted or not ?

public RED::FileHeader::~FileHeader

(

)

FileHeader destruction method.

public static RED::CID RED::FileHeader::GetClassID

(

)

Reimplements: RED::Object::GetClassID.

public virtual void * RED::FileHeader::As

(

const RED::CID &

iCID

)

Converts the object to an instance of the given type.

Parameters:

iCID:

Requested class.

Returns:

An object pointer of the given class on success, NULL otherwise.

Reimplements: RED::Object::As.

public virtual const void * RED::FileHeader::As

(

const RED::CID &

iCID

) const

Converts the object to an instance of the given type.

Parameters:

iCID:

Requested class.

Returns:

An object pointer of the given class on success, NULL otherwise.

Reimplements: RED::Object::As.

template< class T_As > public const T_As * RED::FileHeader::As

(

) const

Template version of the as const method.

Simply set T to be the class you want to retrieve an interface to.

Returns:

A pointer to a const instance of class T on success, NULL otherwise.

Reimplements: RED::Object::As.

template< class T_As > public T_As * RED::FileHeader::As

(

)

Template version of the as method.

Simply set T to be the class you want to retrieve an interface to.

Returns:

A pointer to an instance of class T on success, NULL otherwise.

Reimplements: RED::Object::As.

public const RED::String & RED::FileHeader::GetAuthorName

(

) const

Returns:

A string describing the author of the .red file.

public const RED::String & RED::FileHeader::GetParentApplication

(

) const

Gets the parent application name.

Returns:

A string describing the parent application that produced the .red file.

public Version RED::FileHeader::GetRedsdkVersion

(

) const

Returns:

The REDsdk version that was used to build the .red file.

public bool RED::FileHeader::IsEncrypted

(

) const

Returns:

A boolean value describing whether the .red file is encrypted (true) or not (false).

Variables documentation

public static const unsigned int RED::FileHeader::_signature

Chunk's signature.

protected RED::String RED::FileHeader::_author

.red file author.

protected bool RED::FileHeader::_encrypted

flag indicating if the .red file is encrypted or not.

protected RED::String RED::FileHeader::_parentapp

.red file parent application.

protected RED::Version RED::FileHeader::_version

REDsdk version.