OpenStructure
Namespaces | Data Structures | Typedefs | Enumerations | Functions
ost::info Namespace Reference

Namespaces

namespace  detail

Data Structures

class  InfoError
class  InfoGroup
class  InfoHandle
 main info handle More...
class  InfoItem
class  InfoPath
 encapsulates path to info groups and items More...
class  InfoSet
class  VerboseInfoVisitor
class  InfoVisitor
class  InfoConstVisitor

Typedefs

typedef std::vector< InfoItemInfoItemList
typedef std::vector< InfoGroupInfoGroupList
typedef boost::shared_ptr
< detail::InfoImpl
RootPtr
typedef std::vector< RootPtrRootPtrList
typedef boost::shared_ptr
< detail::EleImpl
ElePtr
typedef std::map< String, InfoSetInfoSetMap

Enumerations

enum  Type {
  IT_STRING = 0, IT_INT, IT_FLOAT, IT_BOOL,
  IT_VECTOR
}

Functions

DLLEXPORT InfoHandle CreateInfo ()
DLLEXPORT InfoHandle CreateInfo (const String &dtdfile)
DLLEXPORT InfoHandle LoadInfo (const String &file)
template<typename T >
Extract (const info::InfoGroup &g, const String &n)
Real DLLEXPORT_OST_INFO GetFloatInfoItem (const InfoGroup &ig, const InfoPath &path, Real def)
int DLLEXPORT_OST_INFO GetIntInfoItem (const InfoGroup &ig, const InfoPath &path, int def)
bool DLLEXPORT_OST_INFO GetBoolInfoItem (const InfoGroup &ig, const InfoPath &path, bool def)
geom::Vec3 DLLEXPORT_OST_INFO GetVectorInfoItem (const InfoGroup &ig, const InfoPath &path, const geom::Vec3 &def)
String DLLEXPORT_OST_INFO GetStringInfoItem (const InfoGroup &ig, const InfoPath &path, const String &def)
void DLLEXPORT_OST_INFO SetFloatInfoItem (InfoGroup ig, const InfoPath &path, Real val)
void DLLEXPORT_OST_INFO SetIntInfoItem (InfoGroup ig, const InfoPath &path, int val)
void DLLEXPORT_OST_INFO SetBoolInfoItem (InfoGroup ig, const InfoPath &path, bool val)
void DLLEXPORT_OST_INFO SetVectorInfoItem (InfoGroup ig, const InfoPath &path, const geom::Vec3 &val)
void DLLEXPORT_OST_INFO SetStringInfoItem (InfoGroup ig, const InfoPath &path, const String &val)
DLLEXPORT_OST_INFO std::ostream & operator<< (std::ostream &, const InfoPath &p)
DLLEXPORT_OST_INFO InfoPath operator+ (const InfoPath &p1, const InfoPath &p2)
DLLEXPORT InfoSetMap ExtractSets (const InfoGroup &)
def LoadOrCreateInfo
matrix conversion routines
void DLLEXPORT_OST_INFO Mat2ToInfo (const geom::Mat2 &mat, InfoGroup &group)
geom::Mat2 DLLEXPORT_OST_INFO Mat2FromInfo (const InfoGroup &group)
void DLLEXPORT_OST_INFO Mat3ToInfo (const geom::Mat3 &mat, InfoGroup &group)
geom::Mat3 DLLEXPORT_OST_INFO Mat3FromInfo (const InfoGroup &group)
void DLLEXPORT_OST_INFO Mat4ToInfo (const geom::Mat4 &mat, InfoGroup &group)
geom::Mat4 DLLEXPORT_OST_INFO Mat4FromInfo (const InfoGroup &group)

Typedef Documentation

typedef boost::shared_ptr<detail::EleImpl> ElePtr

Definition at line 42 of file info_impl_fw.hh.

typedef std::vector<InfoGroup> InfoGroupList

Definition at line 47 of file info_fw.hh.

typedef std::vector<InfoItem> InfoItemList

Definition at line 44 of file info_fw.hh.

typedef std::map<String,InfoSet> InfoSetMap

Definition at line 54 of file info_set.hh.

typedef boost::shared_ptr<detail::InfoImpl> RootPtr

Definition at line 40 of file info_impl_fw.hh.

typedef std::vector<RootPtr> RootPtrList

Definition at line 41 of file info_impl_fw.hh.


Enumeration Type Documentation

enum Type
Enumerator:
IT_STRING 
IT_INT 
IT_FLOAT 
IT_BOOL 
IT_VECTOR 

Definition at line 31 of file item_type.hh.


Function Documentation

DLLEXPORT InfoHandle ost::info::CreateInfo ( )

Create InfoHandle from scratch.

DLLEXPORT InfoHandle ost::info::CreateInfo ( const String dtdfile)
T ost::info::Extract ( const info::InfoGroup &  g,
const String n 
)

Convenience function to extract a value from an item.

Definition at line 126 of file info_item.hh.

DLLEXPORT InfoSetMap ost::info::ExtractSets ( const InfoGroup &  )
bool DLLEXPORT_OST_INFO ost::info::GetBoolInfoItem ( const InfoGroup &  ig,
const InfoPath &  path,
bool  def 
)
Real DLLEXPORT_OST_INFO ost::info::GetFloatInfoItem ( const InfoGroup &  ig,
const InfoPath &  path,
Real  def 
)
int DLLEXPORT_OST_INFO ost::info::GetIntInfoItem ( const InfoGroup &  ig,
const InfoPath &  path,
int  def 
)
String DLLEXPORT_OST_INFO ost::info::GetStringInfoItem ( const InfoGroup &  ig,
const InfoPath &  path,
const String def 
)
geom::Vec3 DLLEXPORT_OST_INFO ost::info::GetVectorInfoItem ( const InfoGroup &  ig,
const InfoPath &  path,
const geom::Vec3 def 
)
DLLEXPORT InfoHandle ost::info::LoadInfo ( const String file)

Load InfoHandle from a file.

def ost.info.LoadOrCreateInfo (   name)

Definition at line 21 of file __init__.py.

geom::Mat2 DLLEXPORT_OST_INFO ost::info::Mat2FromInfo ( const InfoGroup &  group)

load Mat2 from info group

void DLLEXPORT_OST_INFO ost::info::Mat2ToInfo ( const geom::Mat2 mat,
InfoGroup &  group 
)

store Mat2 in info group

geom::Mat3 DLLEXPORT_OST_INFO ost::info::Mat3FromInfo ( const InfoGroup &  group)

load Mat3 from info

void DLLEXPORT_OST_INFO ost::info::Mat3ToInfo ( const geom::Mat3 mat,
InfoGroup &  group 
)

store Mat3 in info group

geom::Mat4 DLLEXPORT_OST_INFO ost::info::Mat4FromInfo ( const InfoGroup &  group)

load Mat4 from info

void DLLEXPORT_OST_INFO ost::info::Mat4ToInfo ( const geom::Mat4 mat,
InfoGroup &  group 
)

store Mat4 in info group

DLLEXPORT_OST_INFO InfoPath ost::info::operator+ ( const InfoPath &  p1,
const InfoPath &  p2 
)
DLLEXPORT_OST_INFO std::ostream& ost::info::operator<< ( std::ostream &  ,
const InfoPath &  p 
)
void DLLEXPORT_OST_INFO ost::info::SetBoolInfoItem ( InfoGroup  ig,
const InfoPath &  path,
bool  val 
)
void DLLEXPORT_OST_INFO ost::info::SetFloatInfoItem ( InfoGroup  ig,
const InfoPath &  path,
Real  val 
)
void DLLEXPORT_OST_INFO ost::info::SetIntInfoItem ( InfoGroup  ig,
const InfoPath &  path,
int  val 
)
void DLLEXPORT_OST_INFO ost::info::SetStringInfoItem ( InfoGroup  ig,
const InfoPath &  path,
const String val 
)
void DLLEXPORT_OST_INFO ost::info::SetVectorInfoItem ( InfoGroup  ig,
const InfoPath &  path,
const geom::Vec3 val 
)