vlX::VLXStructure Class Reference

A list of key/VLXValue pairs, can also have a tag. More...

#include <Value.hpp>

Inheritance diagram for vlX::VLXStructure:

Classes
class	KeyValue
	Key/value pair used by VLXStructure. More...

Public Member Functions
	VLXStructure ()
	VLXStructure (const char *tag)
	VLXStructure (const char *tag, const std::string &uid)
virtual void	acceptVisitor (Visitor *v)
VLXStructure &	operator<< (const char *str)
VLXStructure &	operator<< (const vlX::VLXValue &val)
void	setID (const char *uid)
const std::string &	uid () const
std::vector< KeyValue > &	value ()
const std::vector< KeyValue > &	value () const
vlX::VLXValue *	getValue (const char *key)
const vlX::VLXValue *	getValue (const char *key) const
Public Member Functions inherited from vlX::VLXTaggedValue
	VLXTaggedValue (const char *tag=NULL)
virtual	~VLXTaggedValue ()
int	lineNumber () const
void	setLineNumber (int line)
void	setTag (const char *tag)
const std::string &	tag () const
Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...
	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...
Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...
const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...
void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...
IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...
const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...
int	referenceCount () const
	Returns the number of references of an object. More...
void	incReference () const
	Increments the reference count of an object. More...
void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...
bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...
template<class T >
T *	as ()
	Casts an Object to the specified class. More...
template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()
Protected Attributes inherited from vl::Object
std::string	mObjectName
IMutex *	mRefCountMutex
int	mReferenceCount
bool	mAutomaticDelete

Detailed Description

A list of key/VLXValue pairs, can also have a tag.

Definition at line 541 of file Value.hpp.

Constructor & Destructor Documentation

VLXStructure() [1/3]

vlX::VLXStructure::VLXStructure ( )

inline

Definition at line 546 of file Value.hpp.

VLXStructure() [2/3]

vlX::VLXStructure::VLXStructure ( const char *  tag )

inline

Definition at line 552 of file Value.hpp.

References vlX::VLXTaggedValue::setTag().

VLXStructure() [3/3]

vlX::VLXStructure::VLXStructure ( const char *  tag, const std::string &  uid  )

inline

Definition at line 559 of file Value.hpp.

References vlX::VLXTaggedValue::setTag().

Member Function Documentation

acceptVisitor()

virtual void vlX::VLXStructure::acceptVisitor ( Visitor *  v )

inlinevirtual

Implements vlX::VLXTaggedValue.

Definition at line 566 of file Value.hpp.

References vlX::Visitor::visitStructure().

Referenced by vlX::VLXSerializer::saveVLB(), vlX::VLXSerializer::saveVLT(), vlX::VisitorIDCounter::visitStructure(), vlX::VisitorExportToVLT::visitValue(), and vlX::VisitorExportToVLB::writeValue().

getValue() [1/2]

vlX::VLXValue* vlX::VLXStructure::getValue ( const char *  key )

inline

Definition at line 612 of file Value.hpp.

References NULL.

Referenced by vlX::VLXClassWrapper_Actor::importActor(), vlX::VLXClassWrapper_ActorEventCallback::importActorEventCallback(), vlX::VLXClassWrapper_Camera::importCamera(), vlX::VLXClassWrapper_Color::importColor(), vlX::VLXClassWrapper_DrawCall::importDrawCall(), vlX::VLXClassWrapper_Effect::importEffect(), vlX::VLXClassWrapper_GLSLProgram::importGLSLProgram(), vlX::VLXClassWrapper_GLSLShader::importGLSLShader(), vlX::VLXClassWrapper_Light::importLight(), vlX::VLXClassWrapper_LODEvaluator::importLODEvaluator(), vlX::VLXClassWrapper_Material::importMaterial(), vlX::VLXClassWrapper_Normal::importNormal(), vlX::VLXClassWrapper_Renderable::importRenderable(), vlX::VLXClassWrapper_ResourceDatabase::importResourceDatabase(), vlX::VLXClassWrapper_SecondaryColor::importSecondaryColor(), vlX::VLXClassWrapper_Shader::importShader(), vlX::VLXClassWrapper_Texture::importTexture(), vlX::VLXClassWrapper_TextureSampler::importTextureSampler(), vlX::VLXClassWrapper_Transform::importTransform(), vlX::VLXClassWrapper_Uniform::importUniform(), vlX::VLXClassWrapper_VertexAttrib::importVertexAttrib(), vlX::VLXClassWrapper_Viewport::importViewport(), and vlX::VLXClassWrapper_Array::importVLX().

getValue() [2/2]

const vlX::VLXValue* vlX::VLXStructure::getValue ( const char *  key ) const

inline

Definition at line 620 of file Value.hpp.

References NULL.

operator<<() [1/2]

VLXStructure& vlX::VLXStructure::operator<< ( const char *  str )

inline

Definition at line 568 of file Value.hpp.

operator<<() [2/2]

VLXStructure& vlX::VLXStructure::operator<< ( const vlX::VLXValue &  val )

inline

Definition at line 575 of file Value.hpp.

setID()

void vlX::VLXStructure::setID ( const char *  uid )

inline

Definition at line 603 of file Value.hpp.

Referenced by vlX::ParserVLB::parseStructure().

uid()

const std::string& vlX::VLXStructure::uid ( ) const

inline

Definition at line 605 of file Value.hpp.

Referenced by vlX::VisitorLinkMapper::declareID(), vlX::ParserVLT::parseStructure(), vlX::VisitorIDCounter::visitStructure(), vlX::VisitorExportToVLB::visitStructure(), and vlX::VisitorExportToVLT::visitStructure().

value() [1/2]

std::vector<KeyValue>& vlX::VLXStructure::value ( )

inline

Definition at line 607 of file Value.hpp.

Referenced by vlX::import_AABB(), vlX::import_Sphere(), vlX::VLXClassWrapper_Actor::importActor(), vlX::VLXClassWrapper_Camera::importCamera(), vlX::VLXClassWrapper_ClipPlane::importClipPlane(), vlX::VLXClassWrapper_DrawCall::importDrawCall(), vlX::VLXClassWrapper_Effect::importEffect(), vlX::VLXClassWrapper_Geometry::importGeometry(), vlX::VLXClassWrapper_GLSLProgram::importGLSLProgram(), vlX::VLXClassWrapper_Light::importLight(), vlX::VLXClassWrapper_Material::importMaterial(), vlX::VLXClassWrapper_PatchParameter::importPatchParameter(), vlX::VLXClassWrapper_Renderable::importRenderable(), vlX::VLXClassWrapper_TexParameter::importTexParameter(), vlX::VLXClassWrapper_Texture::importTexture(), vlX::VLXClassWrapper_Transform::importTransform(), vlX::VLXClassWrapper_Viewport::importViewport(), vlX::Parser::parseMetadata(), vlX::ParserVLB::parseStructure(), vlX::VLXSerializer::saveVLB(), vlX::VLXSerializer::saveVLT(), vlX::VisitorIDCounter::visitStructure(), vlX::VisitorLinkMapper::visitStructure(), vlX::VisitorLinker::visitStructure(), vlX::VisitorExportToVLB::visitStructure(), and vlX::VisitorExportToVLT::visitStructure().

value() [2/2]

const std::vector<KeyValue>& vlX::VLXStructure::value ( ) const

inline

Definition at line 609 of file Value.hpp.

---

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

• C:/git/VL/src/vlX/Value.hpp