Vicon Shogun banner

Description

Retrieves a Boolean value from an object's attributes.

Because Shogun Post commands can only have one return type, there must be separate commands for retrieving different types of property data.

This command is used to retrieve attributes that can have either an on or off state (e.g. Showing).

It can also be used to retrieve sub-elements of an attribute with many elements (e.g. DOF).

Functional area

Data retrieval

Command syntax

Syntax

getBooleanProperty moduleName propertyName[-c] [-d]

Arguments

NameTypeRequiredComments
subPropertyNamestringnoIf propertyName represents an array of booleans (e.g. the DOF attribute), this will specify one of the sub-fields.
propertyNamestringyesName of the property on the object.
moduleNamestringyesObject to retrieve property value from.

Flags

NameFlag argumentsArgument typeExclusive toComments
c0
d0


Return value

boolean

Examples

// Get some information about the "thorax" bone.
boolean $hasXRotDof;
boolean $isSpine;
$hasXRotDof = `getBooleanProperty "thorax" "DOF" "Rx"`;
print $hasXRotDof;
$isSpine = `getBooleanProperty "thorax" "Spine_Bone"`;
print $isSpine;

Additional information

Related commands