TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iDataTableReadStack Struct Referenceabstract
Inheritance diagram for iDataTableReadStack:
iUnknown

Detailed Description

Data table read stack interface.

Public Member Functions

virtual iDataTableGetTop () const =0
 Get the top of the data table stack. {Property}. More...
 
virtual const acharGetName () const =0
 Get the name of the top data table. {Property}. More...
 
virtual tU32 GetNumChildren () const =0
 Get the number of child data table of the top data table. {Property}. More...
 
virtual tBool PushChild (tU32 anIndex)=0
 Push the specified child data table on top of the stack. Push a NULL data table if it doesn't exists. More...
 
virtual tBool PushChildFail (tU32 anIndex)=0
 Push the specified child data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse. More...
 
virtual tBool Push (const achar *aaszName)=0
 Push the specified data table on top of the stack. Push a NULL data table if it doesn't exists. More...
 
virtual tBool PushFail (const achar *aaszName)=0
 Push the specified data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse. More...
 
virtual tBool PushEx (const achar *aaszName, const achar *aaszProp, const achar *aaszVal)=0
 Push the specified data table on top of the stack. Push a NULL data table if it doesn't exists. More...
 
virtual tBool PushFailEx (const achar *aaszName, const achar *aaszProp, const achar *aaszVal)=0
 Push the specified data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse. More...
 
virtual tBool Pop ()=0
 Pop the top data table. More...
 
virtual tBool HasProperty (const achar *aaszName) const =0
 Check whether the top data table has a property with the specified name. More...
 
virtual tBool RemoveProperty (const achar *aaszName)=0
 Remove a property of the top data table. More...
 
virtual cString GetString (const achar *aaszName) const =0
 Get a String of the top data table. {Property}. More...
 
virtual cString GetStringDefault (const achar *aaszName, const achar *v) const =0
 Get a String of the top data table. More...
 
virtual Ptr< iHStringGetHString (const achar *aaszName) const =0
 Get a HString of the top data table. {Property}. More...
 
virtual Ptr< iHStringGetHStringDefault (const achar *aaszName, iHString *v) const =0
 Get a HString of the top data table. More...
 
virtual tI64 GetInt (const achar *aaszName) const =0
 Get a Int of the top data table. {Property}. More...
 
virtual tI64 GetIntDefault (const achar *aaszName, tI64 v) const =0
 Get a Int of the top data table. More...
 
virtual tBool GetBool (const achar *aaszName) const =0
 Get a Bool of the top data table. {Property}. More...
 
virtual tBool GetBoolDefault (const achar *aaszName, tBool v) const =0
 Get a Bool of the top data table. More...
 
virtual tF64 GetFloat (const achar *aaszName) const =0
 Get a Float of the top data table. {Property}. More...
 
virtual tF64 GetFloatDefault (const achar *aaszName, tF64 v) const =0
 Get a Float of the top data table. More...
 
virtual sVec2f GetVec2 (const achar *aaszName) const =0
 Get a Vec2 of the top data table. {Property}. More...
 
virtual sVec2f GetVec2Default (const achar *aaszName, const sVec2f &v) const =0
 Get a Vec2 of the top data table. More...
 
virtual sVec3f GetVec3 (const achar *aaszName) const =0
 Get a Vec3 of the top data table. {Property}. More...
 
virtual sVec3f GetVec3Default (const achar *aaszName, const sVec3f &v) const =0
 Get a Vec3 of the top data table. More...
 
virtual sVec4f GetVec4 (const achar *aaszName) const =0
 Get a Vec4 of the top data table. {Property}. More...
 
virtual sVec4f GetVec4Default (const achar *aaszName, const sVec4f &v) const =0
 Get a Vec4 of the top data table. More...
 
virtual sVec3f GetCol3 (const achar *aaszName) const =0
 Get a Color3 of the top data table. {Property}. More...
 
virtual sVec4f GetCol4 (const achar *aaszName) const =0
 Get a Color4 of the top data table. {Property}. More...
 
virtual sMatrixf GetMatrix (const achar *aaszName) const =0
 Get a Matrix of the top data table. {Property}. More...
 
virtual sMatrixf GetMatrixDefault (const achar *aaszName, const sMatrixf &v) const =0
 Get a Matrix of the top data table. More...
 
virtual iUnknownGetIUnknown (const achar *aaszName) const =0
 Get a IUnknown of the top data table. {Property}. More...
 
virtual iUnknownGetIUnknownDefault (const achar *aaszName, iHString *v) const =0
 Get a IUnknown of the top data table. More...
 
virtual tU32 GetEnum (const achar *aaszName, const sEnumDef *apEnumDef, tEnumToStringFlags aFlags) const =0
 Get a Enum of the top data table. More...
 
virtual tU32 GetEnumDefault (const achar *aaszName, const sEnumDef *apEnumDef, tEnumToStringFlags aFlags, tU32 v) const =0
 Get a Enum of the top data table. More...
 
virtual Ptr< iHStringGetMetadata (const achar *aaszProp) const =0
 Get a property meta-data. {Property}. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual iDataTable* GetTop ( ) const
pure virtual

Get the top of the data table stack. {Property}.

virtual const achar* GetName ( ) const
pure virtual

Get the name of the top data table. {Property}.

virtual tU32 GetNumChildren ( ) const
pure virtual

Get the number of child data table of the top data table. {Property}.

virtual tBool PushChild ( tU32  anIndex)
pure virtual

Push the specified child data table on top of the stack. Push a NULL data table if it doesn't exists.

virtual tBool PushChildFail ( tU32  anIndex)
pure virtual

Push the specified child data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse.

virtual tBool Push ( const achar aaszName)
pure virtual

Push the specified data table on top of the stack. Push a NULL data table if it doesn't exists.

virtual tBool PushFail ( const achar aaszName)
pure virtual

Push the specified data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse.

virtual tBool PushEx ( const achar aaszName,
const achar aaszProp,
const achar aaszVal 
)
pure virtual

Push the specified data table on top of the stack. Push a NULL data table if it doesn't exists.

virtual tBool PushFailEx ( const achar aaszName,
const achar aaszProp,
const achar aaszVal 
)
pure virtual

Push the specified data table on top of the stack. Do not push a data table if it doesn't exists and returns eFalse.

virtual tBool Pop ( )
pure virtual

Pop the top data table.

virtual tBool HasProperty ( const achar aaszName) const
pure virtual

Check whether the top data table has a property with the specified name.

virtual tBool RemoveProperty ( const achar aaszName)
pure virtual

Remove a property of the top data table.

virtual cString GetString ( const achar aaszName) const
pure virtual

Get a String of the top data table. {Property}.

virtual cString GetStringDefault ( const achar aaszName,
const achar v 
) const
pure virtual

Get a String of the top data table.

Remarks
Allow to specify the default value.
virtual Ptr<iHString> GetHString ( const achar aaszName) const
pure virtual

Get a HString of the top data table. {Property}.

virtual Ptr<iHString> GetHStringDefault ( const achar aaszName,
iHString v 
) const
pure virtual

Get a HString of the top data table.

Remarks
Allow to specify the default value.
virtual tI64 GetInt ( const achar aaszName) const
pure virtual

Get a Int of the top data table. {Property}.

virtual tI64 GetIntDefault ( const achar aaszName,
tI64  v 
) const
pure virtual

Get a Int of the top data table.

Remarks
Allow to specify the default value.
virtual tBool GetBool ( const achar aaszName) const
pure virtual

Get a Bool of the top data table. {Property}.

virtual tBool GetBoolDefault ( const achar aaszName,
tBool  v 
) const
pure virtual

Get a Bool of the top data table.

Remarks
Allow to specify the default value.
virtual tF64 GetFloat ( const achar aaszName) const
pure virtual

Get a Float of the top data table. {Property}.

virtual tF64 GetFloatDefault ( const achar aaszName,
tF64  v 
) const
pure virtual

Get a Float of the top data table.

Remarks
Allow to specify the default value.
virtual sVec2f GetVec2 ( const achar aaszName) const
pure virtual

Get a Vec2 of the top data table. {Property}.

virtual sVec2f GetVec2Default ( const achar aaszName,
const sVec2f v 
) const
pure virtual

Get a Vec2 of the top data table.

Remarks
Allow to specify the default value.
virtual sVec3f GetVec3 ( const achar aaszName) const
pure virtual

Get a Vec3 of the top data table. {Property}.

virtual sVec3f GetVec3Default ( const achar aaszName,
const sVec3f v 
) const
pure virtual

Get a Vec3 of the top data table.

Remarks
Allow to specify the default value.
virtual sVec4f GetVec4 ( const achar aaszName) const
pure virtual

Get a Vec4 of the top data table. {Property}.

virtual sVec4f GetVec4Default ( const achar aaszName,
const sVec4f v 
) const
pure virtual

Get a Vec4 of the top data table.

Remarks
Allow to specify the default value.
virtual sVec3f GetCol3 ( const achar aaszName) const
pure virtual

Get a Color3 of the top data table. {Property}.

Remarks
This is equivalent to GetVec3Default(name,sVec3f(1,1,1))
virtual sVec4f GetCol4 ( const achar aaszName) const
pure virtual

Get a Color4 of the top data table. {Property}.

Remarks
This is equivalent to GetVec3Default(name,sVec3f(1,1,1,1))
virtual sMatrixf GetMatrix ( const achar aaszName) const
pure virtual

Get a Matrix of the top data table. {Property}.

virtual sMatrixf GetMatrixDefault ( const achar aaszName,
const sMatrixf v 
) const
pure virtual

Get a Matrix of the top data table.

Remarks
Allow to specify the default value.
virtual iUnknown* GetIUnknown ( const achar aaszName) const
pure virtual

Get a IUnknown of the top data table. {Property}.

virtual iUnknown* GetIUnknownDefault ( const achar aaszName,
iHString v 
) const
pure virtual

Get a IUnknown of the top data table.

Remarks
Allow to specify the default value.
virtual tU32 GetEnum ( const achar aaszName,
const sEnumDef apEnumDef,
tEnumToStringFlags  aFlags 
) const
pure virtual

Get a Enum of the top data table.

virtual tU32 GetEnumDefault ( const achar aaszName,
const sEnumDef apEnumDef,
tEnumToStringFlags  aFlags,
tU32  v 
) const
pure virtual

Get a Enum of the top data table.

Remarks
Allow to specify the default value.
virtual Ptr<iHString> GetMetadata ( const achar aaszProp) const
pure virtual

Get a property meta-data. {Property}.