hdi::core::EntryValue Class Reference

Allows for a *Entry class to store either a string value or PNGI image ID for a row/column. More...

#include <hdicoreEntryValue.h>

Public Types
enum	ValueType { UnknownValueType = 0 , StringValueType = 10 , ImageValueType = 20 , VectorValueType = 30 }
	Indicates the type of value stored in an EntryValue object.

Public Member Functions
	EntryValue (const EntryValue &ev_)
	EntryValue copy constructor.
	EntryValue (const std::string &str_)
	Constructs an EntryValue object with a string value.
	EntryValue (const ImageIDs &ids_)
	Constructs an EntryValue object with PNGI image IDs.
	EntryValue (const SVGIDs &ids_)
	Constructs an EntryValue object with SVG image IDs.
	~EntryValue ()
	EntryValue destructor.
EntryValue &	operator= (const EntryValue &rhs_)
	Overloaded assignment operator to copy values from one EntryValue object to another.
bool	operator== (const EntryValue &rhs_) const
	Overloaded equality operator to compare two EntryValue objects to one another.
bool	operator!= (const EntryValue &rhs_) const
	Overloaded inequality operator to compare two EntryValue objects to one another.
ValueType	type () const
	Gets the type of value representing by the target object.
std::string	stringValue () const
	Gets the string value for the target object.
bool	setStringValue (const std::string &str_)
	Sets the string value for the target object.
ImageIDs	imageIDs () const
	Gets the image ID values for the target object.
bool	setImageIDs (const ImageIDs &ids_)
	Sets the image ID values for the target object.
SVGIDs	svgIDs () const
	Gets the SVG ID values for the target object.
bool	setSVGIDs (const SVGIDs &ids_)
	Sets the SVG ID values for the target object.

Detailed Description

Allows for a *Entry class to store either a string value or PNGI image ID for a row/column.

Constructor & Destructor Documentation

EntryValue() [1/4]

hdi::core::EntryValue::EntryValue

(

const EntryValue &

ev_

)

EntryValue copy constructor.

Author

GW

Date

02/2015

Parameters

ev_	Existing EntryValue object to copy values from

EntryValue() [2/4]

hdi::core::EntryValue::EntryValue ( const std::string &  str_ )

explicit

Constructs an EntryValue object with a string value.

Author

GW

Date

02/2015

Parameters

str_	String value for the entry

EntryValue() [3/4]

hdi::core::EntryValue::EntryValue

(

const ImageIDs &

ids_

)

Constructs an EntryValue object with PNGI image IDs.

Author

GW

Date

02/2015

Parameters

ids_	Image ID values for the entry

EntryValue() [4/4]

hdi::core::EntryValue::EntryValue

(

const SVGIDs &

ids_

)

Constructs an EntryValue object with SVG image IDs.

Author

GW

Date

12/2018

Parameters

ids_	SVG ID values for the entry

~EntryValue()

hdi::core::EntryValue::~EntryValue

(

)

EntryValue destructor.

Author

GW

Date

02/2015

Member Function Documentation

imageIDs()

ImageIDs hdi::core::EntryValue::imageIDs

(

)

const

Gets the image ID values for the target object.

Author

GW

Date

02/2015

Returns

The image IDs

Note

The return value should be ignored if the type() method does not return ImageValueType.

operator!=()

bool hdi::core::EntryValue::operator!=

(

const EntryValue &

rhs_

)

const

Overloaded inequality operator to compare two EntryValue objects to one another.

Author

GW

Date

02/2015

Parameters

rhs_	Righthand side of the comparison

Returns

true if the lefthand side and righthand side of the comparison have differing entry values

operator=()

EntryValue & hdi::core::EntryValue::operator=

(

const EntryValue &

rhs_

)

Overloaded assignment operator to copy values from one EntryValue object to another.

Author

GW

Date

02/2015

Parameters

rhs_	Righthand side of the assignment

Returns

The lefthand side of the assignment, but with its values updated to match rhs_

operator==()

bool hdi::core::EntryValue::operator==

(

const EntryValue &

rhs_

)

const

Overloaded equality operator to compare two EntryValue objects to one another.

Author

GW

Date

02/2015

Parameters

rhs_	Righthand side of the comparison

Returns

true if the lefthand side and righthand side of the comparison have the same entry values

setImageIDs()

bool hdi::core::EntryValue::setImageIDs

(

const ImageIDs &

ids_

)

Sets the image ID values for the target object.

Author

GW

Date

02/2015

Parameters

ids_	New ID values for the target object

Returns

true if the type is ImageValueType, false otherwise

setStringValue()

bool hdi::core::EntryValue::setStringValue

(

const std::string &

str_

)

Sets the string value for the target object.

Author

GW

Date

02/2015

Parameters

str_	New string value for the target object, as UTF-8

Returns

true if the type is StringValueType, false otherwise

setSVGIDs()

bool hdi::core::EntryValue::setSVGIDs

(

const SVGIDs &

ids_

)

Sets the SVG ID values for the target object.

Author

GW

Date

12/2018

Parameters

ids_	New ID values for the target object

Returns

true if the type is VectorValueType, false otherwise

stringValue()

std::string hdi::core::EntryValue::stringValue

(

)

const

Gets the string value for the target object.

Author

GW

Date

02/2015

Returns

The string value if the type is StringValueType (as UTF-8), "" otherwise

svgIDs()

SVGIDs hdi::core::EntryValue::svgIDs

(

)

const

Gets the SVG ID values for the target object.

Author

GW

Date

12/2018

Returns

The vector IDs

Note

The return value should be ignored if the type() method does not return VectorValueType.

type()

ValueType hdi::core::EntryValue::type

(

)

const

Gets the type of value representing by the target object.

Author

GW

Date

02/2015

Returns

The type of value stored within the target