Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvProperty Class Reference

Simple name/value string pair class. More...

Public Member Functions

 PvProperty ()
 Constructor.
 
 PvProperty (const PvString &aName, const PvString &aValue)
 Constructor that can set name, value. More...
 
 ~PvProperty ()
 Destructor.
 
 PvProperty (const PvProperty &aProperty)
 Copy constructor. More...
 
const PvPropertyoperator= (const PvProperty &aProperty)
 Copy operator. More...
 
void SetName (const PvString &aName)
 Sets the property name. More...
 
PvString GetName () const
 Returns the property name. More...
 
void SetValue (const PvString &aValue)
 Sets the property value from a string. More...
 
void SetValue (int64_t aValue)
 Sets the property values from an integer. More...
 
void SetValue (double aValue)
 Sets the property values from a double. More...
 
PvString GetValue () const
 Gets the property value as a string. More...
 
PvResult GetValue (int64_t &aValue) const
 Gets the property value as an integer. More...
 
PvResult GetValue (double &aValue) const
 Gets the property value as a float. More...
 

Detailed Description

Simple name/value string pair class.

Used for persistence with PvPropertyList.

Constructor & Destructor Documentation

◆ PvProperty() [1/2]

PvProperty::PvProperty ( const PvString aName,
const PvString aValue 
)

Constructor that can set name, value.

Parameters
[in]aNameProperty name.
[in]aValueProperty value.

◆ PvProperty() [2/2]

PvProperty::PvProperty ( const PvProperty aProperty)

Copy constructor.

Parameters
[in]aPropertyThe property to use to initialize the new object.

Member Function Documentation

◆ GetName()

PvString PvProperty::GetName ( ) const

Returns the property name.

Returns
The property name.

◆ GetValue() [1/3]

PvString PvProperty::GetValue ( ) const

Gets the property value as a string.

Returns
The string value.

◆ GetValue() [2/3]

PvResult PvProperty::GetValue ( double &  aValue) const

Gets the property value as a float.

Parameters
[out]aValueThe property value converted to a float.
Returns
Includes:

◆ GetValue() [3/3]

PvResult PvProperty::GetValue ( int64_t &  aValue) const

Gets the property value as an integer.

Parameters
[out]aValueThe property value converted to an integer.
Returns
Includes:

◆ operator=()

const PvProperty & PvProperty::operator= ( const PvProperty aProperty)

Copy operator.

Parameters
[in]aPropertyThe property to copy.
Returns
A reference to the copy destination.

◆ SetName()

void PvProperty::SetName ( const PvString aName)

Sets the property name.

Parameters
[in]aNameThe new property name.

◆ SetValue() [1/3]

void PvProperty::SetValue ( const PvString aValue)

Sets the property value from a string.

Parameters
[in]aValueThe new property value.

◆ SetValue() [2/3]

void PvProperty::SetValue ( double  aValue)

Sets the property values from a double.

Parameters
[in]aValueThe new property value.

◆ SetValue() [3/3]

void PvProperty::SetValue ( int64_t  aValue)

Sets the property values from an integer.

Parameters
[in]aValueThe new property value.

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com