Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::PackageInfo Class Reference

This class provides extra information specifically for shared or static libraries. More...

#include <vcf/FoundationKit/PackageInfo.h>

Inheritance diagram for VCF::PackageInfo:

VCF::ProgramInfo VCF::Object List of all members.

Public Types

enum  LinkageFlags { lfStaticLibLinkage = 0x01, lfSharedLibLinkage = 0x02 }

Public Member Functions

 PackageInfo (const String &packageName, const String &packageUUID, const String &staticLibName, const String &sharedLibName, int32 linkageFlags, const String &author="", const String &company="", const String &copyright="", const String &additionalInfo="")
 Creates a PackageInfo object, first five arguments are required.
String getPackageName ()
 returns the name of the package (VPL)
String getPackageUUID ()
 returns the package UUID, that is, the unique string id for the package.
String getAdditionalInfo ()
 any additional information that can be rendered as text.
String getStaticLibName ()
String getSharedLibName ()
Enumerator< String > * getRequiredStaticLibs ()
void addRequiredStaticLib (const String &libName)
void removeRequiredStaticLib (const String &libName)
void removeAllRequiredStaticLibs ()
Enumerator< String > * getRequiredSharedLibs ()
void addRequiredSharedLib (const String &libName)
void removeRequiredSharedLib (const String &libName)
void removeAllRequiredSharedLibs ()
bool allowsStaticLinkage ()
bool allowsSharedLinkage ()
Enumerator< String > * getSupportedPlatforms ()
void addSupportedPlatform (const String &platform)
void removeSupportedPlatform (const String &platform)
void removeAllSupportedPlatforms ()

Protected Attributes

String packageUUID_
String additionalInfo_
String staticLibName_
String sharedLibName_
int32 linkageFlags_
Array< StringrequiredStaticLibs_
Array< StringrequiredSharedLibs_
Array< StringsupportedPlatforms_

Detailed Description

This class provides extra information specifically for shared or static libraries.


Member Enumeration Documentation

enum VCF::PackageInfo::LinkageFlags
 

Enumerator:
lfStaticLibLinkage 
lfSharedLibLinkage 


Constructor & Destructor Documentation

VCF::PackageInfo::PackageInfo const String packageName,
const String packageUUID,
const String staticLibName,
const String sharedLibName,
int32  linkageFlags,
const String author = "",
const String company = "",
const String copyright = "",
const String additionalInfo = ""
 

Creates a PackageInfo object, first five arguments are required.


Member Function Documentation

void VCF::PackageInfo::addRequiredSharedLib const String libName  ) 
 

void VCF::PackageInfo::addRequiredStaticLib const String libName  ) 
 

void VCF::PackageInfo::addSupportedPlatform const String platform  ) 
 

bool VCF::PackageInfo::allowsSharedLinkage  )  [inline]
 

bool VCF::PackageInfo::allowsStaticLinkage  )  [inline]
 

String VCF::PackageInfo::getAdditionalInfo  )  [inline]
 

any additional information that can be rendered as text.

String VCF::PackageInfo::getPackageName  )  [inline]
 

returns the name of the package (VPL)

String VCF::PackageInfo::getPackageUUID  )  [inline]
 

returns the package UUID, that is, the unique string id for the package.

Enumerator<String>* VCF::PackageInfo::getRequiredSharedLibs  ) 
 

Enumerator<String>* VCF::PackageInfo::getRequiredStaticLibs  ) 
 

String VCF::PackageInfo::getSharedLibName  )  [inline]
 

String VCF::PackageInfo::getStaticLibName  )  [inline]
 

Enumerator<String>* VCF::PackageInfo::getSupportedPlatforms  ) 
 

void VCF::PackageInfo::removeAllRequiredSharedLibs  ) 
 

void VCF::PackageInfo::removeAllRequiredStaticLibs  ) 
 

void VCF::PackageInfo::removeAllSupportedPlatforms  ) 
 

void VCF::PackageInfo::removeRequiredSharedLib const String libName  ) 
 

void VCF::PackageInfo::removeRequiredStaticLib const String libName  ) 
 

void VCF::PackageInfo::removeSupportedPlatform const String platform  ) 
 


Member Data Documentation

String VCF::PackageInfo::additionalInfo_ [protected]
 

int32 VCF::PackageInfo::linkageFlags_ [protected]
 

String VCF::PackageInfo::packageUUID_ [protected]
 

Array<String> VCF::PackageInfo::requiredSharedLibs_ [protected]
 

Array<String> VCF::PackageInfo::requiredStaticLibs_ [protected]
 

String VCF::PackageInfo::sharedLibName_ [protected]
 

String VCF::PackageInfo::staticLibName_ [protected]
 

Array<String> VCF::PackageInfo::supportedPlatforms_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information