VCF::ComponentInfo Class Reference

ComponentInfo represents special data regarding a component's class. More...

#include <ComponentInfo.h>

Inheritance diagram for VCF::ComponentInfo:


Public Member Functions
	ComponentInfo (const String &componentUUID, const String &author="", const String &company="", const String &copyright="", const String &additionalInfo="", const String &packageName="", const String &packageUUID="", Image *componentImage=NULL)
virtual	~ComponentInfo ()
String	getAuthor ()
	The name of the author of the component class.
String	getCopyright ()
	the copyright, if any, for the components source code
String	getCompany ()
	The name of the company responsible for the component.
String	getAdditionalInfo ()
	any additional information that can be rendered as text.
String	getComponentUUID ()
	the UUID that represents the corresponding component class.
String	getPackageName ()
	returns the name of the package (VPL) that this component belongs to
String	getPackageUUID ()
	returns the package UUID, that is, the unique string id for the package that this component belongs to.
Image *	getComponentImage ()
	an image that represents the component.
Enumerator< String > *	getRequiredHeaders ()
	returns an enumeration of all the headers that are required to successfully compile an implementation file that uses this component.
Enumerator< String > *	getRequiredNamespaces ()
	returns an enumeration of all the C++ namespaces that are required to successfully compile an implementation file that uses this component.
void	addHeader (const String &header)
void	removeHeader (const String &header)
void	removeAllHeaders ()
void	addNamespace (const String &aNamespace)
void	removeNamespace (const String &aNamespace)
void	removeAllNamespaces ()
Protected Attributes
String	author_
String	copyright_
String	company_
String	additionalInfo_
String	componentUUID_
String	packageName_
String	packageUUID_
Image *	componentImage_
std::vector< String >	requiredHeaders_
EnumeratorContainer< std::vector< String >, String >	reqHeadersContainer_
std::vector< String >	requiredNamespaces_
EnumeratorContainer< std::vector< String >, String >	reqNamespacesContainer_

Detailed Description

ComponentInfo represents special data regarding a component's class.

This information is generally used by development tools to aid in things like autogenerating code, for example.

Constructor & Destructor Documentation

VCF::ComponentInfo::ComponentInfo ( const String & componentUUID,

const String & author = "",

const String & company = "",

const String & copyright = "",

const String & additionalInfo = "",

const String & packageName = "",

const String & packageUUID = "",

Image * componentImage = NULL

)

virtual VCF::ComponentInfo::~ComponentInfo ( ) [virtual]

Member Function Documentation

void VCF::ComponentInfo::addHeader ( const String & header )

void VCF::ComponentInfo::addNamespace ( const String & aNamespace )

String VCF::ComponentInfo::getAdditionalInfo ( ) [inline]

any additional information that can be rendered as text.

String VCF::ComponentInfo::getAuthor ( ) [inline]

The name of the author of the component class.

String VCF::ComponentInfo::getCompany ( ) [inline]

The name of the company responsible for the component.

Image* VCF::ComponentInfo::getComponentImage ( ) [inline]

an image that represents the component.
This image must have dimensions of 25 pixels wide by 25 pixel high.
Returns:
Image a pointer to the image representing the component. May be NULL if no image exists. In this case a default image will be used.

String VCF::ComponentInfo::getComponentUUID ( ) [inline]

the UUID that represents the corresponding component class.
This UUID is guaranteed to be able to create a valid instance of the component at runtime.

String VCF::ComponentInfo::getCopyright ( ) [inline]

the copyright, if any, for the components source code

String VCF::ComponentInfo::getPackageName ( ) [inline]

returns the name of the package (VPL) that this component belongs to

String VCF::ComponentInfo::getPackageUUID ( ) [inline]

returns the package UUID, that is, the unique string id for the package that this component belongs to.
The package anme and package UUID must refer to the same package!

Enumerator<String>* VCF::ComponentInfo::getRequiredHeaders ( )

returns an enumeration of all the headers that are required to successfully compile an implementation file that uses this component.

Enumerator<String>* VCF::ComponentInfo::getRequiredNamespaces ( )

returns an enumeration of all the C++ namespaces that are required to successfully compile an implementation file that uses this component.