Stephen James Hurd > DMTF-CIM-v0.04 > DMTF::CIM::Instance::Method::Parameter

Download:
DMTF-CIM-v0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.4.0   Source  

NAME ^

DMTF::CIM::Instance::Method::Parameter - Provides access to method parameters from a DMTF::CIM::Instance::Method

VERSION ^

This document describes DMTF::CIM::Instance::Method::Parameter version 0.04

SYNOPSIS ^

  use DMTF::CIM::WSMan;
  my $cim=DMTF::CIM::WSMan->new();

  my $instance = $cim->get('wsman.wbem://host:623/interop:CIM_ManagedElement.InstanceID=1');

  print $instance->class,"\n";
  foreach my $prop ( $instance->defined_properties ) {
          my $prop = $instance->property($prop);
      print "$prop: ",$prop->value,"\n";
  }

DESCRIPTION ^

This class is returned by the parammeter method of DMTF::CIM::Instance::Method It is not expected to be used by itself.

INTERFACE ^

METHODS

new ( [ property=>property_def ] [, value=>valueref ] )

Creates a new parameter with the CIM parameter description property_def and a value stored at valueref.

name

Returns the name of the parameter using the defined case.

value ( [ newvalue ] )

If the newvalue list is specified, sets the value to that. Returns the current mapped value. If the parameter is an array, and the method is used in a scalar context, the values are join(', ')ed.

raw_value ( [ newvalue ] )

If the newvalue list is specified, sets the value to that. Returns the current unmapped value. If the parameter is an array, and the method is used in a scalar context, the values are join(', ')ed.

is_array ( )

Returns a true value equal to the length of the array if the parameter is an array or 0 otherwise. A zero-length array returns '0 but true'

is_ref ( )

Returns true if the parameter is a reference or false otherwise.

type ( )

Returns the type name of the parameter. If the parameter is an array, will have '[]' appended. For properties which have no type information in the instance, the type is assumed to be 'string'.

CIM types as of this writing are:

uint8
uint16
uint32
uint64
sint8
sint16
sint32
sint64
real32
real64
string
char16
boolean
datetime

The name of the target class, or 'ref' is returned for references.

qualifier( name )

Returns the value of the qualifier with name.

DIAGNOSTICS ^

This class carp()s and returns undef (or empty list) on all errors.

CONFIGURATION AND ENVIRONMENT ^

DMTF::CIM::Instance::Method::Parameter requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-dmtf-cim-instance@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Stephen James Hurd <shurd@broadcom.com>

LICENCE AND COPYRIGHT ^

Copyright (c) 2012, Broadcom Corporation <shurd@broadcom.com>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: