ipsdk::bench::BenchResult Class Reference

#include <BenchmarkDataItem.h>

Inheritance diagram for ipsdk::bench::BenchResult:

Public Member Functions
const std::string &	getObjectName () const
	method allowing to retrieve object name
const std::string &	getToolTip () const
	method allowing to retrieve object tooltip
const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to data item node
const std::string	getLibraryName () const
	retrieve library name associated data item node
const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...
	~BenchResult ()
	public destructor
Methods associated to sub node Info
template<>
const ipsdk::DataItemLeaf< std::string > &	getNode () const
	access to sub node Info
template<>
ipsdk::DataItemLeaf< std::string > &	get ()
	access to sub node Info
template<>
const std::string &	getValue () const
	access to value for sub node Info
template<>
void	setValue (const std::string &value)
	access to value for sub node Info
Methods associated to sub node Duration
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node Duration
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node Duration
template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node Duration
template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node Duration
Public Member Functions inherited from ipsdk::BaseDataItemNode
virtual	~BaseDataItemNode ()=0
	public destructor
eDataItemType	getDataItemType () const
	retrieve data item type
bool	existsItem (const std::string &itemId) const
	check whether an item exists given its id
const BaseDataItem &	getItem (const std::string &itemId) const
	retrieve item associated to a given id More...
const std::string &	getItemName (const std::string &itemId) const
	retrieve item name associated to a given id More...
const std::string &	getItemToolTip (const std::string &itemId) const
	retrieve item tooltip associated to a given id More...
Public Member Functions inherited from ipsdk::BaseDataItem
	BaseDataItem ()
virtual	~BaseDataItem ()=0
Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.
virtual	~BaseSerializationObject ()=0
	destructor
Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name
virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type
virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type
virtual bool	hasCopySupport () const =0
	check whether objet has copy support
virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...
virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...
	BaseDynamicObject ()
virtual	~BaseDynamicObject ()=0
Public Member Functions inherited from ipsdk::BaseToolTip
	BaseToolTip ()
virtual	~BaseToolTip ()=0

Static Public Member Functions
static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name
static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip
static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to data item node
static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node
static boost::shared_ptr< BenchResult >	createNode ()
	node creation function
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization
Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object
Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl = false
	flags indicating item type
static const bool	g_bNode = true
	flags indicating item type
static const bool	g_bLeaf = false
	flags indicating item type
static const eDataItemType::domain	g_itemType = eDataItemType::eDIT_Node
	flags indicating item type

Protected Member Functions
	BenchResult ()
	protected constructor
Protected Member Functions inherited from ipsdk::BaseDataItemNode
	BaseDataItemNode ()
	protected constructor
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const =0
	retrieve item informations associated to a given id More...
Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object
virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object
Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)
virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr
	shared pointer to item informations

Detailed Description

Node associated library :

IPSDKBenchmarkToolsLib_Grp

SubNodes description

Name	ToolTip	Associated Class	Default Value
Info	Information string on benchmark result.	ipsdk::DataItemLeaf<std::string>
Duration	Duration of benchmark result in milliseconds.	ipsdk::DataItemLeaf<ipsdk::ipReal64>

Member Function Documentation

getItemIds()

const ipsdk::ItemNames& ipsdk::bench::BenchResult::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

---

The documentation for this class was generated from the following file:

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/Benchmark/IPSDKBenchmarkTools/BenchmarkDataItem.h