Visualization Library 2.1.0

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Classes | Public Member Functions | List of all members
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)
 
VLXStructureoperator<< (const char *str)
 
VLXStructureoperator<< (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::VLXValuegetValue (const char *key)
 
const vlX::VLXValuegetValue (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...
 
Objectoperator= (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...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () 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
 
IMutexmRefCountMutex
 
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

◆ getValue() [1/2]

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

◆ 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

◆ value() [1/2]

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

◆ 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: