carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cpp/sdk/core/IBSFPlatform.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>
IBSFPlatform (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cpp.sdk.core.IBSFPlatform interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IBSFPlatform (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/IBSFPlatform.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">
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html" title="interface in com.nokia.carbide.cpp.sdk.core"><B>PREV CLASS</B></A>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ICarbideInstalledSDKChangeListener.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/IBSFPlatform.html" target="_top"><B>FRAMES</B></A>
<A HREF="IBSFPlatform.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 IBSFPlatform</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IBSFPlatform</B></DL>
</PRE>
<P>
This interface defines a single BSF platform.
<p>
Once a platform is available
from a catalog, it is contained in a hierarchy of platforms, terminating at
built-in platforms (like ARMV5).
<p>
A platform's "customized platform name" in
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getCustomizedPlatformName()"><CODE>getCustomizedPlatformName()</CODE></A> tells what platform this one customizes,
i.e. the parent platform. If the parent is also a BSF platform, then that
will be available from <A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getCustomizedPlatform()"><CODE>getCustomizedPlatform()</CODE></A>.
<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> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getBSFPath()">getBSFPath</A></B>()</CODE>
<BR>
Get the full filesystem path to the BSF used.</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/IBSFCatalog.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFCatalog</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getCatalog()">getCatalog</A></B>()</CODE>
<BR>
Get the catalog this platform is contained in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cpp/epoc/engine/model/ETristateFlag.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">ETristateFlag</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getCompileWithParent()">getCompileWithParent</A></B>()</CODE>
<BR>
Get the compile with parent flag for this BSF in isolation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map<java.lang.String,java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getCustomizationOptions()">getCustomizationOptions</A></B>()</CODE>
<BR>
Get the map of customization options for this BSF in isolation.</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/IBSFPlatform.html#getCustomizedPlatform()">getCustomizedPlatform</A></B>()</CODE>
<BR>
Get the customized (parent) platform, if it is a BSF platform.</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/IBSFPlatform.html#getCustomizedPlatformName()">getCustomizedPlatformName</A></B>()</CODE>
<BR>
Get the name of the customized platform, which matches the case of
a known platform if possible, else is all-caps.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getEffectiveCompileWithParent()">getEffectiveCompileWithParent</A></B>()</CODE>
<BR>
Get the disposition of the "compile with parent" setting, as inherited
by parents or specified in this platform.</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/IBSFPlatform.html#getName()">getName</A></B>()</CODE>
<BR>
Get the platform's name, as seen in the .bsf filename.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getSystemIncludePath()">getSystemIncludePath</A></B>()</CODE>
<BR>
Get the system include path for this variant.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#getSystemIncludePaths()">getSystemIncludePaths</A></B>()</CODE>
<BR>
Get the system include file paths needed for this variant and all its parents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#isVariant()">isVariant</A></B>()</CODE>
<BR>
Tell if the platform is a variant (but not a virtual variant).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html#isVirtualVariant()">isVirtualVariant</A></B>()</CODE>
<BR>
Tell if the platform is a virtual variant</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="getCatalog()"><!-- --></A><H3>
getCatalog</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFCatalog</A> <B>getCatalog</B>()</PRE>
<DL>
<DD>Get the catalog this platform is contained in.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>IBSFCatalog, never null</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get the platform's name, as seen in the .bsf filename.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>name, never null</DL>
</DD>
</DL>
<HR>
<A NAME="getBSFPath()"><!-- --></A><H3>
getBSFPath</H3>
<PRE>
IPath <B>getBSFPath</B>()</PRE>
<DL>
<DD>Get the full filesystem path to the BSF used.
<p>
This may be used
to retrieve the <CODE>IBSFView</CODE> via <CODE>EpocEnginePlugin#runWithBSFView(IPath, com.nokia.carbide.cpp.epoc.engine.model.IViewConfiguration, com.nokia.carbide.cpp.epoc.engine.IBSFViewRunnable)</CODE>
to get more information about the BSF.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>path, never null</DL>
</DD>
</DL>
<HR>
<A NAME="getCustomizedPlatformName()"><!-- --></A><H3>
getCustomizedPlatformName</H3>
<PRE>
java.lang.String <B>getCustomizedPlatformName</B>()</PRE>
<DL>
<DD>Get the name of the customized platform, which matches the case of
a known platform if possible, else is all-caps.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>platform name or null</DL>
</DD>
</DL>
<HR>
<A NAME="getCustomizedPlatform()"><!-- --></A><H3>
getCustomizedPlatform</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFPlatform.html" title="interface in com.nokia.carbide.cpp.sdk.core">IBSFPlatform</A> <B>getCustomizedPlatform</B>()</PRE>
<DL>
<DD>Get the customized (parent) platform, if it is a BSF platform.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>parent, or null for non-BSF platform</DL>
</DD>
</DL>
<HR>
<A NAME="getSystemIncludePath()"><!-- --></A><H3>
getSystemIncludePath</H3>
<PRE>
IPath <B>getSystemIncludePath</B>()</PRE>
<DL>
<DD>Get the system include path for this variant.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>full filesystem path to the include directory for the variant,
which may be the parent/customized platform's directory for virtual
variant, or null if no non-virtual parent exists.</DL>
</DD>
</DL>
<HR>
<A NAME="getSystemIncludePaths()"><!-- --></A><H3>
getSystemIncludePaths</H3>
<PRE>
IPath[] <B>getSystemIncludePaths</B>()</PRE>
<DL>
<DD>Get the system include file paths needed for this variant and all its parents.
This does not include the epoc32\include\oem directory, which is presumed
for all platforms.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of full filesystem paths, never null</DL>
</DD>
</DL>
<HR>
<A NAME="isVariant()"><!-- --></A><H3>
isVariant</H3>
<PRE>
boolean <B>isVariant</B>()</PRE>
<DL>
<DD>Tell if the platform is a variant (but not a virtual variant).
<P>
<DD><DL>
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="isVirtualVariant()"><!-- --></A><H3>
isVirtualVariant</H3>
<PRE>
boolean <B>isVirtualVariant</B>()</PRE>
<DL>
<DD>Tell if the platform is a virtual variant
<P>
<DD><DL>
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getCompileWithParent()"><!-- --></A><H3>
getCompileWithParent</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cpp/epoc/engine/model/ETristateFlag.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">ETristateFlag</A> <B>getCompileWithParent</B>()</PRE>
<DL>
<DD>Get the compile with parent flag for this BSF in isolation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><A HREF="../../../../../../com/nokia/carbide/cpp/epoc/engine/model/ETristateFlag.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model"><CODE>ETristateFlag</CODE></A> describing whether this BSF specifies the flag
and if it's COMPILEWITHPARENT or COMPILEALONE</DL>
</DD>
</DL>
<HR>
<A NAME="getEffectiveCompileWithParent()"><!-- --></A><H3>
getEffectiveCompileWithParent</H3>
<PRE>
boolean <B>getEffectiveCompileWithParent</B>()</PRE>
<DL>
<DD>Get the disposition of the "compile with parent" setting, as inherited
by parents or specified in this platform.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCustomizationOptions()"><!-- --></A><H3>
getCustomizationOptions</H3>
<PRE>
java.util.Map<java.lang.String,java.lang.String> <B>getCustomizationOptions</B>()</PRE>
<DL>
<DD>Get the map of customization options for this BSF in isolation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>map of key to value</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/IBSFPlatform.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">
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/IBSFCatalog.html" title="interface in com.nokia.carbide.cpp.sdk.core"><B>PREV CLASS</B></A>
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ICarbideInstalledSDKChangeListener.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/IBSFPlatform.html" target="_top"><B>FRAMES</B></A>
<A HREF="IBSFPlatform.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>