C3D Toolkit  Kernel - 117978, Vision - 2.9.1.5

Property. Internal use only. More...

#include <mb_property.h>

+ Inheritance diagram for MbProperty:

Public Member Functions

 MbProperty (MbePrompt name, bool change=true)
 Constructor by parameters. More...
 
virtual ~MbProperty ()
 Destructor.
 
virtual PrePropType IsA () const =0
 Get type of property.
 
virtual void GetCharValue (TCHAR *) const =0
 Get string value of the property. Deprecated method, use GetCharValue_s() in combination with GetCharLen() instead.
 
virtual size_t GetCharLen () const
 Get buffer size, sufficient to accommodate the string value of the property. More...
 
virtual bool GetCharValue_s (TCHAR *, size_t) const
 Get the string value of the property as a string with a terminal null. More...
 
virtual void _GetPropertyValue (void *, size_t size) const =0
 Get value of the property.
 
virtual void SetPropertyValue (TCHAR *)=0
 Set the new value of the property.
 
virtual void GetProperties (MbProperties &)
 Get tuple of the complex property (non-atomic object).
 
virtual void SetProperties (const MbProperties &)
 Set tuple of the complex property (non-atomic object).
 
virtual size_t GetPrompt () const
 Get a hint.
 
MbePromptSetPrompt ()
 Get a hint.
 
bool IsChangeable () const
 Is it possible to change data.
 

Detailed Description

Property. Internal use only.

Property is the base class for access to internal data of objects. Inheritors of property may contain internal data of objects or its copies. Properties are intended for reading and changing internal data of objects.
To store the user data of an object, we recommend using attributes - objects of classes that inherit MbAttribute, already available in the kernel or user-defined.

Constructor & Destructor Documentation

◆ MbProperty()

MbProperty::MbProperty ( MbePrompt  name,
bool  change = true 
)
inline

Constructor by parameters.

Constructor by parameters.

Parameters
[in]name- Number of hint string.
[in]change- The flag of edibility.

Member Function Documentation

◆ GetCharLen()

virtual size_t MbProperty::GetCharLen ( ) const
virtual

Get buffer size, sufficient to accommodate the string value of the property.

Returns buffer size, sufficient to accommodate the string value of the property, excluding the terminal null.

Reimplemented in VersionProperty, StringProperty, NDoubleProperty, DoubleProperty, UIntProperty, IntProperty, and BoolProperty.

◆ GetCharValue_s()

virtual bool MbProperty::GetCharValue_s ( TCHAR *  ,
size_t   
) const
inlinevirtual

Get the string value of the property as a string with a terminal null.

Get the string value of the property as a string with a terminal null.

Parameters
[in]v- A pointer to a destination buffer to copy to.
[in]size- The size of the destination buffer.
Returns
true if successful; otherwise, false.

Reimplemented in VersionProperty, StringProperty, NDoubleProperty, DoubleProperty, UIntProperty, IntProperty, and BoolProperty.


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