< Home

< Table of Contents

REFERENCE MANUAL

HPS.BooleanMetadata Class Reference

The BooleanMetadata class is a smart pointer. More...

Inheritance diagram for HPS.BooleanMetadata:
HPS.Metadata HPS.Sprocket HPS.Object

Public Member Functions

 BooleanMetadata ()
 The default constructor creates an uninitialized BooleanMetadata object. More...
 
 BooleanMetadata (HPS.Metadata in_that)
 This constructor creates a BooleanMetadata object that shares the underlying smart-pointer of the source Metadata. More...
 
 BooleanMetadata (HPS.BooleanMetadata in_that)
 This constructor creates a BooleanMetadata object that shares the underlying smart-pointer of the source Metadata. More...
 
 BooleanMetadata (string in_name, bool in_value)
 This constructor creates a BooleanMetadata with a given name and value. More...
 
override void Dispose ()
 
bool GetValue ()
 Gets the boolean value for this BooleanMetadata. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void SetValue (bool in_value)
 Sets the boolean value for this BooleanMetadata. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The BooleanMetadata class is a smart pointer.

It represents a piece of boolean Metadata.

Constructor & Destructor Documentation

HPS.BooleanMetadata.BooleanMetadata ( )

The default constructor creates an uninitialized BooleanMetadata object.

The Type() function will return Type::None.

HPS.BooleanMetadata.BooleanMetadata ( HPS.Metadata  in_that)

This constructor creates a BooleanMetadata object that shares the underlying smart-pointer of the source Metadata.

The copy will only be successful if the source component is really an upcast of a BooleanMetadata object. Otherwise the copy will fail and the resulting BooleanMetadata will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
HPS.BooleanMetadata.BooleanMetadata ( HPS.BooleanMetadata  in_that)

This constructor creates a BooleanMetadata object that shares the underlying smart-pointer of the source Metadata.

The copy will only be successful if the source component is really an upcast of a BooleanMetadata object. Otherwise the copy will fail and the resulting BooleanMetadata will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
HPS.BooleanMetadata.BooleanMetadata ( string  in_name,
bool  in_value 
)

This constructor creates a BooleanMetadata with a given name and value.

Parameters
in_nameThe UTF8-encoded name for this <ref refid="class_h_p_s_1_1_boolean_metadata" kindref="compound">BooleanMetadata</ref>.
in_valueThe boolean value for this <ref refid="class_h_p_s_1_1_boolean_metadata" kindref="compound">BooleanMetadata</ref>.

Member Function Documentation

bool HPS.BooleanMetadata.GetValue ( )

Gets the boolean value for this BooleanMetadata.

Returns
The boolean value for this BooleanMetadata.
override HPS.Type HPS.BooleanMetadata.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.BooleanMetadata.SetValue ( bool  in_value)

Sets the boolean value for this BooleanMetadata.

Parameters
in_valueThe boolean value for this <ref refid="class_h_p_s_1_1_boolean_metadata" kindref="compound">BooleanMetadata</ref>.

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