carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:53 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
IBSFCatalog (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cpp.sdk.core.IBSFCatalog interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IBSFCatalog (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IBSFCatalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html" target="_top"><B>FRAMES</B></A>
<A HREF="IBSFCatalog.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.cpp.sdk.core</FONT>
<BR>
Interface IBSFCatalog</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IBSFCatalog</B></DL>
</PRE>
<P>
This is a catalog of all the BSF files detected for a given SDK.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#findPlatform(java.lang.String)">findPlatform</A></B>(java.lang.String platform)</CODE>
<BR>
Find a platform with the given name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getAdditionalBuiltPlatforms(java.lang.String)">getAdditionalBuiltPlatforms</A></B>(java.lang.String platform)</CODE>
<BR>
Get the platforms to compile with this one, not including this one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IMessage[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getMessages()">getMessages</A></B>()</CODE>
<BR>
Get any problems detected while parsing the BSF files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getPlatforms()">getPlatforms</A></B>()</CODE>
<BR>
Get the array of BSF platforms detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getReleasePlatform(java.lang.String)">getReleasePlatform</A></B>(java.lang.String platformName)</CODE>
<BR>
Get the release platform name for the given platform.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getVariantPlatforms()">getVariantPlatforms</A></B>()</CODE>
<BR>
Get the variant platforms (but not virtual variants) among
the platforms detected.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getVirtualVariantPlatforms()">getVirtualVariantPlatforms</A></B>()</CODE>
<BR>
Get the virtual variant platforms from the platforms detected.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getMessages()"><!-- --></A><H3>
getMessages</H3>
<PRE>
IMessage[] <B>getMessages</B>()</PRE>
<DL>
<DD>Get any problems detected while parsing the BSF files.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of messages, never null</DL>
</DD>
</DL>
<HR>
<A NAME="getPlatforms()"><!-- --></A><H3>
getPlatforms</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[] <B>getPlatforms</B>()</PRE>
<DL>
<DD>Get the array of BSF platforms detected. Each corresponds to
a *.bsf file. This does not include the built-in platforms.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array, never null</DL>
</DD>
</DL>
<HR>
<A NAME="getVariantPlatforms()"><!-- --></A><H3>
getVariantPlatforms</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[] <B>getVariantPlatforms</B>()</PRE>
<DL>
<DD>Get the variant platforms (but not virtual variants) among
the platforms detected. These are the ones that will be available
when, e.g., "PRJ_PLATFORMS VARIANT" is used.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array, never null</DL>
</DD>
</DL>
<HR>
<A NAME="findPlatform(java.lang.String)"><!-- --></A><H3>
findPlatform</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A> <B>findPlatform</B>(java.lang.String platform)</PRE>
<DL>
<DD>Find a platform with the given name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - platform name, case doesn't matter
<DT><B>Returns:</B><DD>platform or null</DL>
</DD>
</DL>
<HR>
<A NAME="getAdditionalBuiltPlatforms(java.lang.String)"><!-- --></A><H3>
getAdditionalBuiltPlatforms</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[] <B>getAdditionalBuiltPlatforms</B>(java.lang.String platform)</PRE>
<DL>
<DD>Get the platforms to compile with this one, not including this one.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of IBSFPlatform included when this platform is built;
never null</DL>
</DD>
</DL>
<HR>
<A NAME="getReleasePlatform(java.lang.String)"><!-- --></A><H3>
getReleasePlatform</H3>
<PRE>
java.lang.String <B>getReleasePlatform</B>(java.lang.String platformName)</PRE>
<DL>
<DD>Get the release platform name for the given platform. This is the directory
name used for builds, e.g. \epoc32\release\<..>.
<p>
A variant target always builds into the same directory as a built-in platform.
Only the filename varies. For example, CONFIG is a virtual variant of ARMV5 and VARIANT
is a variant of CONFIG. All three have ARMV5 as their release platform.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>platformName</CODE> -
<DT><B>Returns:</B><DD>name of release platform</DL>
</DD>
</DL>
<HR>
<A NAME="getVirtualVariantPlatforms()"><!-- --></A><H3>
getVirtualVariantPlatforms</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A>[] <B>getVirtualVariantPlatforms</B>()</PRE>
<DL>
<DD>Get the virtual variant platforms from the platforms detected. This returns only platforms explicitly quoting VIRTUALVARIANT, not
platforms customizing that variant. This does not include entries returned by '<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html#getVariantPlatforms()"><CODE>getVariantPlatforms()</CODE></A>'
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array, never null</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IBSFCatalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html" target="_top"><B>FRAMES</B></A>
<A HREF="IBSFCatalog.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</BODY>
</HTML>