C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

Version property. More...

#include <mb_property.h>

+ Inheritance diagram for VersionProperty:
+ Collaboration diagram for VersionProperty:

Public Member Functions

 VersionProperty (MbePrompt name, VERSION initValue, bool change=true)
 Constructor by parameters. More...
 
virtual ~VersionProperty ()
 Destructor.
 
PrePropType IsA () const override
 Get type of property.
 
void GetCharValue (TCHAR *v) const override
 Get string value of the property. Deprecated method, use GetCharValue_s() in combination with GetCharLen() instead.
 
size_t GetCharLen () const override
 Get buffer size, sufficient to accommodate the string value of the property. More...
 
bool GetCharValue_s (TCHAR *v, size_t size) const override
 Get the string value of the property as a string with a terminal null. More...
 
void _GetPropertyValue (void *v, size_t size) const override
 Get value of the property.
 
void SetPropertyValue (TCHAR *v) override
 Set the new value of the property.
 
- Public Member Functions inherited from MbProperty
 MbProperty (MbePrompt name, bool change=true)
 Constructor by parameters. More...
 
virtual ~MbProperty ()
 Destructor.
 
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.
 

Public Attributes

VERSION value
 Value.
 

Detailed Description

Version property.

Version property is intended for reading and changing VERSION like data.

Constructor & Destructor Documentation

◆ VersionProperty()

VersionProperty::VersionProperty ( MbePrompt  name,
VERSION  initValue,
bool  change = true 
)
inline

Constructor by parameters.

Constructor by parameters.

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

Member Function Documentation

◆ GetCharLen()

size_t VersionProperty::GetCharLen ( ) const
overridevirtual

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 from MbProperty.

◆ GetCharValue_s()

bool VersionProperty::GetCharValue_s ( TCHAR *  ,
size_t   
) const
overridevirtual

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 from MbProperty.


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